Skip to main content
POST
Criar cobrança

Authorizations

Authorization
string
header
required

Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.

Body

application/json
amount
integer
required

Valor em centavos

Required range: x >= 1
product_type
enum<string>
required

Tipo do produto

Available options:
physical,
digital
customer
object
required
items
object[]
required

Itens do pedido

Minimum array length: 1
payment_method
enum<string>
required
Available options:
credit_card
payment_details
object
required
submerchant_id
string<uuid>

ID do submerchant (opcional)

shipping_amount
integer
default:0

Valor do frete em centavos

Required range: x >= 0
currency
string
default:BRL

Código da moeda

Required string length: 3
billing_address
object
shipping_address
object
metadata
object

Dados adicionais

split
object[]

Array de regras de split para dividir o valor da cobrança entre múltiplos recebedores

Minimum array length: 1

Response

Cobrança criada com sucesso

success
boolean
Example:

true

message
string
data
object