Create a PIX or card charge

Creates a charge. method_pay selects the flow:

  • pix: returns a PIX QR code and copy and paste code in BRL. Live credentials only (sandbox returns 403).
  • card: returns a hosted checkout_url plus the values needed to embed Apple Pay / Google Pay on your own page. Amount in USD, minimum 5.00. Works with sandbox and live credentials.

For card, the customer fields (debtor_name, email, phone, debtor_document_number) are optional. For PIX, debtor_name, email and phone are required.

This endpoint has no idempotency key. If a request times out, check the transaction before creating a new one.

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

Your API token. Live token, or sandbox token (prefix tk_test_) where sandbox is supported.

string
required

Your API secret. Live secret, or sandbox secret (prefix sk_test_) where sandbox is supported.

number
required

Amount in BRL. Minimum and maximum limits are set per platform.

string
enum
required

Payment method. Any value that is not a card value is routed to PIX; send pix.

Allowed:
string
required

Payer full name.

string
required

Payer email.

string | null

Payer CPF or CNPJ, digits only. Optional in the validation layer, but some PIX acquirers need it, so send it.

string
required

Payer phone, digits only.

string
required

URL that receives the PIX-IN callback when the charge is paid.

Responses

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