Custom Pay API Specification

Refund by BRIC

post /refund/{BRIC}

This endpoint uses a BRIC token (EPX Transaction Identifier) associated with a previous sale to return funds to an account. A single refund for the full amount of the original transaction, or numerous partial refunds can be performed with dollar amounts less than and not exceeding the total amount of the original sale.

Parameters

BRIC required

string

Example:

00DXDBWHB6WA5HJ3D71

Loading...

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

amount required

number

Example:

11.12

Loading...

batchID required

number

Loading...

transaction required

integer

Example:

123

Loading...

industryType required

string

Enum:

P

M

E

Example:

P

Loading...

cardEntryMethod required

string

Maximum:

1

Enum:

A

B

D

G

H

M

Q

R

X

Z

0

1

2

3

E

Example:

G

Loading...

Example Request

{
  "amount": 127.99,
  "batchID": 201217,
  "transaction": 123,
  "industryType": "E",
  "cardEntryMethod": "Z"
}

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

Refund

post /refund

This endpoint returns funds for a previously captured transaction. A single refund for the full amount of the original transaction, or numerous partial refunds can be performed with dollar amounts less than and not exceeding the total amount of the original capture being acted upon.

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

amount

number

Example:

11.12

Loading...

account required

string

Maximum:

30

Example:

4111111111111111

Loading...

expirationDate required

string

Maximum:

4

Example:

2501

Loading...

batchID required

number

Loading...

transaction required

integer

Example:

123

Loading...

industryType required

string

Enum:

P

M

E

Example:

P

Loading...

cardEntryMethod required

string

Maximum:

1

Enum:

A

B

D

G

H

M

Q

R

X

Z

0

1

2

3

E

Example:

G

Loading...

cvv2

string

Example:

123

Loading...

address

object

Loading...

Example Request

{
  "amount": 179,
  "account": "4111111111111111",
  "expirationDate": "2512",
  "batchID": 201217,
  "transaction": 123,
  "industryType": "E",
  "cardEntryMethod": "E",
  "cvv2": "123",
  "address": {
    "firstName": "Joe",
    "lastName": "Doe",
    "address": "123 Main Street",
    "state": "DE",
    "zipCode": "12345"
  }
}

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

Void an authorization

put /void/{BRIC}

This endpoint will stop an authorization, sale, capture, or refund transaction prior to settlement. If the transaction has already been settled, this function will no longer be available.

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

batchID required

number

Loading...

transaction required

integer

Example:

123

Loading...

cardEntryMethod required

string

Maximum:

1

Enum:

A

B

D

G

H

M

Q

R

X

Z

0

1

2

3

E

Example:

G

Loading...

Example Request

{
  "batchID": 1234,
  "transaction": 123,
  "cardEntryMethod": "Z"
}

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

Auth Reversal by BRIC

post /reverse/{BRIC}

The reverse transaction is used to remove the authorization hold on a credit card and void the transaction within the same request. This will release the funds that are being held at the issuing bank. The BRIC sent during this transaction is one from an open / unsettled sale or open / uncaptured authorization only transaction

Parameters

BRIC required

string

Example:

00DXDBWHB6WA5HJ3D71

Loading...

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

batchID required

number

Loading...

transaction required

integer

Example:

123

Loading...

industryType required

string

Enum:

P

M

E

Example:

P

Loading...

cardEntryMethod required

string

Maximum:

1

Enum:

A

B

D

G

H

M

Q

R

X

Z

0

1

2

3

E

Example:

G

Loading...

Example Request

{
  "batchID": 201217,
  "transaction": 123,
  "industryType": "E",
  "cardEntryMethod": "Z"
}

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