v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Smart Transfer

List preauthorization payments

Recovers all payments for a specific preauthorization, ordered by date descending

get/smart-transfers/preauthorizations/{id}/payments

Path parameters

idstring uuid required

Preauthorization primary identifier

Query parameters

fromstring date

Filter payments created from this date

tostring date

Filter payments created until this date

pageSizenumber double

Page size for the paging request, default: 500

pagenumber double

Page number for the paging request, default: 1

Response

Retrieve a list of all payments for the preauthorization

pagenumber double
totalnumber double
totalPagesnumber double

Example response

{
  "results": [
    {
      "recipient": {
        "type": "BANK_ACCOUNT",
        "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
        "name": "Conta empresa",
        "taxNumber": "12345678900",
        "paymentInstitution": {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Banco J. Safra S.A.",
          "ispb": "03017677",
          "tradeName": "Banco Safra",
          "compe": "074",
          "createdAt": "2020-04-21T15:00:00.000Z",
          "updatedAt": "2020-04-21T15:00:00.000Z"
        },
        "account": {
          "branch": "0001",
          "number": "123456",
          "type": "CHECKING_ACCOUNT"
        },
        "isDefault": false,
        "pixKey": null,
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-15T10:30:00.000Z"
      }
    }
  ]
}