CEcelcoin

Consulta uma instrução de pagamento

get/automatic/payment-instruction

Request

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

Query parameters

recurrencyIdstring

Identificador único da recorrência

endToEndIdstring

Identificador do end to end

Response

200

statusinteger
versionstring

Example response

{
  "version": "string",
  "body": {
    "id": "string",
    "endToEndId": "string",
    "recurrencyId": "string",
    "status": "string",
    "expirationDate": "2025-11-06T17:10:40.455Z",
    "nextWorkingDay": "2025-11-06T17:10:40.455Z",
    "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:10:40.456Z",
    "updateDate": "2025-11-06T17:10:40.456Z",
    "clientRequestId": "string",
    "cancellation": {
      "id": "string",
      "cancelledBy": "string",
      "personType": "string",
      "taxId": "string",
      "reason": "string",
      "date": "2025-11-06T17:10:40.456Z"
    }
  }
}

Changes

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