Pix Key Details Endpoint

Validate Pix Keys in real time by using the Pix Key Validation Endpoint

Account Validation Request

POST https://api-stg.onekeypayments.com/v5/account/pix_key/validate/details

This endpoint allows you to validate if a Pix Key exists, and what banking details are tied to this PIX key

Check with your TAM regarding the production API endpoint.

Headers

Name	Type	Description
Content-Type*	string	application/json
X-Date*	string	ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ
X-Login*	string	Merchant X-Login Cashouts API Key
Authorization*	string	Authorization control hash

Request Body

Name	Type	Description
pix_key*	String	Contains the value of the PIX key that you want to get the details for.
type	String	Type of the PIX, this can be either document, email or phone

Example Request

{
"type": "document",
"pix_key": "29318456719"
}

Example Response

{
"bank_account": 1234567
"bank_branch": 0199
"bank_code": 33
"ispb_code": 90400888
"bank_name": "BCO SANTANDER (BRASIL) S.A."
"is_licensed": true | false
}

In this particular case, the PIX KEY DOCUMENT "29318456719" would be tied to the banking details presented in the response.