Atendimento

Criar cobrança

Cria uma cobrança para o pagador. Um retry com a mesma Idempotency-Key devolve a cobrança já criada, sem cobrar de novo.

POST
/payments

Cria uma cobrança para o pagador. Um retry com a mesma Idempotency-Key devolve a cobrança já criada, sem cobrar de novo.

Autorização

oauth2
headerAutorizaçãoBearer <token>

Token do Keycloak (client credentials), enviado como Authorization: Bearer.

Corpo da requisição

application/json
  1. body
payer*
amount*number

Valor em reais, decimal com ponto

Faixa0 <= value
dueDate*string

Vencimento em ISO-8601 (AAAA-MM-DD), hoje ou no futuro

Formatodate
billingType?string

Opcional; sem valor, o pagador escolhe a forma de pagamento no checkout

Valor em"PIX""CREDIT_CARD""DEBIT_CARD""BOLETO""UNDEFINED"
description?string
Tamanho0 <= length <= 500
pixExpiresInMinutes?integer

Opcional, só com billingType PIX: validade do QR Code em minutos, contada da criação e limitada ao fim do dueDate (horário de Brasília). Sem valor, vale o padrão da U2D (24h). Vencida, a cobrança deixa de ser pagável

Formatoint32
Faixa1 <= value <= 43200

Corpo da resposta

Created

*/*
  1. response
id?string
Formatouuid
status?string
Valor em"CREATING""PENDING""OVERDUE""CONFIRMED""RECEIVED""REFUNDING""CHARGEBACK""REFUNDED""CANCELED"
billingType?string
Valor em"PIX""CREDIT_CARD""DEBIT_CARD""BOLETO""UNDEFINED"
amount?number
dueDate?string
Formatodate
description?string
invoiceUrl?string

Página de pagamento do provedor. Em Pix, prefira checkoutUrl: o conteúdo de invoiceUrl varia (página, imagem do QR Code ou nulo)

checkoutUrl?string

Checkout U2D da cobrança, para enviar ao pagador; nulo fora de billingType PIX

fee?number

Taxa da U2D sobre amount, em reais, pelo preço vigente na criação; nula se não houver preço configurado para a forma de pagamento

paidAmount?number

Valor efetivamente pago; nulo enquanto não pago. Pode diferir de amount por juros, multa ou desconto

netAmount?number

Valor líquido, depois das tarifas do provedor; nulo enquanto não pago

paidOn?string

Data do pagamento (horário de Brasília); nula enquanto não pago

Formatodate
pix?

Pix da cobrança; nulo fora de billingType PIX ou se o QR Code não pôde ser obtido

createdAt?string

Criação da cobrança; é o campo da ordenação padrão da listagem

Formatodate-time
curl -X POST 'https://api.u2dpay.com.br/payments' \  -H 'Content-Type: application/json' \  -d '{  "payer": {    "name": "string",    "document": "string"  },  "amount": 0,  "dueDate": "2019-08-24"}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "CREATING",  "billingType": "PIX",  "amount": 0,  "dueDate": "2019-08-24",  "description": "string",  "invoiceUrl": "string",  "checkoutUrl": "string",  "fee": 0,  "paidAmount": 0,  "netAmount": 0,  "paidOn": "2019-08-24",  "pix": {    "copyPaste": "string",    "expiresAt": "2019-08-24T14:15:22Z"  },  "createdAt": "2019-08-24T14:15:22Z"}