--- title: "Get payment information" method: GET path: "/v1/{payment-service}/{payment-product}/{paymentId}" tags: ["Payment Initiation Service (PIS)"] --- # Get payment information `GET /v1/{payment-service}/{payment-product}/{paymentId}` Returns the content of a payment object ## 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 - union - PaymentInitiationWithStatusResponse — Generic JSON response body consistion of the corresponding payment initation JSON body together with an optional transaction status field. - `endToEndIdentification` string - `debtorAccount` AccountReference16CH, required — Reference to an account by either * IBAN, of a payment accounts, or * otherAccountIdentification, for payment accounts if there is no IBAN adapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy - `iban` string — IBAN of an account. - `otherAccountIdentification` string — Other payment account Identifier. adapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH - `currency` string — ISO 4217 Alpha 3 currency code. - `cashAccountType` string — ExternalCashAccountType1Code from ISO 20022. - `ultimateDebtor` string — Ultimate debtor. - `instructedAmount` Amount, required - `currency` string, required — ISO 4217 Alpha 3 currency code. - `amount` string, required — The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `creditorAccount` AccountReference16CH, required — Reference to an account by either * IBAN, of a payment accounts, or * otherAccountIdentification, for payment accounts if there is no IBAN adapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy - `iban` string — IBAN of an account. - `otherAccountIdentification` string — Other payment account Identifier. adapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH - `currency` string — ISO 4217 Alpha 3 currency code. - `cashAccountType` string — ExternalCashAccountType1Code from ISO 20022. - `creditorAgent` CreditorAgent7CH — Reference to an creditorAgent by either * BIC, of the creditor bank, or * IID, of the creditor bank, or * IID and optional name and address of the creditor bank or * Name and address of the creditor bank adapted from ISO pain.001.001.03.ch.02 FinancialInstitutionIdentification7-CH - `bic` string — BICFI - `iid` InstitutionalIdentification2 — Institiutional identification of a bank (Clearing System Member ID) adapted from ISO pain.001.001.03.ch.02 ClearingSystemMemberIdentification2 - `clearingSystemIdCode` string, required - `clearingSystemMemberId` string, required - `name` string - `address` PostalAddress6CH — as in ISO pain.001.001.03.ch.02 PostalAddress6 If possible structured. Simultaneous use of the structured elements / // and the unstructured element is not permitted. as in ISO pain.001.001.03.ch.02 PostalAddress6-CH - `streetName` string - `buildingNumber` string - `townName` string - `postCode` string - `country` string — ISO 3166 ALPHA2 country code. - `addressLine1` string - `addressLine2` string - `creditorName` string, required — Creditor name. - `creditorAddress` Address - `streetName` string - `buildingNumber` string - `townName` string - `postCode` string - `country` string, required — ISO 3166 ALPHA2 country code. - `ultimateCreditor` string — Ultimate creditor. - `purposeCode` 'SALA' | 'PENS' — ExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018. - `remittanceInformationUnstructured` string — Unstructured remittance information. - `remittanceInformationUnstructuredArray` RemittanceInformationUnstructured[] — Array of unstructured remittance information. - `remittanceInformationStructured` RemittanceInformationStructured — Structured remittance information. - `reference` string, required - `referenceType` string - `referenceIssuer` string - `SCORorQRRorIPI` 'SCOR' | 'QRR' | 'IPI' - `additionalRemittanceInformation` string - `requestedExecutionDate` string, date - `requestedExecutionTime` string, date-time - `transactionStatus` 'ACCC' | 'ACCP' | 'ACSC' | 'ACSP' | 'ACTC' | 'ACWC' | 'ACWP' | 'RCVD' | 'PDNG' | 'RJCT' | 'CANC' | 'ACFC' | 'PATC' | 'PART' — 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. - PeriodicPaymentInitiationWithStatusResponse — Generic JSON response body consistion of the corresponding periodic payment initation JSON body together with an optional transaction status field. - `endToEndIdentification` string - `debtorAccount` AccountReference16CH, required — Reference to an account by either * IBAN, of a payment accounts, or * otherAccountIdentification, for payment accounts if there is no IBAN adapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy - `iban` string — IBAN of an account. - `otherAccountIdentification` string — Other payment account Identifier. adapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH - `currency` string — ISO 4217 Alpha 3 currency code. - `cashAccountType` string — ExternalCashAccountType1Code from ISO 20022. - `ultimateDebtor` string — Ultimate debtor. - `instructedAmount` Amount, required - `currency` string, required — ISO 4217 Alpha 3 currency code. - `amount` string, required — The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `creditorAccount` AccountReference16CH, required — Reference to an account by either * IBAN, of a payment accounts, or * otherAccountIdentification, for payment accounts if there is no IBAN adapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy - `iban` string — IBAN of an account. - `otherAccountIdentification` string — Other payment account Identifier. adapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH - `currency` string — ISO 4217 Alpha 3 currency code. - `cashAccountType` string — ExternalCashAccountType1Code from ISO 20022. - `creditorAgent` CreditorAgent7CH — Reference to an creditorAgent by either * BIC, of the creditor bank, or * IID, of the creditor bank, or * IID and optional name and address of the creditor bank or * Name and address of the creditor bank adapted from ISO pain.001.001.03.ch.02 FinancialInstitutionIdentification7-CH - `bic` string — BICFI - `iid` InstitutionalIdentification2 — Institiutional identification of a bank (Clearing System Member ID) adapted from ISO pain.001.001.03.ch.02 ClearingSystemMemberIdentification2 - `clearingSystemIdCode` string, required - `clearingSystemMemberId` string, required - `name` string - `address` PostalAddress6CH — as in ISO pain.001.001.03.ch.02 PostalAddress6 If possible structured. Simultaneous use of the structured elements / // and the unstructured element is not permitted. as in ISO pain.001.001.03.ch.02 PostalAddress6-CH - `streetName` string - `buildingNumber` string - `townName` string - `postCode` string - `country` string — ISO 3166 ALPHA2 country code. - `addressLine1` string - `addressLine2` string - `creditorName` string, required — Creditor name. - `creditorAddress` Address - `streetName` string - `buildingNumber` string - `townName` string - `postCode` string - `country` string, required — ISO 3166 ALPHA2 country code. - `ultimateCreditor` string — Ultimate creditor. - `purposeCode` 'SALA' | 'PENS' — ExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018. - `remittanceInformationUnstructured` string — Unstructured remittance information. - `remittanceInformationUnstructuredArray` RemittanceInformationUnstructured[] — Array of unstructured remittance information. - `remittanceInformationStructured` RemittanceInformationStructured — Structured remittance information. - `reference` string, required - `referenceType` string - `referenceIssuer` string - `SCORorQRRorIPI` 'SCOR' | 'QRR' | 'IPI' - `additionalRemittanceInformation` string - `requestedExecutionDate` string, date - `requestedExecutionTime` string, date-time - `startDate` string, date, required — The first applicable day of execution starting from this date is the first payment. - `endDate` string, date — The last applicable day of execution. If not given, it is an infinite standing order. - `executionRule` 'following' | 'preceding' — "following" or "preceding" supported as values. This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. ASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting this execution rule. - `frequency` 'Daily' | 'Weekly' | 'EveryTwoWeeks' | 'Monthly' | 'EveryTwoMonths' | 'Quarterly' | 'SemiAnnual' | 'Annual' | 'MonthlyVariable', required — The following codes from the "EventFrequency7Code" of ISO 20022 are supported: - "Daily" - "Weekly" - "EveryTwoWeeks" - "Monthly" - "EveryTwoMonths" - "Quarterly" - "SemiAnnual" - "Annual" - "MonthlyVariable" - `dayOfExecution` '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' — Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. - `transactionStatus` 'ACCC' | 'ACCP' | 'ACSC' | 'ACSP' | 'ACTC' | 'ACWC' | 'ACWP' | 'RCVD' | 'PDNG' | 'RJCT' | 'CANC' | 'ACFC' | 'PATC' | 'PART' — 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. - BulkPaymentInitiationWithStatusResponse — Generic JSON response body consistion of the corresponding bulk payment initation JSON body together with an optional transaction status field. - `batchBookingPreferred` boolean — If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. The ASPSP will follow this preference according to contracts agreed on with the PSU. - `requestedExecutionDate` string, date - `acceptorTransactionDateTime` string, date-time - `debtorAccount` AccountReference16CH, required — Reference to an account by either * IBAN, of a payment accounts, or * otherAccountIdentification, for payment accounts if there is no IBAN adapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy - `iban` string — IBAN of an account. - `otherAccountIdentification` string — Other payment account Identifier. adapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH - `currency` string — ISO 4217 Alpha 3 currency code. - `cashAccountType` string — ExternalCashAccountType1Code from ISO 20022. - `paymentInformationId` string - `payments` PaymentInitiationBulkElementJson[], required — A list of generic JSON bodies payment initations for bulk payments via JSON. Note: Some fields from single payments do not occcur in a bulk payment element - `endToEndIdentification` string, required - `debtorName` string, required — Debtor name. - `debtorId` string — Debtor Id. - `ultimateDebtor` string — Ultimate debtor. - `instructedAmount` Amount - `currency` string, required — ISO 4217 Alpha 3 currency code. - `amount` string, required — The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `equivalentAmount` Amount - `currency` string, required — ISO 4217 Alpha 3 currency code. - `amount` string, required — The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `transactionCurrency` string — ISO 4217 Alpha 3 currency code. - `exchangeRateInformation` ExchangeRateInformation1 — as in ISO pain.001.001.03.ch.02 ExchangeRateInformation1 - `exchangeRate` string - `contractIdentification` string - `rateType` 'SPOT' | 'SALE' | 'AGRD' - `creditorAccount` AccountReference16CH, required — Reference to an account by either * IBAN, of a payment accounts, or * otherAccountIdentification, for payment accounts if there is no IBAN adapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy - `iban` string — IBAN of an account. - `otherAccountIdentification` string — Other payment account Identifier. adapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH - `currency` string — ISO 4217 Alpha 3 currency code. - `cashAccountType` string — ExternalCashAccountType1Code from ISO 20022. - `creditorAgent` CreditorAgent7CH — Reference to an creditorAgent by either * BIC, of the creditor bank, or * IID, of the creditor bank, or * IID and optional name and address of the creditor bank or * Name and address of the creditor bank adapted from ISO pain.001.001.03.ch.02 FinancialInstitutionIdentification7-CH - `bic` string — BICFI - `iid` InstitutionalIdentification2 — Institiutional identification of a bank (Clearing System Member ID) adapted from ISO pain.001.001.03.ch.02 ClearingSystemMemberIdentification2 - `clearingSystemIdCode` string, required - `clearingSystemMemberId` string, required - `name` string - `address` PostalAddress6CH — as in ISO pain.001.001.03.ch.02 PostalAddress6 If possible structured. Simultaneous use of the structured elements / // and the unstructured element is not permitted. as in ISO pain.001.001.03.ch.02 PostalAddress6-CH - `streetName` string - `buildingNumber` string - `townName` string - `postCode` string - `country` string — ISO 3166 ALPHA2 country code. - `addressLine1` string - `addressLine2` string - `creditorAgentName` string — Creditor agent name. - `creditorName` string, required — Creditor name. - `creditorId` string — Identification of Creditors, e.g. a SEPA Creditor ID. - `creditorAddress` Address - `streetName` string - `buildingNumber` string - `townName` string - `postCode` string - `country` string, required — ISO 3166 ALPHA2 country code. - `creditorNameAndAddress` string — Creditor Name and Address in a free text field. - `ultimateCreditor` string — Ultimate creditor. - `purposeCode` 'SALA' | 'PENS' — ExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018. - `serviceLevel` 'SEPA' | 'PRPT' | 'SDVA' | 'URGP' — Specifies the external service level code in the format of character string with a maximum length of 4 characters. - `chargeBearer` 'DEBT' | 'CRED' | 'SHAR' | 'SLEV' — Charge Bearer. ChargeBearerType1Code from ISO20022. - `remittanceInformationUnstructured` string — Unstructured remittance information. - `remittanceInformationStructured` RemittanceInformationStructured — Structured remittance information. - `reference` string, required - `referenceType` string - `referenceIssuer` string - `SCORorQRRorIPI` 'SCOR' | 'QRR' | 'IPI' - `additionalRemittanceInformation` string - `intermediaryAgent` string — BICFI - `transactionStatus` 'ACCC' | 'ACCP' | 'ACSC' | 'ACSP' | 'ACTC' | 'ACWC' | 'ACWP' | 'RCVD' | 'PDNG' | 'RJCT' | 'CANC' | 'ACFC' | 'PATC' | 'PART' — 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. ## 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 --- [API](https://skmtc.net/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework.md) · [All operations](https://skmtc.net/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openbankingproject-ch/swiss-nextgen-banking-api-framework/revisions/c32e86db40b4/schema)