Llaves Pix Brasil

Modificación de limites transacional Pix

El endpoint POST /banking/v1/accounts/limits te permite modificar los límites diurno y nocturno de transacciones Pix para la cuenta especificada en el path. En el cuerpo de la solicitud, deberás incluir el valor de cada limite Pix (day_time_limit, night_time_limit). Si el cambio se realiza con éxito, te devolveremos un status 200 y un objeto con los nuevos valores y tipo de la llave Pix creada. Recuerda que en caso de un aumento, el cambio puede demorar 2 horas en impactar.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
day_time_limitstring(maxLength: 128, minLength: 0)required
Límite de horario diurno
Ejemplo: 200000
night_time_limitstring(maxLength: 128, minLength: 0)required
Límite de horario nocturno
Ejemplo: 50000
user_idstring(maxLength: 128, minLength: 0)required
ID del titular de la cuenta
Ejemplo: usr-1NxIj0K1H42y6q3FyxH8rct5sJS
Detalle de respuestas

¿Te resultó útil esta sección?

PUT/banking/v1/accounts/limits
{
"day_time_limit":
"200000"
"night_time_limit":
"50000"
"user_id":
"usr-1NxIj0K1H42y6q3FyxH8rct5sJS"
}
Ejemplo de respuestas
{}

Listar claves bancarias

El endpoint GET /banking/v1/accounts/{account-id}/keys te permite obtener una lista de las claves bancarias asociadas con la cuenta especificada en el path. Si la solicitud es exitosa, te devolveremos un código de estado 200 y una lista de las claves bancarias.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
Detalle de respuestas
idstringrequired
ID de una cuenta de Pomelo
bank_dataobjectrequired
Datos del banco
owner_dataobjectrequired
Datos del propietario
banking_keysarrayrequired
Llaves bancarias
created_atstring(format: date-time)required
Fecha de creación

¿Te resultó útil esta sección?

GET/banking/v1/accounts/{account-id}/keys
Ejemplo de respuestas
{
"id":
"string"
"bank_data":{
"agency":
"string"
"account_number":
"string"
"ispb":
"string"
}
"owner_data":{
"name":
"string"
"surname":
"string"
"legal_name":
"string"
"trade_name":
"string"
"tax_identification_type":
"CPF"
"tax_identification_value":
"string"
"type":
"USER"
}
"banking_keys":[
0:{
...
}
]
"created_at":
"2025-07-01T13:35:42.909Z"
}

Creación de llaves pix

El endpoint POST /banking/v1/accounts/{account-id}/keys te permite crear una nueva llave Pix para la cuenta especificada en el path. En el cuerpo de la solicitud, tendrás que incluir el valor y el tipo de la nueva llave Pix (CPF/CNPJ/EMAIL/PHONE/EVP). Si la creación se realiza con éxito, te devolveremos un status 201 y un objeto con el valor y tipo de la llave Pix creada.
Parámetros disponibles
Header Parameters
X-Idempotency-Keystring(maxLength: 256, minLength: 0)required
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
key_valuestring(maxLength: 128, minLength: 0)
Valor de la clave bancaria
key_typestringrequired
Tipo de clave bancaria
Enum: CPFCNPJPHONEEMAILEVPMANUAL
metadataobject
Metadata
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
Detalle de respuestas
key_typestringrequired
Tipo de clave bancaria
Enum: CPFCNPJPHONEEMAILEVPMANUAL
key_valuestringrequired
Valor de la clave bancaria

¿Te resultó útil esta sección?

POST/banking/v1/accounts/{account-id}/keys
{
"key_value":
"string"
"key_type":
"CPF"
"metadata":{
"two_factor_authentication_ms":
1
}
}
Ejemplo de respuestas
{
"key_type":
"CPF"
"key_value":
"string"
}

Pedido de Reivindicación / Portabilidad de llave Pix

El endpoint POST /banking/v1/accounts/{account-id}/claims te permite solicitar la cesión de una llave Pix a la cuenta especificada en el path. En el cuerpo de la solicitud, deberás incluir el valor y el tipo de la llave Pix solicitada. Si la cesión se realiza con éxito, te devolveremos un código de estado 201 y un objeto con información sobre la cesión.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
key_typestringrequired
Tipo de clave bancaria
Enum: CPFCNPJPHONEEMAILEVPMANUAL
key_valuestring(maxLength: 128, minLength: 0)required
Valor de la clave bancaria
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
Detalle de respuestas
idstringrequired
statusstringrequired
Estado de la portabilidad/reivindicación
Enum: OPENWAITING_RESOLUTIONCONFIRMEDCANCELLEDCOMPLETED
typestringrequired
Tipo de cesión
Enum: PORTABILITYOWNERSHIP
banking_keyobjectrequired
Llave Pix

