Skip to main content
POST
Criar cobrança

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
currency
string
required
Required string length: 3
items
object[]
amountInCents
integer
Required range: x >= 1
customer
object
description
string
Maximum string length: 255
metadata
object
postbackUrl
string<uri>
successUrl
string<uri>
cancelUrl
string<uri>

Response

Cobrança criada

id
string
Example:

"chg_2e59538f..."

object
string
Example:

"charge"

status
enum<string>
Available options:
pending,
paid,
failed,
refunded,
canceled
amountInCents
integer
currency
string
items
object[]
description
string | null
customer
object
metadata
object
checkoutUrl
string
postbackSecret
string

Retornado apenas na criação.

createdAt
string<date-time>