Create a charge

post https://api.elements-sandbox.io/api/v1/charges

Body Params

amount

int32

required

Defaults to 100

The amount to be collected in smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100)

currency

string

required

Defaults to USD

Three-letter ISO currency code, in uppercase.

payment_method_id

string

required

Defaults to PM-ad123SDJI23NNKJ3

The payment method token used to auth the transaction

external_customer_id

string

Defaults to 4521902.external_customer_id

Merchant customer identifier

description

string

Defaults to ELEMENTS PAY, INC

Descriptor shows up in the payment statement

capture

boolean

Defaults to true

Whether to immediately capture the charge. Defaults to true. When false, the charge issues an authorization (or pre-authorization), and will need to be captured later.

Headers

Idempotency-Key

string

required

A unique value generated by the client which the server uses to recognize subsequent retries of the same request.

Responses

Language

Credentials

Header

Request


xxxxxxxxxx
15
1
curl --location --request POST 'https://api.elements-sandbox.io/api/v1/charges' \
2
--header 'Idempotency-Key: Idempotency-Key-test' \
3
--header 'Content-Type: application/json' \
4
--header 'Authorization: Bearer ....' \
5
--data-raw '{
6
    "amount":3000,
7
    "description": "test",
8
    "capture": true,
9
    "currency": "USD",
10
    "payment_method_id": "PM-qpDvnxWsug9fxc6cdNboN5YG",
11
    "external_customer_id": "4521902.external_customer_id",
12
    "metadata": { 
13
        "example_metadata_key": "example_metadata_value"
14
    }
15
}'

Choose an example:

application/json

200200

400400

403403