QWqwist
Payments

Initiate a payment

Changed on

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

Request

Path parameters

payment-idstring required

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

Changes

  • 398592d93b1fRevision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property type changed from no type to string, and format from no format to url

    • breaking

      the request property type changed from no type to string

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to string, and format from no format to UUID for status

    • warning

      the request property's maxLength was set to 1024

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status