Atualizar chaves Pix
POST https://sandbox-api.openbank.stone.com.br/api/v1/pix/{{account_id}}/entries/{{entry_id}}
Este endpoint permite que um participante indireto realize a atualização dos dados de uma chave Pix.
Somente chaves com status key_created (que estejam em posse do dono da conta) podem ser atualizadas.
Os seguintes campos podem ser atualizados:
- branch_code
- account_code
- account_type
- created_at
- name
- legal_name
HEADERS
x-stone-idempotency-key string
Chave de idempotência
authorization string
Bearer Token
User-Agent string
Nome da sua aplicacão
PATH PARAMS
account_id string
Identificador da conta
Format: UUID
entry_id string
Identificador da chave Pix a ser atualizada
Format: UUID
BODY PARAMS
participant_ispb string
ISPB do Participante Indireto
reason string
Valores permitidos: branch_transfer ou user_requested
beneficiary_entity object
name string
Nome
legal_name string
É o nome que identifica o pagador para fins legais, administrativos e outros fins oficiais
document string
Número do documento (CPF/CNPJ)
document_type string
Valores permitidos: cpf, cnpj
beneficiary_account object
account_code string
Número da conta
branch_code string
Agência
Format: ^\d{4}$
account_type string
Tipo da conta.
Valores permitidos: CC, CS, PP ou PG
created_at datetime
Data de criação da conta.
Format: ISO8601 - “YYYY-MM-DDThh:mm:ssZ”
- Para atualizar uma chave aleatória
{
"id": "fa4c35c2-a181-11ec-b909-0242ac120002",
"participant_ispb": "16501555",
"beneficiary_account": {
"account_code": "123456",
"branch_code": "0001",
"account_type": "PG",
"created_at": "2021-01-01T01:30:00Z"
},
"beneficiary_entity": {
"legal_name": "John Doe SA",
"name": "John Doe",
"document": "44015829000133",
"document_type": "cnpj"
}
}
Responses
202 ACCEPTED
content-type: application/json
Body
{
"id": "fa4c35c2-a181-11ec-b909-0242ac120002"
}
400 BAD REQUEST
422 DOMAIN ERROR
Body
{
"type": "srn:error:already_updated"
}
Acontece quando a chave já está atualizada com base nos parâmetros enviados
Body
{
"type": "srn:error:already_updated"
}
Acontece quando a chave está com um status diferente de key_created.