Cria uma nova cobrança PIX associada a uma conta escrow específica na Plataforma Celcoin.
A cobrança gerada possui data de vencimento, regras de juros e expiração após o pagamento, permitindo a liquidação via QR Code ou código EMV.
Este endpoint possibilita o registro completo da cobrança, incluindo:
-
Valor da cobrança
-
Dados do devedor (pagador)
-
Data de vencimento
-
Regras de juros
-
Prazo de expiração após o pagamento
A cobrança criada poderá ser consultada posteriormente e utilizada para pagamento via PIX.
Descrição
Este endpoint permite criar uma cobrança PIX vinculada a uma conta escrow específica, identificada pelo account_id.
A operação registra a cobrança na plataforma e retorna todas as informações necessárias para pagamento, como QR Code, código EMV e URL de pagamento.
Método HTTP
POST
URL
Plain Text
https://sandbox.platform.credit.celcoin.com.br/escrow/api/v1/accounts/{account_id}/pix-charges
Path Parameters
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| account_id | string | Sim | Identificador único da conta escrow na Plataforma Celcoin. Garante que a cobrança será criada na conta correta. |
Headers
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Authorization | string | Sim | Token de autenticação no formato Bearer {token}. Responsável por autenticar e autorizar o acesso ao endpoint. |
| Content-Type | string | Sim | Deve ser informado como application/json. |
Body Parameters
Dados da Cobrança
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| amount | number | Sim | Valor da cobrança PIX. |
| dueDate | string | Sim | Data de vencimento da cobrança no formato ISO 8601 (YYYY-MM-DD). |
| expirationAfterPayment | integer | Não | Prazo, em dias, para expiração da cobrança após o pagamento. |
| interestAmount | number | Não | Valor do juros aplicado à cobrança. |
| interestType | string | Não | Tipo de juros. Exemplo: PERCENTAGE_PER_MONTH_CALENDAR_DAYS. |
Debtor (Objeto)
Dados do pagador da cobrança.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| name | string | Sim | Nome do pagador. |
| taxpayerId | string | Sim | CPF ou CNPJ do pagador (somente números). |
| type | string | Sim | Tipo do pagador. Valores aceitos: PERSON, COMPANY. |
Exemplo de Requisição
Plain Text
POST /escrow/api/v1/accounts/123456/pix-charges
Authorization: Bearer {token}
Content-Type: application/json
{
"amount": 5,
"debtor": {
"name": "Não informado",
"taxpayerId": "32383861820",
"type": "PERSON"
},
"dueDate": "2026-01-15",
"expirationAfterPayment": 5,
"interestAmount": 0,
"interestType": "PERCENTAGE_PER_MONTH_CALENDAR_DAYS"
}
Resposta de Sucesso
Status: 201 Created
Retorna os dados completos da cobrança PIX criada, incluindo identificadores, informações de pagamento e dados do devedor.
Exemplo de Resposta
{
"id": "17f78e3e-0064-4231-8b76-c0a33301d797",
"amount": "5.00",
"description": null,
"due_date": "2026-01-15",
"expiration_after_payment": "5",
"status": "ACTIVE",
"pix_key": "eafccd5d-7df7-4aa2-8b98-38561664f092",
"pre_signed_url": "https://s3.sa-east-1.amazonaws.com/...",
"interest_amount": 0,
"interest_type": "PERCENTAGE_PER_MONTH_CALENDAR_DAYS",
"discount_amount": null,
"discount_type": null,
"fine_amount": null,
"fine_type": null,
"emv": "0002010102122698...",
"url": "qrcode-h.pix.celcoin.com.br/pixqrcode/v2/cobv/...",
"debtor": {
"taxpayer_id": "32383861820",
"name": "Não informado",
"email_address": null,
"address": null
},
"created_at": "2026-01-15T14:14:26.635Z"
}
Códigos de Retorno Padrão
| Status Code | Descrição |
|---|---|
| 201 Created | Cobrança PIX criada com sucesso. |
| 400 Bad Request | Dados inválidos ou malformados na requisição. |
| 401 Unauthorized | Token de autenticação ausente ou inválido. |
| 403 Forbidden | Acesso não autorizado à conta escrow informada. |
| 404 Not Found | Conta escrow não encontrada. |
| 422 Unprocessable Entity | Regras de negócio violadas (ex: data inválida, valor inconsistente). |
| 500 Internal Server Error | Erro interno inesperado na plataforma. |