Transferencias Pix Brasil

Decodificar QRs

El endpoint POST /banking/v1/qrs/decode permite decodificar el contenido de una trama QRs estático o dinámico.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
account_idstringrequired
ID de la cuenta del pagador
emv_codestringrequired
Código del QR a decodificar
Detalle de respuestas
tx_idstringrequired
ID del QR
typestringrequired
Tipo de QR: Estático o Dinámico
Enum: STATICDYNAMIC
transaction_typestringrequired
Tipo de transacción
Enum: QR_PIXQR_SAQUEQR_TROCO
payment_timingstringrequired
Tiempo de pago: Inmediato o con fecha de expiración
Enum: IMMEDIATEEXPIRATION
amountobjectrequired
Información del monto de la transacción
messagestring
Mensaje opcional asociado al QR (Hasta 73 caracteres)
beneficiaryobjectrequired
Datos de quién recibe el pago
created_atstring(format: date-time)
Fecha de creación del QR
agent_typestring
Tipo de agente pagador del QR
Enum: AGTECAGTOTAGFSS

¿Te resultó útil esta sección?

POST/banking/v1/qrs/decode
{
"account_id":
"string"
"emv_code":
"string"
}
Ejemplo de respuestas
{
"tx_id":
"string"
"type":
"STATIC"
"transaction_type":
"QR_PIX"
"payment_timing":
"IMMEDIATE"
"amount":{
"value":
"number"
"currency":
"BRL"
"details":{}
}
"message":
"string"
"beneficiary":{
"name":
"string"
"surname":
"string"
"tax_identification_type":
"CPF"
"tax_identification_value":
"string"
"type":
"USER"
"banking_key":{
...
}
}
"created_at":
"2025-07-01T13:35:43.101Z"
"agent_type":
"AGTEC"
}

Realizar transferencias (PIX OUT)

El endpoint POST /banking/v1/accounts/{account-id}/transfers te permite realizar una transferencia de dinero desde una cuenta a otra. En el cuerpo de la solicitud tendrás que enviar los detalles de la transferencia, como el remitente y el beneficiario (ambos con sus tipos y valores de llave Pix), la moneda, el monto y una descripción. Si la transferencia se realiza con éxito, te devolveremos un código de estado 201 y un objeto con información sobre la transferencia.
Parámetros disponibles
Header Parameters
X-Idempotency-Keystring(maxLength: 256, minLength: 0)required
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
beneficiaryoneOf
amountstring(maxLength: 128, minLength: 0)required
Monto total de la transacción
metadataobject
Es un campo opcional para que puedas agregar los datos extra que quieras
descriptionstring(maxLength: 256, minLength: 0)
Descripción de la transacción
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
Detalle de respuestas
idstringrequired
Número identificatorio de la transferencia.
resultstringrequired
Resultado de la transferencia.
Enum: APPROVEDREJECTED
rejection_reasonstring
Solo estará presente cuando la transferencia haya sido rechazada
senderobject
Información del beneficiario de la transferencia
beneficiaryobject
Información del beneficiario de la transferencia
amountstring
Monto total de la transacción
metadataobject
Es un campo opcional para que puedas agregar los datos extra que quieras
descriptionobject
Descripción de la transacción
created_atstring(format: date-time)required
Fecha de creación de la transferencia

¿Te resultó útil esta sección?

POST/banking/v1/accounts/{account-id}/transfers
{
"beneficiary":{
"key_type":
"CPF"
"key_value":
"string"
}
"amount":
"string"
"metadata":{
"ip":
"string"
"lat":
"string"
"long":
"string"
"auth_method":
"string"
"device_model":
"string"
"device_id":
"string"
"property":
"string"
}
"description":
"string"
}
Ejemplo de respuestas
{
"id":
"string"
"result":
"APPROVED"
"rejection_reason":
"string"
"sender":{
"key_type":
"CPF"
"key_value":
"string"
}
"beneficiary":{
"key_type":
"CPF"
"key_value":
"string"
}
"amount":
"string"
"metadata":{}
"description":
"string"
"created_at":
"2025-07-01T13:35:43.105Z"
}

Devoluciones Pix (PIX OUT)

