Pix Key Validation and Details Endpoint
Validate PIX Keys in real time, with their full banking details.
Last updated
Validate PIX Keys in real time, with their full banking details.
Last updated
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.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Example Request
Response
Callback
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:
In this case, the PIX KEY DOCUMENT "29318456719" would be tied to the banking details in the response.
API Messages
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
key_type*
String
Type of the PIX, this can be either DOCUMENT
, EMAIL
, PHONE
or RANDOM_ID
document*
String
CPF of the customer.
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.
status
Message
Description
IN_PROGRESS
The Pix validation is in progress
The PIX Key exists and we are validating the bank account details
ERROR
The Pix key does not belong to the document
The account associated to PIX Key sent does not belong to the document sent in the request.
ERROR
The Pix Key is invalid
The PIX Key does not exist or itβs greylisted.