Get Client Remittances

Get Client Remittances

GET {{Environment_URL}}/v2/remittances/?page=1&limit=4

This endpoint is responsible to return all information of a remittance made by a logged user with an authorized client.

Obs: This route allows to pagination and filter by status or id.

Output Params	Description
id	Unique id for the remittance
offer	national currency value
total	Foreign currency value
purposeCode	Modality type identifier the quotation is generated it can be IR001 (availability) or IR002 (maintenance)
currencyCode	USD for dollar or EUR for euro
createdAt	Remittance registration date in UTC z
correspondentId	The ID of the correspondent
name	Client name
email	Client email
cpf	Client CPF
status	Status

Status

Output Params	Description
key	Status key of the remittance
label	Label for the status key

Headers

Name	Value	Description
Authorization	Bearer <token>	Bearer Token obtained via sign-in
client-key	123ABCD456	Client authentication key

Response

200 - Success

{
  "docs": [
    {
      "id": "68d29e6637495f00306f3c2b",
      "type": "OUTBOUND",
      "offer": 200,
      "total": 1273.12,
      "purposeCode": "SERVICES",
      "subType": "SERVICES",
      "status": {
        "key": "PROCESSING",
        "label": "Processando"
      },
      "currencyCode": "USD",
      "createdAt": "2025-09-23T13:19:35.013Z",
      "correspondentId": 163,
      "name": "John Doe",
      "email": "[email protected]",
      "cpf": "111.222.333-44",
      "smilesAccrual": {}
    },
    {
      "id": "68d29e5537495f00306f3c29",
      "type": "OUTBOUND",
      "offer": 200,
      "total": 1273.12,
      "purposeCode": "SERVICES",
      "subType": "SERVICES",
      "status": {
        "key": "PROCESSING",
        "label": "Processando"
      },
      "currencyCode": "USD",
      "createdAt": "2025-09-23T13:19:17.222Z",
      "correspondentId": 163,
      "name": "John Doe",
      "email": "[email protected]",
      "cpf": "111.222.333-44",
      "smilesAccrual": {}
    },
    {
      "id": "68d29e1f37495f00306f3c27",
      "type": "OUTBOUND",
      "offer": 200,
      "total": 1273.12,
      "purposeCode": "SERVICES",
      "subType": "SERVICES",
      "status": {
        "key": "PROCESSING",
        "label": "Processando"
      },
      "currencyCode": "USD",
      "createdAt": "2025-09-23T13:18:23.765Z",
      "correspondentId": 163,
      "name": "John Doe",
      "email": "[email protected]",
      "cpf": "111.222.333-44",
      "smilesAccrual": {}
    },
    {
      "id": "68d29dd637495f00306f3c25",
      "type": "OUTBOUND",
      "offer": 200,
      "total": 1273.12,
      "purposeCode": "SERVICES",
      "subType": "SERVICES",
      "status": {
        "key": "PROCESSING",
        "label": "Processando"
      },
      "currencyCode": "USD",
      "createdAt": "2025-09-23T13:17:10.722Z",
      "correspondentId": 163,
      "name": "John Doe",
      "email": "[email protected]",
      "cpf": "111.222.333-44",
      "smilesAccrual": {}
    }
  ]
}