v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Envio de agendamento

put/automatic/recurrencies/{recurrencyId}/payment-instruction/{endToEndId}

Path parameters

recurrencyIdstring required

Identificador único da recorrência

endToEndIdstring required

Identificador único da instrução de pagamento

Request body

clientRequestIdstring required

ID unico de identificação do cliente

amountnumber double required

Valor da cobrança

changeToNextWorkingDayboolean required

Indica se é para ser cobrado no próximo dia útil, caso a data caia em um final de semana.

Response

200

versionstring

statusinteger

Example response

{
  "version": "1.0.0",
  "status": 200,
  "body": {
    "id": "asdfgfsdew",
    "endToEndId": "E139358932025060789659528960",
    "recurrencyId": "RR139358932025060758317314721",
    "amount": 100,
    "status": "PENDING_SENDING_DEBTOR",
    "expirationDate": "2025-06-07",
    "creditParty": {
      "bank": "13935893",
      "branch": "10203040",
      "account": "98765-4",
      "taxId": "76008951000179",
      "name": "Empresa Fictícia"
    },
    "debtor": {
      "personType": "NATURAL_PERSON",
      "taxId": "00011122233",
      "name": "Pessoa Fictícia"
    },
    "debitParty": {
      "bank": "10203040",
      "personType": "NATURAL_PERSON",
      "taxId": "00011122233",
      "accountType": "CACC",
      "branch": "10203040",
      "account": "98765-4",
      "stateCode": "3505708"
    },
    "createDate": "2025-06-07",
    "clientRequestId": 123423432
  }
}