---
title: "Get an International Payment Consent"
method: GET
path: "/international-payment-consents/{ConsentId}"
tags: ["International Payment Consents"]
---

# Get an International Payment Consent

`GET /international-payment-consents/{ConsentId}`

Enables a PISP to retrieve the status of an intent to initiate an International Payment.

## Path parameters

- `ConsentId` string, required

## Headers

- `x-fapi-auth-date` string
- `x-fapi-customer-ip-address` string
- `x-fapi-interaction-id` string
- `Authorization` string, required
- `x-customer-user-agent` string
- `x-client-id` string

## Response `200`

International Payment Consents Read

- OBWriteInternationalConsentResponse6
  - `Data` object, required
    - `ConsentId` string, required — OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
    - `CreationDateTime` string, date-time, required — Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `Status` 'AWAU' | 'RJCT' | 'AUTH' | 'COND', required — Specifies the status of consent resource in code form. For a full list of values refer to `OBInternalConsentStatus2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
    - `StatusReason` OBStatusReason[]
      - `StatusReasonCode` string — Specifies the status reason in a code form. For a full list of values refer to `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `StatusReasonDescription` string — Description supporting the StatusReasonCode.
      - `Path` string — Path is optional but relevant when the status reason refers to an object/field and hence conditional to provide JSON path.
    - `StatusUpdateDateTime` string, date-time, required — Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `ReadRefundAccount` 'No' | 'Yes' — Specifies to share the refund account details with PISP
    - `CutOffDateTime` string, date-time — Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `ExpectedExecutionDateTime` string, date-time — Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `ExpectedSettlementDateTime` string, date-time — Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `Charges` object[]
      - `ChargeBearer` 'BorneByCreditor' | 'BorneByDebtor' | 'FollowingServiceLevel' | 'Shared', required — Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to `OBInternalChargeBearerType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `Type` string, required — Charge type, in a coded form. For a full list of values refer to `OBInternalPaymentChargeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `Amount` OBActiveOrHistoricCurrencyAndAmount, required — Amount of money associated with the charge type.
        - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
        - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
    - `ExchangeRateInformation` object — Further detailed information on the exchange rate that has been used in the payment transaction.
      - `UnitCurrency` string, required — Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
      - `ExchangeRate` number, required — The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
      - `RateType` 'Actual' | 'Agreed' | 'Indicative', required — Specifies the type used to complete the currency exchange.
      - `ContractIdentification` string — Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
      - `ExpirationDateTime` string, date-time — Specified date and time the exchange rate agreement will expire. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `Initiation` object, required — The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
      - `InstructionIdentification` string, required — Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
      - `EndToEndIdentification` string, required — Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
      - `LocalInstrument` string — User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to `OBInternalLocalInstrument1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `InstructionPriority` 'Normal' | 'Urgent' — Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
      - `ExtendedPurpose` string — Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
      - `ChargeBearer` 'BorneByCreditor' | 'BorneByDebtor' | 'FollowingServiceLevel' | 'Shared' — Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to `OBInternalChargeBearerType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `CurrencyOfTransfer` string, required — Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
      - `DestinationCountryCode` string — Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
      - `InstructedAmount` object, required — Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
        - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
        - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
      - `ExchangeRateInformation` object — Provides details on the currency exchange rate and contract.
        - `UnitCurrency` string, required — Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
        - `ExchangeRate` number — The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
        - `RateType` 'Actual' | 'Agreed' | 'Indicative', required — Specifies the type used to complete the currency exchange.
        - `ContractIdentification` string — Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
      - `DebtorAccount` object — Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
        - `SchemeName` string, required — Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string, required — Identification assigned by an institution to identify an account. This identification is known by the account owner.
        - `Name` string — The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
        - `SecondaryIdentification` string — This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
        - `Proxy` OBProxy1 — Specifies an alternate assumed name for the identification of the account.
          - `Identification` string, required — Identification used to indicate the account identification under another specified name.
          - `Code` 'TELE' | 'EMAL' | 'DNAM' | 'CINC' | 'COTX' | 'COID' | 'CUST' | 'DRLC' | 'EIDN' | 'EWAL' | 'PVTX' | 'LEIC' | 'MBNO' | 'NIDN' | 'CCPT' | 'SHID' | 'SOSE' | 'TOKN' | 'UBIL' | 'VIPN' | 'BIID', required — Specifies the external proxy account type code, as published in the proxy account type external code set.<br /> For a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          - `Type` string — Type of the proxy identification.
      - `Creditor` object — Party to which an amount of money is due.
        - `Name` string — Name by which a party is known and which is usually used to identify that party.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
      - `CreditorAgent` object — Financial institution servicing an account for the creditor.
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list.
        - `Identification` string — Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
        - `Name` string — Name by which an agent is known and which is usually used to identify that agent.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
      - `CreditorAccount` object, required — Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
        - `SchemeName` string, required — Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string, required — Identification assigned by an institution to identify an account. This identification is known by the account owner.
        - `Name` string, required — The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
        - `SecondaryIdentification` string — This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
        - `Proxy` OBProxy1 — Specifies an alternate assumed name for the identification of the account.
          - `Identification` string, required — Identification used to indicate the account identification under another specified name.
          - `Code` 'TELE' | 'EMAL' | 'DNAM' | 'CINC' | 'COTX' | 'COID' | 'CUST' | 'DRLC' | 'EIDN' | 'EWAL' | 'PVTX' | 'LEIC' | 'MBNO' | 'NIDN' | 'CCPT' | 'SHID' | 'SOSE' | 'TOKN' | 'UBIL' | 'VIPN' | 'BIID', required — Specifies the external proxy account type code, as published in the proxy account type external code set.<br /> For a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          - `Type` string — Type of the proxy identification.
      - `UltimateCreditor` OBUltimateCreditor1 — Ultimate party to which an amount of money is due.
        - `Name` string — Name by which a party is known and which is usually used to identify that party.
        - `Identification` string — Identification assigned by an institution.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
      - `UltimateDebtor` OBUltimateDebtor1 — Ultimate party that owes an amount of money to the (ultimate) creditor.
        - `Name` string — Name by which a party is known and which is usually used to identify that party.
        - `Identification` string — Identification assigned by an institution.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
      - `RegulatoryReporting` OBRegulatoryReporting1[]
        - `DebitCreditReportingIndicator` 'CRED' | 'DEBT' | 'BOTH' — Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values refer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Authority` OBRegulatoryAuthority2 — Entity requiring the regulatory reporting information.
          - `Name` string — Name of the entity requiring the regulatory reporting information.
          - `CountryCode` string — Nation with its own government.
        - `Details` OBStructuredRegulatoryReporting3[]
          - `Type` string — Specifies the type of the information supplied in the regulatory reporting details
          - `Date` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
          - `Country` string — Nation with its own government.
          - `Amount` OBActiveOrHistoricCurrencyAndAmount — Amount of money associated with the charge type.
            - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
            - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
          - `Information` string[] — Additional details that cater for specific domestic regulatory requirements.
      - `RemittanceInformation` OBRemittanceInformation2 — Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system
        - `Structured` OBRemittanceInformationStructured[]
          - `ReferredDocumentInformation` OBReferredDocumentInformation[]
            - `Code` 'CINV' | 'CNFA' | 'CONT' | 'CREN' | 'DEBN' | 'DISP' | 'DNFA' | 'HIRI' | 'INVS' | 'MSIN' | 'PROF' | 'PUOR' | 'QUOT' | 'SBIN' | 'SPRR' | 'TISH' — Specifies the document type as published in an external document type code list. For more information see `ExternalDocumentType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
            - `Issuer` string — Identification of the issuer of the reference document type.
            - `Number` string — Identification of the type specified for the referred document line.
            - `RelatedDate` string, date-time — Date associated with the referred document line.
            - `LineDetails` string[] — Set of elements used to provide the content of the referred document line.
          - `ReferredDocumentAmount` string — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
          - `CreditorReferenceInformation` object — Reference information provided by the creditor to allow the identification of the underlying documents.
            - `Code` 'DISP' | 'FXDR' | 'PUOR' | 'RPIN' | 'RADM' | 'SCOR' — Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see `ExternalCreditorReferenceType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
            - `Issuer` string — Entity that assigns the identification.
            - `Reference` string — Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
          - `Invoicer` string — Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
          - `Invoicee` string — Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
          - `TaxRemittance` string — Provides remittance information about a payment made for tax-related purposes.
          - `AdditionalRemittanceInformation` string[] — Additional information, in free text form, to complement the structured remittance information.
        - `Unstructured` string[] — Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
      - `SupplementaryData` OBSupplementaryData1 — Additional information that can not be captured in the structured fields and/or any other specific block.
    - `Authorisation` object — The authorisation type request from the TPP.
      - `AuthorisationType` 'Any' | 'Single', required — Type of authorisation flow requested.
      - `CompletionDateTime` string, date-time — Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `SCASupportData` OBSCASupportData1 — Supporting Data provided by TPP, when requesting SCA Exemption.
      - `RequestedSCAExemptionType` 'BillPayment' | 'ContactlessTravel' | 'EcommerceGoods' | 'EcommerceServices' | 'Kiosk' | 'Parking' | 'PartyToParty' — This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values refer to `OBInternalSCAExemptionType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `AppliedAuthenticationApproach` 'CA' | 'SCA' — Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP For a full list of values refer to `OBInternalAppliedAuthenticationApproach1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `ReferencePaymentOrderId` string — If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId
    - `Debtor` OBCashAccountDebtor4 — ^ Only included in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent.
      - `SchemeName` string — ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code
      - `Identification` string — ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text
      - `Name` string — ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.
      - `SecondaryIdentification` string — ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text
      - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
  - `Risk` OBRisk1, required — The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
    - `PaymentContextCode` 'BillingGoodsAndServicesInAdvance' | 'BillingGoodsAndServicesInArrears' | 'EcommerceMerchantInitiatedPayment' | 'FaceToFacePointOfSale' | 'TransferToSelf' | 'TransferToThirdParty' | 'BillPayment' | 'EcommerceGoods' | 'EcommerceServices' | 'PartyToParty' | 'PispPayee' | 'Other' — Specifies the payment context, `OBInternalPaymentContext1Code`<br> The following values are deprecated and <u>**must not**</u> be used in a new consent or payment. They may optionally be returned for a historical payment/consent migrated to v4:<br> * BillPayment - @deprecated * EcommerceGoods - @deprecated * EcommerceServices - @deprecated * PartyToParty - @deprecated * PispPayee - @deprecated * Other - @deprecated
    - `MerchantCategoryCode` string — Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
    - `MerchantCustomerIdentification` string — The unique customer identifier of the PSU with the merchant.
    - `ContractPresentIndicator` boolean — Indicates if Payee has a contractual relationship with the PISP.
    - `BeneficiaryPrepopulatedIndicator` boolean — Indicates if PISP has immutably prepopulated payment details in for the PSU.
    - `PaymentPurposeCode` 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | 'CRYP' — This is a partial list, For a full list see `ExternalPurpose1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
    - `CategoryPurposeCode` 'BONU' | 'CASH' | 'CBLK' | 'CCRD' | 'CGWV' | 'CIPC' | 'CONC' | 'CORT' | 'DCRD' | 'DIVI' | 'DVPM' | 'EPAY' | 'FCDT' | 'FCIN' | 'FCOL' | 'GOVT' | 'GP2P' | 'HEDG' | 'ICCP' | 'IDCP' | 'INTC' | 'INTE' | 'LBOX' | 'LOAN' | 'MP2B' | 'MP2P' | 'OTHR' | 'PENS' | 'RPRE' | 'RRCT' | 'RVPM' | 'SALA' | 'SECU' | 'SSBE' | 'SUPP' | 'SWEP' | 'TAXS' | 'TOPG' | 'TRAD' | 'TREA' | 'VATX' | 'VOST' | 'WHLD' | 'ZABA' — Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see `ExternalCategoryPurpose1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
    - `BeneficiaryAccountType` 'Business' | 'BusinessSavingsAccount' | 'Charity' | 'Collection' | 'Corporate' | 'Ewallet' | 'Government' | 'Investment' | 'ISA' | 'JointPersonal' | 'Pension' | 'Personal' | 'PersonalSavingsAccount' | 'Premier' | 'Wealth' — Specifies the extended type of account.
    - `DeliveryAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
      - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
      - `Department` string — Identification of a division of a large organisation or building.
      - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
      - `StreetName` string — Name of a street or thoroughfare.
      - `BuildingNumber` string — Number that identifies the position of a building on a street.
      - `BuildingName` string — Name of a referenced building.
      - `Floor` string — Number that identifies the level within a building
      - `UnitNumber` string — Number that identifies the unit of a specific address .
      - `Room` string — Information that locates and identifies a room to form part of an address
      - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
      - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
      - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
      - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
      - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
      - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
      - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
      - `Country` string — Nation with its own government.
      - `AddressLine` string[]
  - `Links` Links — Links relevant to the payload
    - `Self` string, uri, required
    - `First` string, uri
    - `Prev` string, uri
    - `Next` string, uri
    - `Last` string, uri
  - `Meta` Meta — Meta Data relevant to the payload
    - `TotalPages` integer
    - `FirstAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `LastAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `405` — Method Not Allowed
- `406` — Not Acceptable
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/openbankinguk/apis/payment-initiation-api.md) · [All operations](https://skmtc.net/openbankinguk/apis/payment-initiation-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openbankinguk/payment-initiation-api/versions/01d3ec5eb703/schema)