v1

latestOpenAPI 3.0.3Apache License Version 2.02026-07-2631211285.4 KB

Recipient Services Account

Recipient Account

Service to obtain recipient account information.

post/v1/payment/payment-key/info

Request body

payment_keystring required

Pix payment key. Options are CNPJ, CPF, telephone, email, or random payment key (max 100 characters)

Example request

{
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "account": "SBX000",
    "amount": {
      "currency_code": "BRL",
      "value": 1500.56
    }
  }
}

Response

Recipient response

idstring

Identifier search recipient.

namestring

Full name.

descriptorstring

Text send to client. Maximum of 140 characters.

codestring

Standardized error code (applies only for error cases)

messagestring

Message associated with the error code (applies only for error cases)

Example response

{
  "name": "Box Jhon",
  "account": {
    "type": "CC"
  },
  "bank": {
    "name": "Bank name"
  },
  "descriptor": "From Mike to Maria's birthday present"
}