Skip to main content
POST
Gerar cobranca
Cria uma cobranca de entrada e retorna o transactionId publico.
Para PIX, a resposta inclui pixCode. Para cartao, a resposta inclui checkout. Se quiser atribuicao de campanha, envie tracking_parameters com seus UTMs.
Se voce estiver implementando checkout de cartao, veja tambem a pagina Cartao.

Authorizations

Authorization
string
header
required

Use sua secret key: Bearer sk_live_prod_...

Body

application/json
amount
number
required

Valor bruto da cobranca.

Required range: 0.01 <= x <= 1000000
description
string

Descricao livre da cobranca.

productName
string

Nome do produto ou servico.

clientName
string

Nome do pagador.

clientEmail
string<email>

Email do pagador.

clientPhone
string

Telefone do pagador.

clientCpf
string

Documento do pagador.

tracking_parameters
object | null
utm_source
string
utm_medium
string
utm_campaign
string
utm_content
string
utm_term
string
referenceId
string<uuid>

Chave de idempotencia do merchant.

paymentMethod
string

Exemplo: credit_card, visa, master, bolbradesco.

paymentMethodTypes
string[]

Usado quando o checkout web de cartao ativo suportar selecao de metodos no frontend. Exemplo: ["card"], ["card","link"], ["paypal"].

cardToken
string

Token de cartao usado em fluxos Mercado Pago.

installments
integer
Required range: 1 <= x <= 12
currency
string

Moeda ISO-4217. Default: brl. A disponibilidade dos metodos depende do checkout ativo na conta.

pixKeyType
enum<string>
Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
pixKey
string
checkoutUiMode
enum<string>
Available options:
hosted,
embedded,
custom
successUrl
string<uri>
cancelUrl
string<uri>
returnUrl
string<uri>

Response

Cobranca criada

transactionId
string<uuid> | null
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
REVERSED,
CANCELLED,
CHARGEBACK
type
enum<string>
Available options:
CASHIN,
CASHOUT,
INFRACTION
source
string
origin
enum<string>
Available options:
API,
PAINEL,
APP
amount
number
feeAmount
number
finalAmount
number
description
string | null
productName
string | null
trackingParameters
object | null
pixCode
string | null
pixKeyType
enum<string> | null
Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
pixKey
string | null
clientName
string | null
clientEmail
string | null
clientPhone
string | null
clientCpf
string | null
externalId
string | null
gatewayId
string | null
endToEndId
string | null
receiptUrl
string | null
transactionDate
string<date-time> | null
paidAt
string<date-time> | null
createdAt
string<date-time> | null
updatedAt
string<date-time> | null
balanceImpact
boolean
settlementMode
string
checkout
object | null