B2B API Specification

B2B Payment API

Export Single Batch

post /v3/batch/export

This method can be used to export a summary of specific batch details or currently pending settlement details by card and transaction type. If no optional parameter is provided, the latest batch details will be returned.

By exporting the batch detail, your application will be able to determine the deposits and refunds.

Parameters

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Request Schema

batch_number

Type

integer

Example

Example Request

{
  "batch_number": 12
}

Example Response

200 Successful Response

422 Validation Error

Export Batches by Date Range

post /v3/batch/export/by-date

This method can be used to export a set of batch summary details with a provided date range. This method will return one or more batch summary records.

By exporting the batch summary details, your application will be able to determine the deposits and refunds.

Parameters

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Request Schema

start_date required

Type

string

Range

8 to 10 characters

Example

01/25/2024

end_date required

Type

string

Range

8 to 10 characters

Example

01/25/2024

Example Request

{
  "start_date": "01/25/2024",
  "end_date": "01/25/2024"
}

Example Response

200 Successful Response

422 Validation Error

Export Settled Transactions by Batch

post /v3/batch/export/transactions

This method can be used to export settled transaction details within a specific batch. This method will return one or more transaction records.

Parameters

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Request Schema

batch_number required

Type

integer

Example

Example Request

{
  "batch_number": 1
}

Example Response

200 Successful Response

422 Validation Error

Export Single Batch

Export Batches by Date Range

Export Settled Transactions by Batch

Contact Us