Transfers in Brazil

The transfer is performed in 2 simple steps:

  • Validation of the target account using a PIX key (via the “Get Target PIX Key Information” endpoint)
  • With the information of the destination account you must perform the second step of the operation, which is to send the transaction itself (through the “Make Transfer” endpoint)

The transfer response can be synchronous or asynchronous. In the case of a synchronous response, the Transfer API service will return the final status of the transaction (SUCCESS or FAILED). If the response is asynchronous (because it takes a few more seconds), the Transfer API service will return a pending status synchronously (IN_PROGRESS) and the notification of the final status of the transaction will be seen as Activity through the Core Webhooks service.

Obtener información de llave pix destino

Available parameters
Path Parameters
account_idstringrequired
Sender account id
Example: acc-26AA71defpMZiKvkwk2fwkCRRYU
keystringrequired
Response details
dataobject
Was this section helpful to you?
GET/networks/bank/v1/transfers/{account_id}/key/{key}
Response examples

Make Transfer

Available parameters
Header Parameters
X-Idempotency-Keystringrequired
Body Parameters
transaction_idstring
Example: tr-9c94e7ce-792e-11ec-90d6-0242ac120003
valuenumber
descriptionstring
Example: Teste de transferência
Response details
dataobject
Was this section helpful to you?
POST/networks/bank/v1/transfers/out
{
"transaction_id":
"tr-9c94e7ce-792e-11ec-90d6-0242ac120003"
"value":
100
"description":
"Teste de transferência"
}
Response examples

Realizar Transferencia TEF

Available parameters
Header Parameters
X-Idempotency-Keystringrequired
Body Parameters
amountnumber
bank_receiver_acc_idnumber
bank_sender_acc_idnumber
account_idstring
Example: acc-2AtmQ72PdN5phkCpTif3eNNJrue
receiver_cpfcnpjstring
sender_cpfcnpjstring
descriptionstring
Example: Soy una description
agencynumber
ispbnumber
Response details
dataobject
Was this section helpful to you?
POST/networks/bank/v1/transfers/tef
{
"amount":
1
"bank_receiver_acc_id":
4729722
"bank_sender_acc_id":
4721020
"account_id":
"acc-2AtmQ72PdN5phkCpTif3eNNJrue"
"receiver_cpfcnpj":
38932557888
"sender_cpfcnpj":
8409166470
"description":
"Soy una description"
"agency":
1
"ispb":
125
}
Response examples

Generar código QR

Available parameters
Header Parameters
X-Idempotency-Keystringrequired
Body Parameters
account_idstring
Example: acc-2AtmQ72PdN5phkCpTif3eNNJrue
keyobject
referencestring
Example: Testing QR Generation
amountobject
typestring
Enum: STATICDYNAMIC
descriptionstring
Example: Additional description for payment
Response details
qr_codestring
Example: 00020101021126580014br.gov.bcb.pix01364a1cb351-7f85-45ef-831b-5fbf77a81aea52040000530398654045.005802BR5920Test GeoTrace Cuatro6009SAO PAULO62130509test6304503E
image_contentstring
mime_typestring
Example: image/png
actual_image_widthnumber
pix_linkstring
referencestring
Example: Testing
property_changedstring
Was this section helpful to you?
POST/networks/bank/v1/payments/qr/generate
{
"account_id":
"acc-2AtmQ72PdN5phkCpTif3eNNJrue"
"key":{
"value":
"4a1cb351-7f85-45ef-831b-5fbf77a81aea"
"type":
"EVP"
}
"reference":
"Testing QR Generation"
"amount":{
"type":
"CLOSED"
"value":
5
}
"type":
"STATIC"
"description":
"Additional description for payment"
}
Response examples

Decodificar código QR

Available parameters
Header Parameters
X-Idempotency-Keystringrequired
Body Parameters
account_idstring
Example: acc-2AtmQ72PdN5phkCpTif3eNNJrue
qr_hashstring
Example: 00020101021126580014br.gov.bcb.pix01367d348ee6-3d97-40f7-a797-47e39db1a6fa52040000530398654045.005802BR5909Test6009SAO PAULO62090505TEST463045EB6
Response details
transaction_idstring
Example: 2B2RaHWrJiDIKpLNqFk4mLXoToC
namestring
Example: Roberto Cardenas
cpf_cnpjstring
keystring
Example: 98336571-563b-4350-b73b-6298d0182068
bankstring
Example: BANCO GENIAL
amountnumber
descriptionstring
Example: IPAY
allow_value_modifynumber
Enum: 01
Was this section helpful to you?
POST/networks/bank/v1/payments/qr/decode
{
"account_id":
"acc-2AtmQ72PdN5phkCpTif3eNNJrue"
"qr_hash":
"00020101021126580014br.gov.bcb.pix01367d ..."
}
Response examples

Pagar código QR

Available parameters
Header Parameters
X-Idempotency-Keystringrequired
Body Parameters
transaction_idstring
Example: 2CDs8OrzvGgj4HntDPy9IbunTET
Response details
transaction_idstring
Example: 2B2RaHWrJiDIKpLNqFk4mLXoToC
statusstring
Example: SUCCESS
Enum: SUCCESSREJECTEDPENDING
valuenumber
Was this section helpful to you?
POST/networks/bank/v1/payments/qr/send
{
"transaction_id":
"2CDs8OrzvGgj4HntDPy9IbunTET"
}
Response examples