Custom Pay API Specification

System Availability Check

get /ping

This endpoint performs a general ping into the IPS system to verify our system availability.

Parameters

EPI-Id required

string

Example:

1111-222222-3-4

Loading...

EPI-Signature required

string

Example:

0123456789ABCDEF

Loading...

Content-Type required

string

Example:

application/json

Loading...

EPI-Trace

string

Loading...

Example Response

200 Successful request

400 Invalid request

401 Unauthorized: EPI-Signature is required. Or the generated HMAC does not match the endpoint and JSON payload received. Please review your HMAC-SHA256 procedure or the endpoint/body that are being sent.

403 Forbidden: EPI-Id provided doesn’t have the right to perform the request

404 Requested resource was not found

405 HTTP method is not allowed

500 Internal server error

Update BRIC

post /storage/bric/{bric}

This endpoint creates a new transaction BRIC (EPX Transaction Identifier) or updates an existing one within the EPX system, without interaction with the card networks. This transaction type is available for both credit card and ACH.

Parameters

EPI-Id required

string

Example:

1111-222222-3-4

Loading...

EPI-Signature required

string

Example:

0123456789ABCDEF

Loading...

Content-Type required

string

Example:

application/json

Loading...

EPI-Trace

string

Loading...

BRIC required

string

Example:

00DXDBWHB6WA5HJ3D71

Loading...

Request Schema

account required

string

Maximum:

30

Example:

4111111111111111

Loading...

expirationDate

string

Maximum:

4

Example:

2501

Loading...

Example Request

{
  "account": "4111111111111111",
  "expirationDate": "1212"
}

200 Successful request

400 Invalid request

401 Unauthorized: EPI-Signature is required. Or the generated HMAC does not match the endpoint and JSON payload received. Please review your HMAC-SHA256 procedure or the endpoint/body that are being sent.

403 Forbidden: EPI-Id provided doesn’t have the right to perform the request

404 Requested resource was not found

405 HTTP method is not allowed

500 Internal server error

Create BRIC

post /storage/bric

The Storage transaction presents the capability to create a new BRIC or update an existing one within the EPX system, without interaction with the card networks. This transaction type is available for both credit card (CC) and ACH.

Parameters

EPI-Id required

string

Example:

1111-222222-3-4

Loading...

EPI-Signature required

string

Example:

0123456789ABCDEF

Loading...

Content-Type required

string

Example:

application/json

Loading...

EPI-Trace

string

Loading...

Request Schema

account required

string

Maximum:

30

Example:

4111111111111111

Loading...

expirationDate

string

Maximum:

4

Example:

2501

Loading...

Example Request

{
  "account": "4111111111111111",
  "expirationDate": "1212"
}

200 Successful request

400 Invalid request

401 Unauthorized: EPI-Signature is required. Or the generated HMAC does not match the endpoint and JSON payload received. Please review your HMAC-SHA256 procedure or the endpoint/body that are being sent.

403 Forbidden: EPI-Id provided doesn’t have the right to perform the request

404 Requested resource was not found

405 HTTP method is not allowed

500 Internal server error