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

Listar pagamentos de pré-autorização

Recupera todos os pagamentos de uma pré-autorização específica, ordenados por data em ordem decrescente

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	Identificador primário de pré-autorização

Query Parameters

Name	Type	Description
`from`	string (date)	Filtrar pagamentos criados a partir desta data
`to`	string (date)	Filtrar pagamentos criados até esta data
`pageSize`	number (double)	Tamanho da página para a solicitação de paginação, padrão: 500
`page`	number (double)	Número da página para a solicitação de paginação, padrão: 1

Responses

200Recupere uma lista de todos os pagamentos para a pré-autorização

object

pagenumber (double)

totalnumber (double)

totalPagesnumber (double)

resultsobject[]

List of payments

itemsobject

Smart transfer payment

Example response

json

{
  "page": 0,
  "total": 0,
  "totalPages": 0,
  "results": [
    {
      "id": "string",
      "preauthorizationId": "string",
      "status": "CONSENT_AUTHORIZED",
      "amount": 0,
      "description": "string",
      "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"
      },
      "clientPaymentId": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "errorDetail": {
        "code": "INFRASTRUCTURE_FAILURE",
        "description": "string",
        "detail": "string"
      }
    }
  ]
}

curl -X GET \
  'https://api.pluggy.ai/smart-transfers/preauthorizations/{id}/payments' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Resposta de exemplo

{
  "page": 0,
  "total": 0,
  "totalPages": 0,
  "results": [
    {
      "id": "string",
      "preauthorizationId": "string",
      "status": "CONSENT_AUTHORIZED",
      "amount": 0,
      "description": "string",
      "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"
      },
      "clientPaymentId": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "errorDetail": {
        "code": "INFRASTRUCTURE_FAILURE",
        "description": "string",
        "detail": "string"
      }
    }
  ]
}