Consultar chave Pix
DevelopingGET
/v1/pix/consult/{key}Consulta das informações referentes a uma chave Pix.
Request
Parâmetros Path
key
string
requerido
Chave pix a ser consultada
Exemplo:
+5543999999999
Respostas
Success(200)
Bad Request(400)
Unauthorized(401)
HTTP Code: 200
Content Type : JSONapplication/json
Esquema de Dados
success
boolean
requerido
pix_key
object
requerido
paymentInitiationId
string
requerido
accountId
string
requerido
partnerId
string
requerido
createdAt
string
requerido
keyOwnershipDate
string
requerido
entryId
string
requerido
key
string
requerido
type
string
requerido
account
object
requerido
owner
object
requerido
expiresAt
string
requerido
entryResponseOrigin
string
requerido
Exemplo
{
"success": true,
"pix_key": {
"paymentInitiationId": "string",
"accountId": "string",
"partnerId": "string",
"createdAt": "string",
"keyOwnershipDate": "string",
"entryId": "string",
"key": "string",
"type": "string",
"account": {
"ispb": "string",
"branch": "string",
"number": "string",
"type": "string",
"id": "string",
"code": "string",
"name": "string",
"created_at": "string",
"updated_at": "string"
},
"owner": {
"type": "string",
"document": "string",
"name": "string",
"tradeName": "string"
},
"expiresAt": "string",
"entryResponseOrigin": "string"
}
}
Modificado em 3 months ago