Create a Charge - Keyed

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

These resources support advanced transaction features and integration troubleshooting:

Metatdata

To request transaction metadata, append the include query parameter to your request:
/v1/charges?include=transaction_metadata

LEVEL 2 or LEVEL 3 Card Data

When creating a new charge, you have the option to provide additional card data at LEVEL2 or LEVEL3. These enhanced data levels can provide benefits such as lower Visa and Mastercard interchange rates, particularly for commercial, corporate, purchasing, business, or government cards.

The following fields are required to process a transaction with card_level set to LEVEL2:

  • address\_line1
  • purchase\_order
  • sales\_tax
  • zip

To process transactions with card_level set to LEVEL3, you must include the fields required for LEVEL 2, along with the following additional fields:

  • customer\_vat\_number
  • destination\_country\_code
  • duty\_charges
  • order\_date
  • ship\_from\_zip
  • ship\_to\_zip
  • shipping\_charges
  • summary\_commodity\_code
  • tax\_amount
  • tax\_category
  • tax\_rate
  • tax\_type
  • vat\_invoice
  • product\_details
Instructional Funding (Splits)

Merchants configured with instructional funding are required to include the splits array in the request payload.

At least one valid split instruction must be provided — otherwise, the request may result in errors and could delay funding of the transaction.

API Troubleshooting

When creating a new charge, you may encounter the following error codes. Each status is associated with a specific error message. You can find a detailed error message breakdown in our Charges FAQ.




Body Params
int32
required
string
required
string
string
string
length ≤ 25
string
int32
Defaults to 1
string
enum
Defaults to LEVEL1
Allowed:
int32
string
int32
string
length between 0 and 25
string
string
length between 0 and 17
int32
string
length between 5 and 40
string
length between 0 and 9
int32
string
enum
Allowed:
string
length between 0 and 13
string
length between 0 and 4
int32
int32
int32
string
length between 1 and 4
string
length between 0 and 50
string
int32
string
length between 5 and 40
int32
int32
int32
int32
enum
Allowed:
int32
int32
string
string
enum
Defaults to yes
Allowed:
string
enum
Allowed:
string
string
int32
string
string
length between 1 and 200
string
length between 1 and 200
string
length ≤ 30
string
length between 1 and 50
int32
string
splits
array of objects
splits
product_details
array of objects
product_details
string
string
enum
string
enum
Allowed:
string
enum
Allowed:
string
string
enum
Headers
string
required
Defaults to application/json
string
required
Defaults to application/json
string
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json