B2B API Specification

B2B Payment API

Export Transaction by Transaction ID

post /v3/transaction/export/{transaction_id}

This method can be used to export specific credit card transaction details.

Parameters

transaction_id required

string

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Request Schema

transaction_type

string

Example:

SALE

customer_label

string

Example:

test_customer_id

created

object

include_bin

boolean

Example:

false

including_text

string

Example:

false

Example Request

{
  "transaction_type": "SALE",
  "customer_label": "test_customer_id",
  "created": {
    "by": "sandbox_user"
  }
}

Example Response

200 Successful Response

422 Validation Error

Export Transactions by Date Range

post /v3/transactions/export/by-date

This method can be used to export a set of credit card transaction details with a provided date range. You can optimize your search by providing optional parameters.

Parameters

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Request Schema

transaction_type

string

Example:

SALE

customer_label

string

Example:

test_customer_id

created

object

include_bin

boolean

Example:

false

including_text

string

Example:

false

start_date required

string8 to 10 characters

Example:

09/01/2023

end_date required

string8 to 10 characters

Example:

09/01/2023

transaction_id

string

Example:

123456789

Example Request

{
  "transaction_type": "SALE",
  "customer_label": "test_customer_id",
  "created": {
    "by": "sandbox_user"
  },
  "start_date": "09/01/2023",
  "end_date": "09/01/2023",
  "transaction_id": "123456789"
}

Example Response

200 Successful Response

422 Validation Error

Export Surcharge Transaction by Transaction ID

get /v3/transaction/surcharge/export/{transaction_id}

This method can be used to export specific Surcharge transaction details.

Parameters

transaction_id required

string

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Example Response

200 Successful Response

422 Validation Error

Export Transaction by Transaction ID

Export Transactions by Date Range

Export Surcharge Transaction by Transaction ID

Contact Us