v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Criar recorrência de pagamento

post/payments-recurrences

Request body

type'PAYMENT' | 'PIX_AUTOMATIC' required

Tipo do pagamento recorrente a ser criado

recurringPaymentDatesstring[]

Example request

{
  "periodicity": {
    "detail": {
      "startDate": "2024-10-09",
      "quantity": 10
    }
  },
  "basePayment": {
    "debitParty": {
      "account": {
        "ispb": "30306294"
      }
    },
    "detail": {
      "creditParty": {
        "account": {
          "ispb": "30306294"
        }
      }
    }
  },
  "recurringPaymentDates": [
    "2024-09-10"
  ]
}

Response

Successful

operationNeedsApprovalboolean

contractGuidstring

recurrenceIdstring

Example response

{
  "operationNeedsApproval": true,
  "contractGuid": "13287d0e-23c8-4d31-8cc7-989a3aaa6e16",
  "recurrenceId": "35455c30-49eb-4143-ac69-1887be87de78"
}