Listagem de Reivindicação

Esse endpoint tem como finalidade listar todas as reivindicações do usuário.

Request

GET /api/v1/pix/:account_id/entry_claims

Query Params

"status"
"key"
"direction"
"limit"
"after"
"before"

status array string Valores permitidos: open, waiting_resolution, confirmed , cancelled ou completed

key string
Chave Pix

direction string
Valores permitidos: outbound, inbound

before string
Cursor opaco da paginação.

after string
Cursor opaco da paginação.

limit integer
Limite de itens retornados.

Response

200 OK

Body

{
  "cursor": {"after": null, "before": null, "limit": 25},
  "data": [
   
    {
      "id": "uuid",
      "claim_type": "ownership" | "portability",
      "account_id": "uuid",
      "status": "String",
      "direction": "outbound" | "inbound",
      "donor_participant_ispb": "String",
      "claimer_participant_ispb": "String",
      "created_at": "Datetime",
      "updated_at": "Datetime",
      "expires_at": "Datetime",
      "completion_period_ends_at": "Datetime",
      "resolution_period_ends_at": "Datetime",
      "beneficiary_account": {
        "branch_code": "String",
        "account_code": "String",
        "account_type":"String",
        "opened_at": "Datetime"
      },
      "beneficiary_entity": {
        "name": "String",
        "document_type": "String",
        "document": "String",
      },
      "key_type": "String",
      "key": "String"
    }
  ]
}

401 Unauthenticated

Usuário não autenticado
Body

{  
    "type": "srn:error:unauthenticated"
}

Última modificação: 23.11.2022