KOkoin
Recipient Services Account

Recipient Account

Changed on

Service to obtain recipient account information.

post/v1/payment/payment-key/info

Request

  • Base URL
    https://api-sandbox.koin.com.br
  • URL
    https://api-sandbox.koin.com.br/v1/payment/payment-key/info
  • Auth
    none declared

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": {
    "code": "0123456789",
    "type": "CC"
  },
  "bank": {
    "name": "Bank name"
  },
  "descriptor": "From Mike to Maria's birthday present"
}

Changes

  • 1e3734785750Revision changes
    • warning

      changed the pattern of the request property // from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2}