API Reference

Create Immediate Charge with txid

put
https://baas-h.cdcbank.com.br/v2/cob/

The "txid" (Transaction ID) is a unique identifier used to identify transactions in the instant payment system (PIX). This identifier is crucial for tracking and managing transactions, especially in cases of immediate charges via the PIX API. It is generated by the integrator with the pattern [a-zA-Z0-9], with a minimum of 26 characters and a maximum of 35 characters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

The devedor field is required to have a CPF or CNPJ

Passing a devedor without a cpf or cnpj will result on a ERROR 400 response

📘

The modalidadeAgente field from the saque object must be filled according to the table:

ValueDescription
AGTECAgente Estabelecimento Comercial
AGTOTAgente Outra Espécie de Pessoa Jurídica ou Correspondente no País
AGPSSAgente Facilitador de Serviço de Saque

📘

The modalidadeAgente field from the troco object must be filled according to the table:

ValueDescription
AGTECAgente Estabelecimento Comercial
AGTOTAgente Outra Espécie de Pessoa Jurídica ou Correspondente no País

Response Parameters

ParameterTypeDescription
calendarioObjectExpiry Info of the Pix Charge
criacaoStringPix Charge Creation Timestamp
expiracaoStringPix Charge Time(in seconds) Until Expiry
txidStringPix Charge Unique Code
revisaoIntegerAmount of Time the Pix Charge Was Modified
devedorObjectPayer Info
cpf or cnpjStringPayer CPF or CNPJ
nomeStringPayer Name
locObjectLocation Object
idIntegerLocation Unique ID
locationSringLocation
tipoCobStringLocation Charge Type
locationStringLocation
statusStringPix Charge Current State
valorFloatPix Charge Amount
pixCopiaEColaStringPix Charge Pix Copia e Cola
chaveStringReceiver Pix Key
solicitacaoPagadorStringText to be Delivered to the Payer
infoAdicionaisArrayAdditional Info
nomeStringField Name
valorStringField data

Request Parameters

Path Params
string
required

Pix Charge Unique Code [a-zA-Z0-9]{26,35}

Body Params
calendario
object
required

The nested fields under the "calendar" identifier organize information regarding the time control of the charge. These fields are essential for defining deadlines and ensuring proper management of the charge's lifecycle.

devedor
object

payer information

loc
object

payload location

valor
object
required

monetary values related to the charge

string
required

The key field will be filled with the key registered in internet banking and authorized for use in the Pix API by the CDC. The types of keys can be: phone number, email, CPF/CNPJ, or EVP.

string

optional message for the payer with a limit of 140 characters

infoAdicionais
object

Each respective additional piece of information in the list (name and value) must be presented to the payer.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated over 1 year ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago