B2B API Specification

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

Type

string

Loading...

X-Integrator-Id

Type

string

Maximum Length

12

Loading...

X-Permalinks

Type

string

Maximum Length

4

Loading...

Request Schema

transaction_type

Type

string

Example

SALE

Loading...

customer_label

Type

string

Example

test_customer_id

Loading...

created

Type

object

Loading...

include_bin

Type

boolean

Example

false

Loading...

including_text

Type

string

Example

false

Loading...

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

Type

string

Maximum Length

12

Loading...

X-Permalinks

Type

string

Maximum Length

4

Loading...

Request Schema

transaction_type

Type

string

Example

SALE

Loading...

customer_label

Type

string

Example

test_customer_id

Loading...

created

Type

object

Loading...

include_bin

Type

boolean

Example

false

Loading...

including_text

Type

string

Example

false

Loading...

start_date required

Type

string

Range

8 to 10 characters

Example

09/01/2023

Loading...

end_date required

Type

string

Range

8 to 10 characters

Example

09/01/2023

Loading...

transaction_id

Type

string

Example

123456789

Loading...

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

Type

string

Loading...

X-Integrator-Id

Type

string

Maximum Length

12

Loading...

X-Permalinks

Type

string

Maximum Length

4

Loading...

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