B2B API Specification | North Developer

B2B Payment API

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

string

merchant_id required

integer

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

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

integer

date_from

string

date_to

string

limit

integer

Default:

offset

integer

Default:

search_term

string

order_id

string

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

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

integer

date_from

string

date_to

string

limit

integer

Default:

offset

integer

Default:

search_term

string

order_id

string

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

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

integer

date_from

string

date_to

string

limit

integer

Default:

offset

integer

Default:

search_term

string

order_id

string

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Example Response

200 Successful Response

422 Validation Error