Las transferencias recibidas (Pix in) se pueden devolver a pedido del usuario. Se puede hacer una devolución de una operación de hasta 90 dias de antigüedad y puede ser de un monto menor al original. También se pueden hacer varias devoluciones, siempre que la sumatoria no exceda el monto de la transferencia recibida originalmente. El endpoint para realizar devoluciones es POST /banking/v1/account/{account-id}/transfer/{transfer-id}/refund. Si la operación se realiza con éxito te devolveremos un HTTP 200 OK mostrando información de la transferencia que devuelve la anterior. Esto comprende el resultado de la misma, información acerca del emisor y del receptor, la cantidad de dinero enviado, y la fecha de emisión.
Parámetros disponibles
Header Parameters
X-Idempotency-Keystring(maxLength: 256, minLength: 0)required
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
reasonstringrequired
Motivo de la devolución
Enum: PSP_FAILURESUSPECTED_FRAUDUSER_INTENTIONTRANSACTION_ERROR
amountstring(maxLength: 128, minLength: 0)required
Monto de la devolución
descriptionstring(maxLength: 128, minLength: 0)
Descripción de la devolución
metadataobject
Es un campo opcional para que puedas agregar los datos extra que quieras
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
transfer-idstring(maxLength: 128, minLength: 0)required
Detalle de respuestas
idstringrequired
Número identificatorio de la transferencia.
resultstringrequired
Resultado de la transferencia.
Enum: APPROVEDREJECTED
rejection_reasonstring
Solo estará presente cuando la transferencia haya sido rechazada
senderobject
Información del beneficiario de la transferencia
beneficiaryobject
Información del beneficiario de la transferencia
amountstring
Monto total de la transacción
metadataobject
Es un campo opcional para que puedas agregar los datos extra que quieras
descriptionobject
Descripción de la transacción
created_atstring(format: date-time)required
Fecha de creación de la transferencia

¿Te resultó útil esta sección?

POST/banking/v1/accounts/{account-id}/transfers/{transfer-id}/refunds
{
"reason":
"PSP_FAILURE"
"amount":
"string"
"description":
"string"
"metadata":{
"ip":
"string"
"lat":
"string"
"long":
"string"
"auth_method":
"string"
"device_model":
"string"
"device_id":
"string"
"property":
"string"
}
}
Ejemplo de respuestas
{
"id":
"string"
"result":
"APPROVED"
"rejection_reason":
"string"
"sender":{
"key_type":
"CPF"
"key_value":
"string"
}
"beneficiary":{
"key_type":
"CPF"
"key_value":
"string"
}
"amount":
"string"
"metadata":{}
"description":
"string"
"created_at":
"2025-07-01T13:35:43.107Z"
}

Listar QRs

El endpoint GET /banking/v1/accounts/{account-id}/qrs permite buscar el listado de QRs generados, utilizando distintos filtros.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
Detalle de respuestas
dataobjectrequired

¿Te resultó útil esta sección?

GET/banking/v1/accounts/{account-id}/qrs
Ejemplo de respuestas
{
"data":{
"banking_keys":[
...
]
}
}

Generar QR Estático

El endpoint POST /banking/v1/accounts/{account-id}/qrs permite generar un QR asociado a una cuenta.
Parámetros disponibles
Header Parameters
X-Idempotency-Keystring(maxLength: 256, minLength: 0)required
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
key_valuestringrequired
Valor de la llave origen
amountstring(maxLength: 128, minLength: 0)required
Monto del pago
messagestring(maxLength: 73, minLength: 0)required
Mensaje opcional asociado al QR (Hasta 73 caracteres)
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
Detalle de respuestas
idstringrequired
Número identificatorio del QR
statusstringrequired
Estado del QR
Enum: ACTIVECREATION_IN_PROGRESSDISABLEDFAILED
created_atstring(format: date-time)required
Fecha de creación del QR

¿Te resultó útil esta sección?

POST/banking/v1/accounts/{account-id}/qrs
{
"key_value":
"string"
"amount":
"string"
"message":
"string"
}
Ejemplo de respuestas
{
"id":
"string"
"status":
"ACTIVE"
"created_at":
"2025-07-01T13:35:43.109Z"
}

Obtener información bancaria de una llave PIX

El endpoint GET /banking/v1/beneficiaries/{banking-key} te permite obtener información bancaria de una llave Pix específica. Si la solicitud es exitosa, te devolveremos un código de estado 201 y un objeto con información sobre el titular de la llave.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
banking-keystring(maxLength: 128, minLength: 0)required
Detalle de respuestas
namestring
Nombre del beneficiario
surnamestring
Apellido del beneficiario
tax_identification_typestringrequired
Tipo de identificación del beneficiario
Enum: CPFCNPJ
tax_identification_valuestring
Número de identificación del beneficiario
typestringrequired
Tipo de persona
Enum: CPFCNPJ
ispbstringrequired
ISPB del beneficiario
agencystringrequired
Número de agencia del beneficiario
accountstringrequired
Número de cuenta del beneficiario

¿Te resultó útil esta sección?

GET/banking/v1/beneficiaries/{banking-key}
Ejemplo de respuestas
{
"name":
"string"
"surname":
"string"
"tax_identification_type":
"CPF"
"tax_identification_value":
"string"
"type":
"CPF"
"ispb":
"string"
"agency":
"string"
"account":
"string"
}