---
title: "Payment initiation status request"
method: GET
path: "/v1/{payment-service}/{payment-product}/{paymentId}/status"
tags: ["Payment Initiation Service (PIS)"]
---

# Payment initiation status request

`GET /v1/{payment-service}/{payment-product}/{paymentId}/status`

## Request

- Base URL: `https://api.dev.openbankingproject.ch`
- URL: `https://api.dev.openbankingproject.ch/v1/{payment-service}/{payment-product}/{paymentId}/status`
- Auth: one of:
  - none
  - HTTP bearer

Check the transaction status of a payment initiation.

## Path parameters

- `payment-service` 'payments' | 'bulk-payments' | 'periodic-payments', required
- `payment-product` 'domestic-swiss-credit-transfers-isr' | 'domestic-swiss-credit-transfers' | 'domestic-swiss-credit-transfers-qr' | 'domestic-swiss-foreign-credit-transfers' | 'swiss-sepa-credit-transfers' | 'swiss-cross-border-credit-transfers' | 'pain.001-sepa-credit-transfers' | 'pain.001-cross-border-credit-transfers' | 'pain.001-swiss-six-credit-transfers', required
- `paymentId` string, required: Resource identification of the generated payment initiation resource.

## Headers

- `X-Request-ID` string, required
- `Digest` string
- `Signature` string
- `TPP-Signature-Certificate` string, byte
- `PSU-IP-Address` string, ipv4
- `PSU-IP-Port` string
- `PSU-Accept` string
- `PSU-Accept-Charset` string
- `PSU-Accept-Encoding` string
- `PSU-Accept-Language` string
- `PSU-User-Agent` string
- `PSU-Http-Method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'
- `PSU-Device-ID` string
- `PSU-Geo-Location` string

## Response `200`

OK

- PaymentInitiationStatusResponse200Json: Body of the response for a successful payment initiation status request in case of an JSON based endpoint.
  - `transactionStatus` 'ACCC' | 'ACCP' | 'ACSC' | 'ACSP' | 'ACTC' | 'ACWC' | 'ACWP' | 'RCVD' | 'PDNG' | 'RJCT' | 'CANC' | 'ACFC' | 'PATC' | 'PART', required: The transaction status is filled with codes of the ISO 20022 data table: - 'ACCC': 'AcceptedSettlementCompleted' - Settlement on the creditor's account has been completed. - 'ACCP': 'AcceptedCustomerProfile' - Preceding check of technical validation was successful. Customer profile check was also successful. - 'ACSC': 'AcceptedSettlementCompleted' - Settlement on the debtoro?=s account has been completed. **Usage:** this can be used by the first agent to report to the debtor that the transaction has been completed. **Warning:** this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement. - 'ACSP': 'AcceptedSettlementInProcess' - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution. - 'ACTC': 'AcceptedTechnicalValidation' - Authentication and syntactical and semantical validation are successful. - 'ACWC': 'AcceptedWithChange' - Instruction is accepted but a change will be made, such as date or remittance not sent. - 'ACWP': 'AcceptedWithoutPosting' - Payment instruction included in the credit transfer is accepted without being posted to the creditor customero?=s account. - 'RCVD': 'Received' - Payment initiation has been received by the receiving agent. - 'PDNG': 'Pending' - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed. - 'RJCT': 'Rejected' - Payment initiation or individual transaction included in the payment initiation has been rejected. - 'CANC': 'Cancelled' Payment initiation has been cancelled before execution Remark: This codeis accepted as new code by ISO20022. - 'ACFC': 'AcceptedFundsChecked' - Preceding check of technical validation and customer profile was successful and an automatic funds check was positive . Remark: This code is accepted as new code by ISO20022. - 'PATC': 'PartiallyAcceptedTechnical' Correct The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful. Remark: This code is accepted as new code by ISO20022. - 'PART': 'PartiallyAccepted' - A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. Remark: This code may be used only in case of bulk payments. It is only used in a situation where all mandated authorisations have been applied, but some payments have been rejected.
  - `fundsAvailable` boolean: Equals true if sufficient funds are available at the time of the request, false otherwise. This datalemenet is allways contained in a confirmation of funds response. This data element is contained in a payment status response, if supported by the ASPSP, if a funds check has been performed and if the transactionStatus is "ACTC", "ACWC" or "ACCP".
  - `psuMessage` string: Text to be displayed to the PSU.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `405`: Method Not Allowed
- `406`: Not Acceptable
- `408`: Request Timeout
- `409`: Conflict
- `415`: Unsupported Media Type
- `429`: Too Many Requests
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

> 70 revisions in range; 2 not diffed.

- **2021-03-09** `0d82c4699548`: 3 warning, 13 info
  - added the new `SCA_INVALID` enum value to the `additionalErrors/items/code` response property for the response status `400` (media type: application/problem+json)
  - added the new `SCA_INVALID` enum value to the `code` response property for the response status `400` (media type: application/problem+json)
  - added the new `SCA_INVALID` enum value to the `tppMessages/items/code` response property for the response status `400` (media type: application/json)
  - added the optional property `_links/confirmation` to the response with the `400` status (media type: application/json)
  - …12 more
- **2021-03-09** `b51fe6ddb1fc`: 24 breaking, 13 warning, 12 info
  - removed the enum value `cross-border-credit-transfers` from the `path` request parameter `payment-product`
  - removed the enum value `instant-sepa-credit-transfers` from the `path` request parameter `payment-product`
  - removed the enum value `pain.001-instant-sepa-credit-transfers` from the `path` request parameter `payment-product`
  - removed the enum value `pain.001-target-2-payments` from the `path` request parameter `payment-product`
  - …45 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework/changes/v1/:payment-service/:payment-product/:paymentId/status/get.md)

---

[API](https://skmtc.dev/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework.md) - [All operations](https://skmtc.dev/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework/llms.txt) - [OpenAPI document](https://skmtc.dev/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework/revisions/c32e86db40b4?raw)
