Cadastrar chave

Sandbox

https://horizon-api-sb.app.rpe.tech

POST

/api/v1/pixcard/chave

Use este endpoint para cadastrar uma chave a ser associada a uma conta específica (idAccount).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢201Criado

application/json

Created

Body

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/chave' \
--header 'Accept: */*' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idAccount": 1634554,
    "keyType": "email",
    "key": "[email protected]",
    "description": "Unique example id 19021"
}'

Response Example

201 - Example 1

{
    "idAccount": 2001,
    "bankAccountNumber": "0023432",
    "bankBranchNumber": "0023",
    "bankAccountType": "CC",
    "ispb": "12345678",
    "beneficiaryType": "F",
    "nationalRegistration": "45967703045",
    "name": "Maria Sousa",
    "tradeName": "M Souza LTDA",
    "keyType": "nationalRegistration",
    "key": "[email protected]",
    "dateKeyCreated": "2024-12-02",
    "dateKeyOwnership": "2024-12-02",
    "description": "Email",
    "keyStatus": "OPEN"
}