Criar uma cobrança.

Cria uma cobrança usando um meio de pagamento tokenizado, PIX ou boleto. Para cobranças no cartão, use capture_method=automatic para pagar na hora ou capture_method=manual para autorizar agora e capturar depois.

Autorização

ApiKeyAuth

AutorizaçãoBearer <token>

Em: header

Parâmetros de cabeçalho

Idempotency-Key?string

Tamanho1 <= length <= 255

Corpo da requisição

application/json

Definições TypeScript

Use o tipo request body em TypeScript.

amount*integer

Amount in the minor unit of currency (USD 5.00 -> 500). CLP has no minor unit, so 500 CLP -> 500.

Intervalo1 <= value

currency?string

Currency of amount. Defaults to BRL. A currency other than BRL must be enabled for your account (currency_not_supported otherwise), accepts CARD ONLY and requires installments: 1.

Padrão"BRL"

Value in

"BRL"
"USD"
"EUR"
"GBP"
"CHF"
"CAD"
"MXN"
"ARS"
"CLP"
"COP"
"PEN"

payment_method*string

Value in

"CREDIT_CARD"
"DEBIT_CARD"
"PIX"
"BOLETO"

capture_method?string

Padrão"automatic"

Value in

"automatic"
"manual"

installments?integer

Required for CREDIT_CARD and DEBIT_CARD. Send 1 for one-time card payments.

Intervalo1 <= value <= 24

card_token?string

Match^tok_[A-Za-z0-9_\-]+$

buyer*

Buyer identity. document and phone are required when currency is BRL and optional otherwise. For every optional field here, a blank value counts as not provided: null, an empty string and an absent key are equivalent (document, phone, ip, address.street_number, address.district, address.line_2).

pix?

boleto?

split?array<>

Optional split of the charge to other sellers of the same whitelabel. Recipients are carved out of the charge amount; the remainder stays with the charge's own seller through the normal fee/receivable flow. All items must use the same allocation mode (amount_cents or percentage_bps).

Items1 <= items <= 10

split_rule_id?string

Optional reference to a reusable SplitRule template by public id. The template's recipients are materialized into the same split[] shape at charge-creation time and frozen on the charge, so later edits to the template never affect this charge. Mutually exclusive with inline split.

Match^spr_[A-Za-z0-9]+$

metadata?

Corpo da resposta

`application/json`

curl -X POST "https://example.com/charges" \  -H "Idempotency-Key: order_123_attempt_1" \  -H "Content-Type: application/json" \  -d '{    "amount": 10990,    "currency": "BRL",    "payment_method": "CREDIT_CARD",    "capture_method": "automatic",    "card_token": "tok_xxx",    "installments": 1,    "buyer": {      "name": "Ada Lovelace",      "email": "ada@example.com",      "phone": "+55 11 99999-0000",      "document": "935.411.347-80",      "ip": "203.0.113.10",      "address": {        "line_1": "Av. Paulista, 1000",        "zip_code": "01310-100",        "city": "Sao Paulo",        "state": "SP",        "country": "BR"      }    },    "metadata": {      "order_id": "order_123"    }  }'

{  "id": "string",  "object": "charge",  "status": "pending",  "amount_cents": 1,  "currency": "BRL",  "payment_method": "credit_card",  "capture_method": "automatic",  "captured": true,  "installments": 1,  "buyer": {    "name": "string",    "email": "user@example.com",    "phone": "string",    "document": "string",    "document_type": "cpf",    "ip": "string",    "address": {      "line_1": "string",      "line_2": "string",      "zip_code": "string",      "city": "string",      "state": "string",      "country": "string"    }  },  "acquirer_code": "string",  "acquirer_transaction_id": "string",  "authorization_code": "string",  "acquirer_return_code": "string",  "acquirer_return_message": "string",  "refused_reason": "string",  "next_action": {    "type": "three_ds_challenge",    "three_ds": {      "authentication_id": "string",      "acquirer": "string",      "sdk_payload": {}    }  },  "metadata": {},  "split": [    {      "recipient_seller_id": "string",      "amount_cents": 1    }  ],  "paid_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "request_id": "req_xxx",  "presentment": {    "currency": "USD",    "amount_cents": 0  },  "fx": {    "base_currency": "BRL",    "rate_micros": 0,    "quoted_at": "2019-08-24T14:15:22Z"  }}

Criar uma cobrança.

Autorização

Parâmetros de cabeçalho

Corpo da requisição

Corpo da resposta

201application/json

401application/json

403application/json

409application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`