Account Validation

Body

Name	Type	Description
transactionId	`string`	Optional. Identifier for Conciliation of the Receiving Customer. Used by the Receiving Customer to reconcile the billing document (QR Code) with the actual payment.
key	`string`	Optional. Pix key utilized in the process of receiving a pix.
endToEndId	`string`	Unique payment transaction identifier.
initiationType	`enum`	Type of mechanism used to initiate payment. Domains: `MANUAL` `KEY` `QR_CODE_STATIC` `QR_CODE_DYNAMIC`
amount	`number`	Transaction amount
payer\|beneficiary	`object`	Information about the payer/beneficiary
payer\|beneficiary.number	`string`	Client’s account number - Required - Min length: 1 - Max length: 20
payer\|beneficiary.branch	`string`	Client’s account branch - Required - Length: 4
payer\|beneficiary.type	`enum`	Payer/beneficiary participant Domains: `CURRENT` - Current Account `PAYMENT` - Payment Account `SAVING` - Savings Account `SALARY` - Salary Account
payer\|beneficiary.participant	`object`	Payer/beneficiary participant
payer\|beneficiary.participant.ispb	`string`	Participant’s ISPB
payer\|beneficiary.holder	`object`	Infomations about the holder’s account
payer\|beneficiary.holder.document	`string`	Holder’s name
payer\|beneficiary.holder.name	`string`	Holder’s name
payer\|beneficiary.holder.type	`enum`	Holder’s document type. Domains: `NATURAL` - Natural Person `LEGAL` - Legal Person

{
   "endToEndId":"E0000000020231107221725nWTjsuxWh",
   "initiationType":"MANUAL",
   "amount":6.00,
   "createdAt":"2023-11-07T22:17:25.339Z",
   "payer":{
      "number":"826953",
      "branch":"9162",
      "type":"CURRENT",
      "participant":{
         "ispb":"99999003"
      },
      "holder":{
         "name":"CENTRO DE SAUDE CREDILUZ LTDA",
         "document":"12345678901234",
         "type":"LEGAL"
      }
   },
   "beneficiary":{
      "number":"10073",
      "branch":"0001",
      "type":"CURRENT",
      "participant":{
         "ispb":"1111111"
      },
      "holder":{
         "name":"DOUGLAS DE ABREU",
         "document":"12345678912",
         "type":"NATURAL"
      }
   }
}

{
   "key":"06130856555",
   "endToEndId":"E0000000020231107221725nWTjsuxWh",
   "initiationType":"KEY",
   "amount":6.00,
   "createdAt":"2023-11-07T22:17:25.339Z",
   "payer":{
      "number":"826953",
      "branch":"9162",
      "type":"CURRENT",
      "participant":{
         "ispb":"99999003"
      },
      "holder":{
         "name":"CENTRO DE SAUDE CREDILUZ LTDA",
         "document":"12345678901234",
         "type":"LEGAL"
      }
   },
   "beneficiary":{
      "number":"10073",
      "branch":"0001",
      "type":"CURRENT",
      "participant":{
         "ispb":"1111111"
      },
      "holder":{
         "name":"DOUGLAS DE ABREU",
         "document":"12345678912",
         "type":"NATURAL"
      }
   }
}

{
   "key":"06130856555",
   "endToEndId":"E0000000020231107221725nWTjsuxWh",
   "transactionId":"REC00000000000000000000000000000001",
   "initiationType":"QR_CODE_STATIC | QR_CODE_DYNAMIC",
   "amount":6.00,
   "createdAt":"2023-11-07T22:17:25.339Z",
   "payer":{
      "number":"826953",
      "branch":"9162",
      "type":"CURRENT",
      "participant":{
         "ispb":"99999003"
      },
      "holder":{
         "name":"CENTRO DE SAUDE CREDILUZ LTDA",
         "document":"12345678901234",
         "type":"LEGAL"
      }
   },
   "beneficiary":{
      "number":"10073",
      "branch":"0001",
      "type":"CURRENT",
      "participant":{
         "ispb":"1111111"
      },
      "holder":{
         "name":"DOUGLAS DE ABREU",
         "document":"12345678912",
         "type":"NATURAL"
      }
   }
}

Response

Below is the expected agreement to ensure the account validation process is completed successfully.

{
    "status": "VALID_ACCOUNT"
}

Body

Name	Type	Description
status	`enum`	Returned status. Domains: `VALID_ACCOUNT` `INVALID_ACCOUNT` `BLOCKED_ACCOUNT` `INCORRECT_ACCOUNT_TYPE` `GENERIC_ERROR` - Interrupted transaction due to error on the beneficiary participant `TRANSACTION_NOT_SUPPORTED` - Transaction type not supported/authorized by the transactional account `_INCONSISTENT` - CPF or CNPJ doesn’t match with the holder of the specified transactional account. `QR_CODE_REJECTED_BENEFICIARY` - QR Code not supported by the beneficiary user `DOCUMENT_INVALID` - CPF or CNPJ rejected by the beneficiary user `ORDER_REJECTED`- Order rejected by the beneficiary’s PSP