v1
latestOpenAPI 3.1.02026-07-24170121.2 MBCreate a Charge - Keyed
This endpoint enables you to securely initiate payment transactions by submitting charge details via a POST request.
post/v1/charges
Headers
Acceptstring required
Indicates which content types, expressed as MIME types, the client is able to understand.
Content-Typestring required
Indicates the media type of the resource sent in the HTTP message body. r /r /Possible Values:/br / application/jsonr /application/x-www-form-urlencoded
Idempotency-Keystring
Ensures that a request is processed only once, even if it is retried due to network timeouts or errors. When provided, the server uses the key to identify and return the result of a previous request with the same key, preventing duplicate operations (e.g., duplicate payments or record creation).
Request body
Example request
{
"currency": "usd",
"statement_description": "A1 Company",
"order_date": "2021-01-31",
"tax_type": "VAT",
"email": "someone@example.com",
"metadata": "{\"FullCustomerName\":\"John Smith\",\"CustomerID\":\"1234567890\"}"
}Response
201
Example response
{
"data": {
"object": "Charge",
"id": "nBoLWODLMLLoOXyb",
"amount": 1200,
"amount_captured": "1200",
"payarc_fees": 35,
"type": "Sale",
"net_amount": 1165,
"captured": 1,
"status": "submitted_for_settlement",
"auth_code": "TAS712",
"statement_description": "statement description",
"created_at": 1611924403,
"updated_at": 1611924405,
"email": "john.doe@example.com",
"phone_number": "5417543010",
"card_level": "LEVEL1",
"created_by": "bubbles@eyepaste.com",
"card": {
"data": {
"object": "Card",
"id": "2mMPL029yyP50vyN",
"card_source": "PHONE",
"card_holder_name": "Test One",
"is_default": 1,
"exp_month": "12",
"exp_year": "2022",
"fingerprint": "9v09mPMLP5NMNM0m",
"brand": "V",
"last4digit": "1111",
"first6digit": 411111,
"customer_id": "4jAPDKVp44MVNxnM",
"created_at": 1611924035,
"updated_at": 1611924038
}
}
},
"meta": {
"include": [
"review"
]
}
}