Pix Key Validation and Details Endpoint

Validate PIX Keys in real time, with their full banking details.

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 Account Manager or Technical Account Manager 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
key_type*	String	Type of the PIX, this can be either DOCUMENT, EMAIL , PHONE or RANDOM_ID
pix_key*	String	Contains the value of the PIX key that you want to get the details for.
notification_url*	String	API URL utilized to receive the banking information from your side.

Example Request

{
"key_type": "DOCUMENT",
"pix_key": "29318456719",
"notification_url": "https://test.com"
}

This request would only give an HTTP 200 response if successful, or an HTTP 400 response in case something is wrong, the response comes with an empty body.

Account Details After obtaining the HTTP 200 response, we'll send a callback to your previously designated notification_url, this will include all the following banking information, tied to the Pix key:

{
"key_type": "DOCUMENT",
"pix_key": "29318456719",
"bank_account": 1234567,
"bank_branch": 0199,
"bank_code": 33,
"ispb_code": 90400888,
"account_type": "SAVINGS",
"bank_name": "BCO SANTANDER (BRASIL) S.A.",
"is_licensed": true | false
}

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