CEcelcoin

Consulta lista de instrução de pagamento

get/automatic/payment-instruction/list

Request

  • Base URL
    https://sandbox.openfinance.celcoin.dev/baas/v2
  • URL
    https://sandbox.openfinance.celcoin.dev/baas/v2/automatic/payment-instruction/list
  • Auth
    OAuth 2

Query parameters

dateFromstring required

A partir da data (formato de date)

dateTostring required

Até a data (formato de date)

recurrencyIdstring

Identificador único da recorrência

statusstring
accountstring
pageinteger
page-sizeinteger

Response

200

statusinteger
versionstring

Example response

{
  "version": "string",
  "body": {
    "hasMore": true,
    "paymentInstructions": [
      {
        "id": "string",
        "endToEndId": "string",
        "recurrencyId": "string",
        "status": "string",
        "expirationDate": "2025-11-06T17:13:38.964Z",
        "nextWorkingDay": "2025-11-06T17:13:38.964Z",
        "creditParty": {
          "bank": "string",
          "branch": "string",
          "account": "string",
          "taxId": "string",
          "name": "string"
        },
        "debitParty": {
          "bank": "string",
          "personType": "string",
          "taxId": "string",
          "accountType": "string",
          "branch": "string",
          "account": "string",
          "stateCode": "string"
        },
        "debtor": {
          "personType": "string",
          "taxId": "string",
          "name": "string"
        },
        "createDate": "2025-11-06T17:13:38.964Z",
        "updateDate": "2025-11-06T17:13:38.964Z",
        "clientRequestId": "string",
        "cancellation": {
          "id": "string",
          "cancelledBy": "string",
          "personType": "string",
          "taxId": "string",
          "reason": "string",
          "date": "2025-11-06T17:13:38.964Z"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.