---
title: "Get payment status."
method: GET
path: "/v1/payments/{paymentId}/status"
tags: ["Payments"]
---

# Get payment status.

`GET /v1/payments/{paymentId}/status`

## Request

- Base URL: `https://oas.finshark.io/api.finshark.io`
- URL: `https://oas.finshark.io/api.finshark.io/v1/payments/{paymentId}/status`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/finshark/apis/finshark-api/docs/v1/payments/:paymentId/status/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `paymentId` string, required

## Headers

- `sessionId` string, uuid
- `authorizationId` string, uuid

## Response `200`

Request was fulfilled and payment is listed.

- PaymentStatusResponse: Response on the payment status an authorization request.
  - `id` string, required: Payment identifier.
  - `status` 'CREATED' | 'RECEIVED' | 'CANCELED' | 'FAILED' | 'REJECTED' | 'RECIPIENT_AUTHORIZATION_REQUIRED' | 'AUTHORIZATION_REQUIRED' | 'IN_PROGRESS_CODE' | 'IN_PROGRESS' | 'RECIPIENT_AUTHORIZED' | 'AUTHORIZED' | 'COMPLETED' | 'DELETED', required: Available payment statuses.
  - `psuMessage` string, nullable: Message for the PSU, included if an action needs to be taken by the user during a pending signing.
  - `scaMethods` ScaMethod[], nullable: List of available SCA methods.
    - `href` string, nullable: Redirect link for redirect or decoupled SCA methods.
    - `downloadLink` string, nullable: Download link used to get image that contains dynamic QR code. Supported formats: PNG.
    - `downloadInterval` integer, nullable: Download interval represents the period of changing the content of the downloadLink.
    - `scaMethodType` 'PSU_DECOUPLED' | 'PSU_REDIRECT', required: Strong customer authentication methods.
  - `tppMessages` string[], nullable: Message for the TPP, e.g. if an action needs to be taken by the user during a pending signing or an error message.

## Other responses

- `400`: Error caused by invalid or missing data.
- `401`: Authentication failed due to missing or invalid credentials.
- `403`: Error caused by end user (PSU) not permitted access to the resource.
- `404`: Endpoint does not exist or URL is not constructed correctly.
- `405`: This method is currently not available for corporate access, only for payments to private individuals.
- `500`: Error caused by remote technical issues, this status code is used for unforeseen technical issues.
- `503`: Returned when service is unavailable due to scheduled reasons, such as maintenance.
- `504`: Returned when request has been timed out in the gateway.

---

[API](https://skmtc.dev/finshark/apis/finshark-api.md) - [All operations](https://skmtc.dev/finshark/apis/finshark-api/llms.txt) - [OpenAPI document](https://skmtc.dev/finshark/apis/finshark-api/revisions/7fc3b4f800ae?raw)