Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Gerenciamento de Aplicação

Criar sessão de jornada de pagamento

Cria uma nova sessão de jornada de pagamento para fins de teste. Isso inicia um fluxo de pagamento que pode ser usado para simular interações de usuários finais com o sistema de pagamento. Suporta fluxos de pagamento padrão e redirecionamentos de inscrição.

post/open-keys/itp/api/v2/applications/{applicationId}/journeys/{journeyId}/sessions

Path parameters

applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

journeyIdstring required

O id é o identificador único da jornada

Request body

redirectUrlstring uri

O endereço de redirecionamento para a jornada, após o fluxo da jornada. Precisa ser um dos cadastrados na aplicação.

brandIdstring

O id é o identificador único da brand

externalIdstring

O id é o identificador único da jornada

expirationDateTimestring
        Data e hora em que a jornada deve deixar de ser válido. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
tagsstring

Tags que podem ser usadas para classificar a sessão da jornada.

webhookHeadersstring

Headers que podem ser usadas para classificar a sessão da jornada.

Example request

{
  "redirectUrl": "http://localhost:8080/callback",
  "externalId": "8cbe7dfb-40d6-4a42-9e8b-d9df88ca55f5",
  "expirationDateTime": "2021-05-21T08:30:00Z",
  "settings": [
    {
      "key": "PRIORITIES_BRANDS"
    }
  ],
  "paymentInitiationData": {
    "loggedUser": {
      "document": {
        "identification": "11122233344",
        "rel": "CPF"
      }
    },
    "businessEntity": {
      "document": {
        "identification": "00000000000191",
        "rel": "CNPJ"
      }
    },
    "creditor": {
      "cpfCnpj": "58764789000137",
      "personType": "PESSOA_JURIDICA",
      "name": "Marco Antonio de Brito"
    },
    "payment": {
      "type": "PIX",
      "schedule": {
        "single": {
          "date": "2023-08-23"
        },
        "daily": {
          "startDate": "2023-08-23"
        },
        "weekly": {
          "dayOfWeek": "QUINTA_FEIRA",
          "startDate": "2023-08-23"
        },
        "monthly": {
          "startDate": "2023-08-23"
        },
        "custom": {
          "additionalInformation": "Todas quintas e domingos por 6 meses"
        }
      },
      "date": "2024-03-05",
      "currency": "BRL",
      "amount": "1.12",
      "ibgeTownCode": "5300108",
      "details": {
        "localInstrument": "DICT",
        "qrCode": "\n\t\t\t\t\t\t  00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\n\t\t\t\t\t\t  BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n\t\t\t\t\t\t  530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\n\t\t\t\t\t\t  CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76",
        "proxy": "12345678901",
        "creditorAccount": {
          "accountType": "CACC",
          "ispb": "12345678",
          "issuer": "1774",
          "number": "1234567890"
        }
      }
    },
    "debtorAccount": {
      "accountType": "CACC",
      "ispb": "12345678",
      "issuer": "1774",
      "number": "1234567890"
    },
    "remittanceInformation": "Pagamento da nota XPTO035-002"
  }
}

Response

Sessão de jornada criada com sucesso.

idstring required

O id é o identificador único da jornada

createdAtstring required
updatedAtstring required
deletedAtstring required
journeyIdstring required

O id é o identificador único da jornada

redirectUrlstring uri

O endereço de redirecionamento para a jornada, após o fluxo da jornada. Precisa ser um dos cadastrados na aplicação.

brandIdstring

O id é o identificador único da brand

externalIdstring

O id é o identificador único da jornada

expirationDateTimestring
        Data e hora em que a jornada deve deixar de ser válido. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
tagsstring

Tags que podem ser usadas para classificar a sessão da jornada.

webhookHeadersstring

Headers que podem ser usadas para classificar a sessão da jornada.

applicationClientIdstring required

O clientId da aplicação.

applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

tokenIdstring required

O ID do token. É um número exclusivo que identifica o token.

