v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Aceita uma recorrência Jornada 3

post/automatic/pix/payment

Request body

amountnumber double required

Valor da recorrência

clientCodestring required

debitPartyobject required

endToEndIdstring required

initiationTypestring required

Tipo de QR Code

transactionIdentificationstring required

paymentType'IMMEDIATE' | 'DUE_DATE' required

urgencystring required

transactionTypestring required

recurrencyAcceptboolean required

recurrencyobject required

Response

200

statusstring

versionstring

Example response

{
  "status": "PROCESSING",
  "version": "1.0.0",
  "body": {
    "id": "81c83a3e-728e-48e5-a8b9-3459d1cb1c79",
    "amount": 584.71,
    "clientCode": "bb877108-657a-4c39-aec6-e836a9cc25af",
    "transactionIdentification": "6200770704454492b187705eba48de68",
    "endToEndId": "E139358932025071818222NYE7gQVL3C",
    "initiationType": "DYNAMIC_QRCODE",
    "paymentType": "IMMEDIATE",
    "urgency": "HIGH",
    "transactionType": "TRANSFER",
    "debitParty": {
      "account": "4171740",
      "branch": "0001",
      "taxId": "46128231845",
      "name": "Blanca Fritsch",
      "accountType": "TRAN"
    },
    "creditParty": {
      "bank": "99999918",
      "key": "f4c6089a-bfde-4c00-a2d9-9eaa584b0219",
      "account": "121212",
      "branch": "1235",
      "taxId": "99999918999924",
      "name": "teste",
      "accountType": "TRAN"
    },
    "recurrencyAccept": true,
    "recurrency": {
      "journeyType": 3,
      "interval": {
        "start": "2025-07-18T00:00:00",
        "frequencyType": "MONTHLY"
      },
      "recurrencyAmountType": "FIXED",
      "amount": 321.52,
      "creditParty": {
        "taxId": "99999918999924",
        "name": "Pix Tester 918",
        "bank": "99999918"
      },
      "debitParty": {
        "name": "Blanca Fritsch",
        "taxId": "46128231845",
        "bank": "13935893",
        "branch": "0001",
        "account": "4171740",
        "accountType": "CACC",
        "stateCode": "0"
      },
      "debtor": {
        "taxId": "13935893000109",
        "name": "INTEGRATED SOLUTIONS TO BUSINE"
      },
      "contract": {
        "number": "85092252",
        "description": "Serviço de Segurança"
      }
    }
  }
}