B2B API Specification

Version version: 3.2.8

production
sandbox

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
string
Maximum:
12

Loading...

Request Schema
limit
integer
Default:
10

Loading...

offset
integer
Default:
0

Loading...

merchant_id required
integer
Example:
12345

Loading...

deposit_id
string
Example:
20200110-D9999

Loading...

start_date
string
Example:
2023-04-19T00:00:00.000Z

Loading...

end_date
string
Example:
2023-05-19T23:59:59.999Z

Loading...

return_all_results
boolean
Default:
false
Example:
false

Loading...

show_extra_information
boolean
Default:
false

Loading...

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
string
Maximum:
12

Loading...

Request Schema
limit
integer
Default:
10

Loading...

offset
integer
Default:
0

Loading...

merchant_id required
integer
Example:
12345

Loading...

deposit_id
string
Example:
20200110-D9999

Loading...

start_date
string
Example:
2023-04-19T00:00:00.000Z

Loading...

end_date
string
Example:
2023-05-19T23:59:59.999Z

Loading...

return_all_results
boolean
Default:
false
Example:
false

Loading...

show_extra_information
boolean
Default:
false

Loading...

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
string
Maximum:
12

Loading...

Request Schema
limit
integer
Default:
10

Loading...

offset
integer
Default:
0

Loading...

merchant_id required
integer
Example:
12345

Loading...

deposit_id
string
Example:
20200110-D9999

Loading...

start_date
string
Example:
2023-04-19T00:00:00.000Z

Loading...

end_date
string
Example:
2023-05-19T23:59:59.999Z

Loading...

return_all_results
boolean
Default:
false
Example:
false

Loading...

show_extra_information
boolean
Default:
false

Loading...

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
string
Maximum:
12

Loading...

Request Schema
deposit_details required
array

Loading...

Example Request
{
  "deposit_details": {
    "merchant_id": "integer",
    "deposit_id": "string"
  }
}
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.