B2B API Specification

B2B Payment API

ACH Deposit Details

The Deposit Details APIs provides any information related to the deposited transactions

ACH Deposit Transaction Lookup

post /v3/checks/deposit/transactions

This method can be used to retrieve a list of deposited transactions

Parameters

X-Integrator-Id

Type

string

Maximum Length

Request Schema

limit

Type

integer

Default

Range

1 to 100

offset

Type

integer

Default

Minimum

merchant_id required

Type

integer

Example

12345

deposit_id

Type

string

Example

20200110-D9999

start_date

Type

string

Example

2023-04-19T00:00:00.000Z

end_date

Type

string

Example

2023-05-19T23:59:59.999Z

return_all_results

Type

boolean

Default

false

Example

false

show_extra_information

Type

boolean

Default

false

Example Request

{
  "limit": 10,
  "offset": 0,
  "merchant_id": "12345",
  "deposit_id": "20200110-D9999",
  "start_date": "2023-04-19T00:00:00.000Z",
  "end_date": "2023-05-19T23:59:59.999Z",
  "return_all_results": false,
  "show_extra_information": false
}

Example Response

200 Successful Response

422 Validation Error

ACH Deposit Search

post /v3/checks/deposit/search

This method can be used to retrieve deposit details based on search criteria.

Parameters

X-Integrator-Id

Type

string

Maximum Length

Request Schema

limit

Type

integer

Default

Range

1 to 100

offset

Type

integer

Default

Minimum

merchant_id required

Type

integer

Example

12345

deposit_id

Type

string

Example

20200110-D9999

start_date

Type

string

Example

2023-04-19T00:00:00.000Z

end_date

Type

string

Example

2023-05-19T23:59:59.999Z

return_all_results

Type

boolean

Default

false

Example

false

show_extra_information

Type

boolean

Default

false

Example Request

{
  "limit": 10,
  "offset": 0,
  "merchant_id": "12345",
  "deposit_id": "20200110-D9999",
  "start_date": "2023-04-19T00:00:00.000Z",
  "end_date": "2023-05-19T23:59:59.999Z",
  "return_all_results": false,
  "show_extra_information": false
}

Example Response

200 Successful Response

422 Validation Error

ACH Deposit Summary Search

post /v3/checks/deposit/search/summary

This method can be used to retrieve deposit summaries based on search criteria.

Parameters

X-Integrator-Id

Type

string

Maximum Length

Request Schema

limit

Type

integer

Default

Range

1 to 100

offset

Type

integer

Default

Minimum

merchant_id required

Type

integer

Example

12345

deposit_id

Type

string

Example

20200110-D9999

start_date

Type

string

Example

2023-04-19T00:00:00.000Z

end_date

Type

string

Example

2023-05-19T23:59:59.999Z

return_all_results

Type

boolean

Default

false

Example

false

show_extra_information

Type

boolean

Default

false

Example Request

{
  "limit": 10,
  "offset": 0,
  "merchant_id": "12345",
  "deposit_id": "20200110-D9999",
  "start_date": "2023-04-19T00:00:00.000Z",
  "end_date": "2023-05-19T23:59:59.999Z",
  "return_all_results": false,
  "show_extra_information": false
}

Example Response

200 Successful Response

422 Validation Error

ACH Deposit Email

post /v3/checks/email/deposit-report

This method can be used to send deposit detail reports to a merchant email addresses on file

Parameters

X-Integrator-Id

Type

string

Maximum Length

Request Schema

deposit_details required

Type

array

Example Request

{
  "deposit_details": {
    "merchant_id": "integer",
    "deposit_id": "string"
  }
}

Example Response

200 Successful Response

422 Validation Error

ACH Deposit Details

ACH Deposit Transaction Lookup

ACH Deposit Search

ACH Deposit Summary Search

ACH Deposit Email

Contact Us