B2B API Specification

B2B Payment API

ACH Transaction Records

The Transaction Record API provides real-time access to check or ACH (Automated Clearing House) transaction records as they are stored in our systems. These endpoints offer precise control over the time frame and set size, allowing retrieval of up to 30 records per request.

ACH Transactions

get /v3/checks/transactions

This method provides a list of check or ACH (Automated Clearing House) transaction records based on specified search filter, with a maximum number of 30 records per request.

Parameters

limit

Type

integer

Default

offset

Type

integer

Default

Minimum

start_date

Type

string

Example

2023-04-19T00:00:00

end_date

Type

string

Example

2023-05-19T23:59:59

search_term

Type

string

Example

David William Smith

merchant_id required

Type

integer

Example

246810

user

Type

string

Example

jhondoe

status

Type

string

Enum

INITIATEDACCEPTEDVOIDEDORIGINATEDSETTLEDPARTIALLY_SETTLEDERRORDECLINEDNSF_DECLINEDREJECTEDFAILEDVERIFYINGRETURNEDTECHNICAL_ERROR

Example

ACCEPTED

transaction_type

Type

string

Enum

1234

Example

customer_id

Type

integer

Example

entry_method

Type

string

Enum

APIVTCartREMBL

Example

date_type

Type

string

Default

PROCESSED

Enum

PROCESSEDSETTLED

transaction_id

Type

string

Example

9ecaffcf-48b4-480a-91b4-a0c4d8786806

idempotency_key

Type

string

Maximum Length

Example

9ecaffcf-48b4-480a-91b4-a0c4d8786806

X-Integrator-Id

Type

string

Maximum Length

Example Response

200 Successful Response

422 Validation Error

ACH Transaction By ID

get /v3/checks/transactions/{ach_transaction_id}

This method provides a single transaction record based on the Transaction ID

Parameters

ach_transaction_id required

Type

string

Example

9ecaffcf-48b4-480a-91b4-a0c4d8786806

X-Integrator-Id

Type

string

Maximum Length

Example Response

200 Successful Response

422 Validation Error

ACH Transaction By Idempotency Key

get /v3/checks/transactions/idempotency-keys/{idempotency_key}

This method provides a single transaction record based on the Idempotency Key

Parameters

idempotency_key required

Type

string

Maximum Length

Example

9ecaffcf-48b4-480a-91b4-a0c4d8786806

X-Integrator-Id

Type

string

Maximum Length

Example Response

200 Successful Response

422 Validation Error

ACH Transaction Records

ACH Transactions

ACH Transaction By ID

ACH Transaction By Idempotency Key

Contact Us