v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Crie uma recorrência jornada 3

Jornada de autorização com pagamento imediato.

post/automatic/collection/immediate

Request body

keystring required

clientRequestIdstring required

payerQuestionstring

locationIdinteger required

Response

200

revisioninteger

transactionIdinteger

clientRequestIdstring

statusstring

{"stackTrail":"paths:/automatic/collection/immediate:post:responses:200:content:application/json:schema:properties:lastUpdate","oasType":"schema","type":"unknown"}

payerQuestionstring

{"stackTrail":"paths:/automatic/collection/immediate:post:responses:200:content:application/json:schema:properties:additionalInformation","oasType":"schema","type":"unknown"}

keystring

createAtstring

transactionIdentificationstring

Example response

{
  "transactionId": 4000278856,
  "clientRequestId": "ada22f39-e08e-4d0a-8d28-e60712d58a40",
  "status": "ACTIVE",
  "payerQuestion": "Não pagável após vencimento.",
  "debtor": {
    "name": "Fulano de Tal",
    "cpf": "11122233366"
  },
  "amount": {
    "original": 1
  },
  "location": {
    "merchant": {
      "postalCode": "06416230",
      "city": "barueri",
      "merchantCategoryCode": 5651,
      "name": "Teste testando"
    },
    "url": "qrcode-h.pix.celcoin.com.br/pixqrcode/v2/2be72fb3d9334070b91c48452a9ef1",
    "emv": "00020101021226930014br.gov.bcb.pix2571qrcode-h.pix.celcoin.com.br/pixqrcode/v2/2be72fb3d9334070b91c48452a9ef15204000053039865802BR5914Teste testando6007barueri62070503***6304614C",
    "type": "COB",
    "locationId": "4000928432",
    "id": "6867a36a03213cd507d1ac0a"
  },
  "key": "testepix@celcoin.com.br",
  "calendar": {
    "expiration": 8600
  },
  "createAt": "2025-07-04T09:48:26.9104112+00:00",
  "transactionIdentification": "kk6g232xel65a0daee4dd13kk4000278856",
  "recurrency": {
    "recurrencyId": "RR139358932025060747690230748",
    "clientRequestId": "4e867ad5-0cea-408f-b4cc-b93f527c642a",
    "interval": {
      "start": "2025-07-07T00:00:00",
      "frequencyType": "WEEKLY"
    },
    "status": "CREATED",
    "journeys": [
      {
        "status": "PENDING",
        "type": 3,
        "createDate": "2025-06-07T09:45:00-03:00"
      }
    ],
    "amount": 299.9,
    "creditParty": {
      "bank": "13935893",
      "branch": "1234",
      "account": "1234567",
      "taxId": "01234567000189",
      "name": "Comércio Digital Ltda."
    },
    "debtor": {
      "personType": "LEGAL_PERSON",
      "taxId": "09876543000121",
      "name": "Pague Tudo Serviços S.A."
    },
    "contract": {
      "number": "CONTRATO-2025-ABCD",
      "description": "null"
    },
    "allowsNewAttemptsAfterExpiration": true,
    "createDate": "2025-06-07T09:45:00-03:00",
    "allowAutoSendingPaymentInstructions": true
  }
}