v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Crie uma recorrência com a jornada 2

post/automatic/recurrencies/journey2

Request body

locationIdinteger required

Id do Location que será vinculado a cobrança

recurrencyIdstring required

Identificador da recorrência

Response

200

statusinteger
versionstring

Example response

{
  "version": "string",
  "body": {
    "recurrencyId": "RR1393589320250712ObmNYRB9dYH",
    "clientRequestId": "70db791c-f460-4656-8593-975d8cf9d055",
    "interval": {
      "start": "string",
      "end": "string",
      "frequencyType": "MONTHLY"
    },
    "status": "CREATED",
    "journeys": [
      {
        "status": "string",
        "createDate": "2025-10-20T16:32:40.190Z"
      }
    ],
    "amount": 10,
    "recurrencyMinAmount": 10,
    "creditParty": {
      "bank": "string",
      "taxId": "string",
      "name": "string",
      "branch": "string",
      "account": "string"
    },
    "debitParty": {
      "personType": "string",
      "taxId": "string",
      "bank": "string",
      "account": "string",
      "branch": "string"
    },
    "debtor": {
      "personType": "string",
      "taxId": "string",
      "name": "string"
    },
    "contract": {
      "number": "string",
      "description": "string"
    },
    "cancellation": {
      "id": "string",
      "personType": "string",
      "taxId": "string",
      "reason": "string",
      "date": "2025-10-20T16:32:40.190Z"
    },
    "createDate": "2025-07-11T22:43:39.821Z",
    "acceptanceDate": "2025-07-11T22:43:39.821Z",
    "denyDate": "2025-10-20T16:32:40.190Z",
    "updateDate": "2025-10-20T16:32:40.190Z",
    "location": {
      "merchant": {
        "postalCode": "0000000",
        "city": "Sao Paulo",
        "name": "Loja Exemplo"
      },
      "recurrencyUrl": "string",
      "url": "string",
      "emv": "string",
      "type": "string",
      "locationId": 123456789,
      "qrCodeBase64": "string"
    }
  }
}