COB

Criar cobrança imediata Pix (COB)

Cria uma cobrança imediata Pix (COB) com `payer`, `payment`,

POST/integration/v1/pix/cob

Corpo da requisição

Campo	Tipo	Descrição
remoteId	string	Exemplo: "11111111-2222-3333-4444-555555555555"
accountId	string (uuid)	Exemplo: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
payer*	PixCobPayer
description*	string	Exemplo: "Cobrança Pix referente ao pedido 12345"
expiration	integer	Exemplo: 3600
expirationDate	string (date-time)	Exemplo: "2026-06-30T18:00:00Z"
pixKey*	string	Chave Pix. O formato depende do tipo: - CPF/CNPJ (1): somente dígitos, sem máscara — ex.: `12345678909`. - E-mail (2): endereço literal — ex.: `fulano@empresa.com.br`. - Telefone (3): formato E.164, com código do país — ex.: `+5511999999999`. - Aleatória/EVP (4): UUID — ex.: `4f9f1d18-a87e-4667-9c43-8b0123456789`.
payment*	PixCobPayment
txId	string	Exemplo: "TX1234567890ABCDEF1234567890"
metadata	object
additionalInformation	array

Exemplo de requisição

curl -X POST https://apiapp.dev.ideabank.com.br/integration/v1/pix/cob \
  -H "Authorization: Bearer $TOKEN" \
  -H "tenantid: $TENANT_ID" -H "hostdevelop: apiapp.dev.ideabank.com.br" -H "Content-Type: application/json" \
  -d '{
  "remoteId": "11111111-2222-3333-4444-555555555555",
  "accountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "payer": {
    "name": "João da Silva",
    "taxIdentifier": "12345678909"
  },
  "description": "Cobrança Pix referente ao pedido 12345",
  "expiration": 3600,
  "expirationDate": "2026-06-30T18:00:00Z",
  "pixKey": "+5511999999999",
  "payment": {
    "amount": 150.25,
    "fixedAmount": true
  },
  "txId": "TX1234567890ABCDEF1234567890",
  "metadata": "object",
  "additionalInformation": [
    {
      "key": "pedido",
      "value": "12345"
    }
  ]
}'

Exemplo de resposta (200)

{
  "payer": {
    "name": "João da Silva",
    "taxIdentifier": "12345678909"
  },
  "payee": null,
  "description": "Cobrança Pix referente ao pedido 12345",
  "expirationDate": "2026-06-30T18:00:00Z",
  "expiration": 3600,
  "pixKey": "+5511999999999",
  "payment": {
    "amount": 150.25,
    "fixedAmount": true
  },
  "txId": "TX1234567890ABCDEF1234567890",
  "ref": "cob-12345",
  "copyPasteCode": "0002010102122680...",
  "metadata": "object",
  "additionalInformation": [
    {
      "key": "pedido",
      "value": "12345"
    }
  ]
}

Códigos de resposta

HTTP	Descrição
200	COB criada com sucesso
401
403
409
422
500

Fonte

Esta página é gerada a partir do Swagger oficial. Para o payload autoritativo, consulte também a especificação viva.

← Voltar para o índice