Criar Reivindicação
Esse endpoint tem como finalidade criar o processo de reivindicação.
Request
POST /api/v1/pix/:account_id/entry_claims
Headers
x-stone-idempotency-key string
Chave de idempotência
Body params
pix_entry_id UUID (obrigatório)
Identificador da chave Pix cuja criação resultou em falha.
participant_ispb string (obrigatório)
Identificador da instituição.
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”
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
Exemplo:
{
"pix_entry_id": "390d7eda-e948-4552-bcdf-886c62e5923b",
"participant_ispb": "16501555"
}
Response
202 Accepted
Sucesso na criação da reivindicação de posse/portabilidade
Body
{
"id": "390d7eda-e948-4552-bcdf-886c62e5923b",
"claim_type": "ownership" | "portability"
}
401 Unauthenticated
Usuário não autenticado
Body
{
"type": "srn:error:unauthenticated"
}
422 Unprocessable Entity
Chave não encotrada ou com status diferente de failed
Body
{
"type": "srn:error:entry_not_found"
}
422 Unprocessable Entity
Reivindicação não é possível
Body
{
"type": "claim_type_not_available"
}