---
title: "Initiate a payment"
method: POST
path: "/rest/payments/{payment-id}/init"
tags: ["Payments"]
---

# Initiate a payment

`POST /rest/payments/{payment-id}/init`

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](/reference/getpaymentinitstatus).

## Path parameters

- `payment-id` string, required — finX ID of the payment.

## Parameters

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

## Request body

- object
  - `credentials` Credentials — unresolved $ref
  - `save_secrets` boolean — 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_uri` RedirectUri — unresolved $ref
  - `state` State, required — unresolved $ref
  - `reuse_auth_method` boolean — 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_medium` boolean — 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_ip` string, 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 `201`

Payment initiation status.

- object — A handle to refer to the processing of an initiated payment.
  - `id` Schema, required — unresolved $ref
  - `status` Status, required — unresolved $ref
  - `state` string — The `state` that was being provided in the request when initiating the payment.
  - `challenge` Schema — unresolved $ref
  - `error` Error — unresolved $ref
  - `created_at` EndedAt, required — unresolved $ref
  - `started_at` EndedAt — unresolved $ref
  - `ended_at` EndedAt — unresolved $ref

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref
- `404` — unresolved $ref

---

[API](https://skmtc.net/qwist/apis/finx-api.md) · [All operations](https://skmtc.net/qwist/apis/finx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/qwist/finx-api/revisions/b75f5c1aa39e/schema)