EPX Hosted Checkout Server Functions

EPX Hosted Checkout

Tip Adjust

post /sale/{bric}

This endpoint edits an open Auth-and-Capture transaction. The request requires the transaction's BRIC token (EPX Transaction Identifier) and can only be performed on an approved transaction that has not been voided, closed, or settled.

Parameters

EPI-Id required

string

Example:

111-222-333-444

EPI-Signature required

string

Example:

0123456789ABCDEF

Content-Type required

string

Example:

application/json

EPI-Trace

string

bric required

string

Example:

01234567890123456789

Request Schema

amount

number

Example:

11.12

tipAmount

number

Example:

5.25

Example Request

{
  "amount": 11.12,
  "tipAmount": 5.25
}

Example Response

200 Successful Request

400 Invalid Request

401 Unauthorized: EPI-Id is required

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

Batch Close

put /batch

This endpoint closes all captured transactions.

Parameters

EPI-Id required

string

Example:

111-222-333-444

EPI-Signature required

string

Example:

0123456789ABCDEF

EPI-Trace

string

Content-Type required

string

Example:

application/json

Example Response

200 Request was successful

400 Invalid Request

401 Unauthorized

403 Forbidden

404 Not Found

405 Method Not Allowed

500 Internal Server Error