¿Te resultó útil esta sección?

POST/banking/v1/accounts/{account-id}/claims
{
"key_type":
"CPF"
"key_value":
"string"
}
Ejemplo de respuestas
{
"id":
"string"
"status":
"OPEN"
"type":
"PORTABILITY"
"banking_key":{
"key_type":
"CPF"
"key_value":
"string"
}
}

Confirmacion de cesión

El endpoint POST /banking/v1/accounts/{account-id}/claims/{claim-id}/confirm te permite confirmar la cesión de una llave Pix a la cuenta especificada en el path. Si la confirmación de la cesión es exitosa, te devolveremos un código de estado 201 y un objeto con información sobre la cesión.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
claim-idstring(maxLength: 128, minLength: 0)required
Detalle de respuestas
idstringrequired
Número identificatorio de la portabilidad/reivindicación
statusstringrequired
Estado de la portabilidad/reivindicación
Enum: OPENWAITING_RESOLUTIONCONFIRMEDCANCELLEDCOMPLETED
typestringrequired
Tipo de cesión
Enum: PORTABILITYOWNERSHIP
bankingKeyobjectrequired
Llave Pix
completionPeriodEndstring(format: date-time)
Fecha en la que se completó la portabilidad/reivindicación
resolutionPeriodEndstring(format: date-time)
Fecha en la que se resolvió la portabilidad/reivindicación
updatedAtstring(format: date-time)required
Fecha de actualización del estado de la portabilidad/reivindicación
confirm_reasonstringrequired
Motivo de confirmación de portabilidad/reivindicación
Enum: USER_REQUESTEDACCOUNT_CLOSUREFRAUDDEFAULT_OPERATIONRECONCILIATION

¿Te resultó útil esta sección?

POST/banking/v1/accounts/{account-id}/claims/{claim-id}/confirm
Ejemplo de respuestas
{
"id":
"string"
"status":
"OPEN"
"type":
"PORTABILITY"
"bankingKey":{
"key_type":
"CPF"
"key_value":
"string"
}
"completionPeriodEnd":
"2025-07-01T13:35:42.911Z"
"resolutionPeriodEnd":
"2025-07-01T13:35:42.911Z"
"updatedAt":
"2025-07-01T13:35:42.911Z"
"confirm_reason":
"USER_REQUESTED"
}

Completar cesión

El endpoint POST /banking/v1/accounts/{account-id}/claims/{claim-id}/complete te permite completar una cesión de llave Pix sobre la cuenta especificada en el path. Este endpoint solo se utiliza para los casos de reivindicación de llave, donde el psp donador confirma con motivo DEFAULT_OPERATION.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
claim-idstring(maxLength: 128, minLength: 0)required
Detalle de respuestas
idstringrequired
Número identificatorio de la portabilidad/reivindicación
statusstringrequired
Estado de la portabilidad/reivindicación
Enum: OPENWAITING_RESOLUTIONCONFIRMEDCANCELLEDCOMPLETED
typestringrequired
Tipo de cesión
Enum: PORTABILITYOWNERSHIP
bankingKeyobjectrequired
Llave Pix
completionPeriodEndstring(format: date-time)
Fecha en la que se completó la portabilidad/reivindicación
resolutionPeriodEndstring(format: date-time)
Fecha en la que se resolvió la portabilidad/reivindicación
updatedAtstring(format: date-time)required
Fecha de actualización del estado de la portabilidad/reivindicación
confirm_reasonstringrequired
Motivo de confirmación de portabilidad/reivindicación
Enum: USER_REQUESTEDACCOUNT_CLOSUREFRAUDDEFAULT_OPERATIONRECONCILIATION

¿Te resultó útil esta sección?

POST/banking/v1/accounts/{account-id}/claims/{claim-id}/complete
Ejemplo de respuestas
{
"id":
"string"
"status":
"OPEN"
"type":
"PORTABILITY"
"bankingKey":{
"key_type":
"CPF"
"key_value":
"string"
}
"completionPeriodEnd":
"2025-07-01T13:35:42.912Z"
"resolutionPeriodEnd":
"2025-07-01T13:35:42.912Z"
"updatedAt":
"2025-07-01T13:35:42.912Z"
"confirm_reason":
"USER_REQUESTED"
}

