Creates an ITP journey session for enrollment.

post

https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/enrollments/journeys-sessions

Method for creating an ITP journey session for enrollment purposes. To choose the journey, the ID of a journey must be passed. The available journeys can be checked by the endpoint GET /baas/v1/open/itp/payments/journeys-sessions/{id}.

Body Params

journeyId

string

required

length between 0 and 36

Defaults to default

O id é o identificador único da jornada

redirectUrl

uri

length between 0 and 999999

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

brandId

string

length between 0 and 36

O id é o identificador único da brand

externalId

string

length between 0 and 36

O id é o identificador único da jornada

expirationDateTime

string

length between 0 and 20

        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).

tags

string

length between 0 and 999999

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

webhookHeaders

string

length between 0 and 999999

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

settings

array of objects

Lista de configurações da sessão da jornada

settings

paymentInitiationData

object

required

Responses

403

          O código de resposta de status de erro do cliente HTTP 403 Forbidden indica que o servidor entendeu o pedido, mas se recusa a autorizá-lo. 

          Esse status é semelhante ao 401 , mas neste caso, a re-autenticação não fará diferença. O acesso é permanentemente proibido e vinculado à lógica da aplicação (como uma senha incorreta).

200The enrollment journey session was successfully created. You can use the journeySessionUrl property to open the journey for the user.

401O cliente deve se autenticar.

409O status de resposta 409 Conflict indica que a solicitação atual conflitou com o recurso que está no servidor.

422Campos inválidos

500Erro do servidor: 500 a 599.

defaultErro inesperado.