journeySessionUrlstring uri required

A url da sessão da jornada que deve ser aberta para o usuário.

status'PENDING' | 'CANCELLED' | 'EXPIRED' | 'AWAITING_AUTHORISATION' | 'AWAITING_AUTHORISATION_ACTION' | 'AUTHORISED' | 'CONSUMED' | 'REJECTED' | 'FINISHED' required

Status da sessão da jornada.

journeySessionStageIdstring

O id é o identificador único do estágio da sessão da jornada

paymentInitiationIdstring

O id é o identificador único do ITP

paymentInitiationApi'PAYMENTS_V4' required

Example response

{
  "id": "f362a873-c127-4122-b711-a37b24a36914",
  "createdAt": "2024-01-01T20:32:44.581Z",
  "updatedAt": "2024-01-01T20:32:44.581Z",
  "deletedAt": "2024-01-01T20:32:44.581Z",
  "redirectUrl": "http://localhost:8080/callback",
  "externalId": "8cbe7dfb-40d6-4a42-9e8b-d9df88ca55f5",
  "expirationDateTime": "2021-05-21T08:30:00Z",
  "settings": [
    {
      "key": "PRIORITIES_BRANDS"
    }
  ],
  "applicationClientId": "f362a873-c127-4122-b711-a37b24a36914",
  "applicationId": "f362a873-c127-4122-b711-a37b24a36914",
  "tokenId": "f362a873-c127-4122-b711-a37b24a36914",
  "token": {
    "id": "f362a873-c127-4122-b711-a37b24a36914",
    "createdAt": "2024-01-01T20:32:44.581Z",
    "updatedAt": "2024-01-01T20:32:44.581Z",
    "deletedAt": "2024-01-01T20:32:44.581Z",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2NWYyMjQ2MWY2ZTAxZDg5N2NkMTQ2Y2UiLCJpc3MiOiJvcGVuLWtleXMtaXRwLXYyIiwiYXpwIjoib3BlbmtleXNfNGE4M2ZkOTEtMWQ2Zi00ZTg2LTg0NDUtYWU1NWNkYjg4YjNkIiwic2NvcGUiOiJqb3VybmV5IiwiaWF0IjoxNzEwMzY3ODQxLCJleHAiOjIwNzA0Mjc4NDF9.VMobGtPbjCzwdL8HN2_26l-b4wg3Ci0P_K-TRpshiPY"
  },
  "journeySessionUrl": "http://localhost:9000?journeyId={journeyId}&id={id}&token={token}",
  "status": "PENDING",
  "statusHistory": [
    {
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "status": "PENDING"
    }
  ],
  "journeySessionStageId": "f362a873-c127-4122-b711-a37b24a36914",
  "journeySessionStage": {
    "id": "f362a873-c127-4122-b711-a37b24a36914",
    "logs": [
      {
        "createdAt": "2024-01-01T20:32:44.581Z"
      }
    ]
  },
  "paymentInitiationId": "f362a873-c127-4122-b711-a37b24a36914",
  "paymentInitiationApi": "PAYMENTS_V4",
  "paymentInitiation": {
    "paymentInitiationApi": "PAYMENTS_V4",
    "createdAt": "2024-01-01T20:32:44.581Z",
    "updatedAt": "2024-01-01T20:32:44.581Z",
    "deletedAt": "2024-01-01T20:32:44.581Z",
    "journeySessionId": "f362a873-c127-4122-b711-a37b24a36914",
    "redirectUrl": "https://example.com",
    "enrollment": {
      "platform": "ANDROID"
    },
    "data": {
      "loggedUser": {
        "document": {
          "identification": "11122233344",
          "rel": "CPF"
        }
      },
      "businessEntity": {
        "document": {
          "identification": "00000000000191",
          "rel": "CNPJ"
        }
      },
      "creditor": {
        "cpfCnpj": "12345678000199",
        "personType": "PESSOA_JURIDICA",
        "name": "João da Silva Santos"
      },
      "payment": {
        "type": "PIX",
        "schedule": {
          "single": {
            "date": "2023-08-23"
          },
          "daily": {
            "startDate": "2023-08-23"
          },
          "weekly": {
            "dayOfWeek": "QUINTA_FEIRA",
            "startDate": "2023-08-23"
          },
          "monthly": {
            "startDate": "2023-08-23"
          },
          "custom": {
            "additionalInformation": "Todas quintas e domingos por 6 meses"
          }
        },
        "date": "2024-03-05",
        "currency": "BRL",
        "amount": "1.12",
        "ibgeTownCode": "5300108",
        "details": {
          "localInstrument": "DICT",
          "qrCode": "\n\t\t\t\t\t\t  00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\n\t\t\t\t\t\t  BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n\t\t\t\t\t\t  530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\n\t\t\t\t\t\t  CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76",
          "proxy": "11223344556",
          "creditorAccount": {
            "accountType": "CACC",
            "ispb": "00000000",
            "issuer": "0001",
            "number": "0001234567"
          }
        }
      },
      "debtorAccount": {
        "accountType": "CACC",
        "ispb": "00000000",
        "issuer": "0001",
        "number": "0001234567"
      },
      "remittanceInformation": "Pagamento da nota XPTO035-002"
    },
    "journeySession": {
      "createdAt": "2024-01-01T20:32:44.581Z",
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "deletedAt": "2024-01-01T20:32:44.581Z",
      "settings": [
        {
          "key": "JOURNEY_RULES"
        }
      ]
    },
    "authorizationUrl": "https://example.com",
    "ofConsent": {
      "authorization_url": "https://example.com",
      "status": "AWAITING_AUTHORISATION",
      "organizationLogo": "https://example.com",
      "redirect_uri": "https://example.com",
      "consentTerm": 0.123,
      "creditor": {
        "cpfCnpj": "12345678000199",
        "personType": "PESSOA_JURIDICA",
        "name": "João da Silva Santos"
      },
      "loggedUser": {
        "document": {
          "identification": "11122233344",
          "rel": "CPF"
        }
      },
      "payment": {
        "type": "PIX",
        "date": "2025-08-05",
        "currency": "BRL",
        "amount": "10.00",
        "details": {
          "localInstrument": "DICT",
          "proxy": "usuario@ficticio.com",
          "creditorAccount": {
            "ispb": "00000000",
            "issuer": "0001",
            "number": "0001234567",
            "accountType": "CACC"
          }
        }
      },
      "rejectionReason": {
        "code": "TEMPO_EXPIRADO_AUTORIZACAO"
      }
    },
    "ofPayments": [
      {
        "localInstrument": "DICT",
        "payment": {
          "currency": "BRL",
          "amount": "1.00"
        },
        "creditorAccount": {
          "number": "1234567890",
          "accountType": "CACC",
          "ispb": "12345678",
          "issuer": "1774"
        },
        "cnpjInitiator": "13935893000109",
        "proxy": "cliente-a00001@pix.bcb.gov.br",
        "endToEndId": "E13935893202511021042TKe1h8bM2FO",
        "authorisationFlow": "FIDO_FLOW",
        "creationDateTime": "2025-11-13T21:41:49Z",
        "debtorAccount": {
          "ispb": "12345678",
          "issuer": "0001",
          "number": "969139",
          "accountType": "CACC"
        },
        "paymentId": "9917ab8f-e134-490b-b2b5-59ecd4e0abd0",
        "status": "ACSC",
        "statusUpdateDateTime": "2025-11-13T21:41:56Z"
      }
    ],
    "httpCalls": [
      {
        "response": {
          "status": "200",
          "statusText": "OK"
        },
        "createdAt": "2024-01-01T20:32:44.581Z",
        "updatedAt": "2024-01-01T20:32:44.581Z",
        "deletedAt": "2024-01-01T20:32:44.581Z"
      }
    ]
  }
}