Cancelación de Cesión de llave Pix

El endpoint POST /banking/v1/accounts/{account-id}/claims/{claim-id}/cancel te permite cancelar una cesión de llave Pix sobre la cuenta especificada en el path. Si la cancelación de la cesión se realiza con éxito, te devolveremos un código de estado 201 y un objeto con información sobre la cesión.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
reasonstringrequired
Motivo de cancelación de portabilidad/reivindicación
Enum: USER_REQUESTEDFRAUDACCOUNT_CLOSUREDEFAULT_OPERATIONRECONCILIATION
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
claim-idstring(maxLength: 128, minLength: 0)required
Detalle de respuestas
idstringrequired
Número identificatorio de la portabilidad/reivindicación
statusstringrequired
Estado de la portabilidad/reivindicación
Enum: OPENWAITING_RESOLUTIONCONFIRMEDCANCELLEDCOMPLETED
typestringrequired
Tipo de cesión
Enum: PORTABILITYOWNERSHIP
bankingKeyobjectrequired
Llave Pix
completionPeriodEndstring(format: date-time)
Fecha en la que se completó la portabilidad/reivindicación
resolutionPeriodEndstring(format: date-time)
Fecha en la que se resolvió la portabilidad/reivindicación
updatedAtstring(format: date-time)required
Fecha de actualización del estado de la portabilidad/reivindicación
cancel_reasonstringrequired
Motivo de cancelacion de portabilidad/reivindicación
Enum: USER_REQUESTEDACCOUNT_CLOSUREFRAUDDEFAULT_OPERATIONRECONCILIATION

¿Te resultó útil esta sección?

POST/banking/v1/accounts/{account-id}/claims/{claim-id}/cancel
{
"reason":
"USER_REQUESTED"
}
Ejemplo de respuestas
{
"id":
"string"
"status":
"OPEN"
"type":
"PORTABILITY"
"bankingKey":{
"key_type":
"CPF"
"key_value":
"string"
}
"completionPeriodEnd":
"2025-07-01T13:35:42.913Z"
"resolutionPeriodEnd":
"2025-07-01T13:35:42.913Z"
"updatedAt":
"2025-07-01T13:35:42.913Z"
"cancel_reason":
"USER_REQUESTED"
}

Baja de llave pix

El endpoint DELETE /banking/v1/accounts/{account-id}/keys/{key} te permite eliminar una llave Pix asociada la cuenta especificada en el path. Si la eliminación se realiza con éxito, te devolveremos un código de estado 200 y un objeto con informacion del borrado.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
account-idstring(maxLength: 128, minLength: 0)required
keystring(maxLength: 128, minLength: 0)required
Detalle de respuestas
typestringrequired
Enum: CPFCNPJPHONEEMAILEVPMANUAL
valuestringrequired
statusstringrequired
Enum: ACTIVEDELETEDDELETE_IN_PROGRESSCREATION_IN_PROGRESS
created_atstring(format: date-time)
updated_atstring(format: date-time)

¿Te resultó útil esta sección?

DELETE/banking/v1/accounts/{account-id}/keys/{key}
Ejemplo de respuestas
{
"type":
"CPF"
"value":
"string"
"status":
"ACTIVE"
"created_at":
"2025-07-01T13:35:42.914Z"
"updated_at":
"2025-07-01T13:35:42.914Z"
}

Webhook Portabilidad

Este servicio será el encargado de notificarte cada vez que ocurran los siguientes eventos relacionados a portabilidades o reivindicaciones de llaves.

  • Recepción de portabilidad o reivindicación.
  • Confirmación de portabilidad o reivindicación por parte de la entidad donante.
  • Cancelación de portabilidad o reivindicación por parte de la entidad donante.
  • Aviso de que se completa el pedido que iniciaste.

Tendrás que devolvernos un código HTTP del tipo 2xx para que no volvamos a enviar la notificación. Caso contrario, volveremos a enviarla.

Parámetros disponibles
Body Parameters
idempotent_keystringrequired
Identificador idempotente del evento
client_idstringrequired
Número identificatorio del cliente
event_idstringrequired
Número identificatorio del evento
event_payloadrequired
metadatarequired

¿Te resultó útil esta sección?

POST/<url-del-cliente>
{
"idempotent_key":
"string"
"client_id":
"string"
"event_id":
"string"
}
Ejemplo de respuestas