B2B API Specification

Version 3.2.19

production
sandbox

Transaction Records

Transaction records are real time results of your card transactions as they exist in our systems. In contrast to the export endpoints, which may be slightly time delayed in order to provide large data sets in an expeditious manner, these endpoints are for more fine tuned time/set sizes (limit of 50 records per request - for larger, see the Exports section).

Transaction By ID

get /v3/card/transaction/{transaction_id}

Get a single transaction record based on the transaction ID.

Parameters
transaction_id required
Type
string

Loading...

merchant_id required
Type
integer

Loading...

X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Example Response
200 Successful Response
422 Validation Error

Capturable

get /v3/card/transactions/capturable/{merchant_id}

Returns a list of all transactions that can have a follow up 'capture' event applied to them.

Parameters
merchant_id required
Type
integer

Loading...

date_from
Type
string

Loading...

date_to
Type
string

Loading...

limit
Type
integer
Default
50

Loading...

offset
Type
integer
Default
0

Loading...

search_term
Type
string

Loading...

order_id
Type
string

Loading...

X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Example Response
200 Successful Response
422 Validation Error

Voidable

get /v3/card/transactions/voidable/{merchant_id}

Returns a list of all transactions that can have a follow up 'void' event applied to them.

Parameters
merchant_id required
Type
integer

Loading...

date_from
Type
string

Loading...

date_to
Type
string

Loading...

limit
Type
integer
Default
50

Loading...

offset
Type
integer
Default
0

Loading...

search_term
Type
string

Loading...

order_id
Type
string

Loading...

X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Example Response
200 Successful Response
422 Validation Error

Refundable

get /v3/card/transactions/refundable/{merchant_id}

Returns a list of all transactions that can have a follow up 'refund' event applied to them.

Parameters
merchant_id required
Type
integer

Loading...

date_from
Type
string

Loading...

date_to
Type
string

Loading...

limit
Type
integer
Default
50

Loading...

offset
Type
integer
Default
0

Loading...

search_term
Type
string

Loading...

order_id
Type
string

Loading...

X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Example Response
200 Successful Response
422 Validation Error

Contact Us

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.