Initiate a payment

Initiate a payment by submitting it to the payment service provider. The payment initiation is executed as an asynchronous background operation. The state of this operation can be monitored polling the initiation status.

post/rest/payments/{payment-id}/init

Path parameters

payment-idstring required

finX ID of the payment.

Example:P12345.6

Parameters

#/paths/~1auth~1user/post/parameters/0 — unresolved $ref

Request body

credentialsCredentials — unresolved $ref

save_secretsboolean

Indicates whether the confidential parts of the credentials should be saved for future payment operations. If set to false previously saved secrets are discarded at the end of the payment operation. This can only be used if the payment is initiated with user_auth.

redirect_uriRedirectUri — unresolved $ref

stateState required— unresolved $ref

reuse_auth_methodboolean

Indicates whether the last selected authentication method should be re-used for this payment initiation. This minimizes the amount of challenges that have to be solved in the course of the payment initiation.

reuse_auth_mediumboolean

Indicates whether the last selected authentication medium should be re-used for this payment initiation. This minimizes the amount of challenges that have to be solved in the course of the payment initiation.

psu_ipstring IP

The IP address of the end-user for whom the payment is initiated. This might be required by the provider. It is advised to provide this value whenever possible.

Response

Payment initiation status.

idSchema required— unresolved $ref

statusStatus required— unresolved $ref

statestring

The state that was being provided in the request when initiating the payment.

challengeSchema — unresolved $ref

errorError — unresolved $ref

created_atEndedAt required— unresolved $ref

started_atEndedAt — unresolved $ref

ended_atEndedAt — unresolved $ref