NatWest Group International Payments API

openapi: 3.2.0
info:
  title: Account and Transaction API Specification Account Access International Payments API
  description: Swagger for Account and Transaction API Specification
  termsOfService: https://www.openbanking.org.uk/terms
  contact:
    name: Service Desk
    email: ServiceDesk@openbanking.org.uk
  license:
    name: open-licence
    url: https://www.openbanking.org.uk/open-licence
  version: 3.1.11
servers:
- url: /open-banking/v3.1/aisp
tags:
- name: International Payments
paths:
  /international-payment-consents:
    post:
      tags:
      - International Payments
      summary: Create International Payment Consents
      operationId: CreateInternationalPaymentConsents
      parameters:
      - $ref: '#/components/parameters/x-fapi-auth-date'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address'
      - $ref: '#/components/parameters/x-fapi-interaction-id'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/x-idempotency-key'
      - $ref: '#/components/parameters/x-jws-signature'
      - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalConsent5'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalConsent5'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalConsent5'
        description: Default
        required: true
      responses:
        201:
          $ref: '#/components/responses/201InternationalPaymentConsentsCreated'
        400:
          $ref: '#/components/responses/400Error'
        401:
          $ref: '#/components/responses/401Error'
        403:
          $ref: '#/components/responses/403Error'
        404:
          $ref: '#/components/responses/404Error'
        405:
          $ref: '#/components/responses/405Error'
        406:
          $ref: '#/components/responses/406Error'
        415:
          $ref: '#/components/responses/415Error'
        429:
          $ref: '#/components/responses/429Error'
        500:
          $ref: '#/components/responses/500Error'
      security:
      - TPPOAuth2Security:
        - payments
  /international-payment-consents/{ConsentId}:
    get:
      tags:
      - International Payments
      summary: Get International Payment Consents
      operationId: GetInternationalPaymentConsentsConsentId
      parameters:
      - $ref: '#/components/parameters/ConsentId'
      - $ref: '#/components/parameters/x-fapi-auth-date'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address'
      - $ref: '#/components/parameters/x-fapi-interaction-id'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        200:
          $ref: '#/components/responses/200InternationalPaymentConsentsConsentIdRead'
        400:
          $ref: '#/components/responses/400Error'
        401:
          $ref: '#/components/responses/401Error'
        403:
          $ref: '#/components/responses/403Error'
        404:
          $ref: '#/components/responses/404Error'
        405:
          $ref: '#/components/responses/405Error'
        406:
          $ref: '#/components/responses/406Error'
        429:
          $ref: '#/components/responses/429Error'
        500:
          $ref: '#/components/responses/500Error'
      security:
      - TPPOAuth2Security:
        - payments
  /international-payment-consents/{ConsentId}/funds-confirmation:
    get:
      tags:
      - International Payments
      summary: Get International Payment Consents Funds Confirmation
      operationId: GetInternationalPaymentConsentsConsentIdFundsConfirmation
      parameters:
      - $ref: '#/components/parameters/ConsentId'
      - $ref: '#/components/parameters/x-fapi-auth-date'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address'
      - $ref: '#/components/parameters/x-fapi-interaction-id'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        200:
          $ref: '#/components/responses/200InternationalPaymentConsentsConsentIdFundsConfirmationRead'
        400:
          $ref: '#/components/responses/400Error'
        401:
          $ref: '#/components/responses/401Error'
        403:
          $ref: '#/components/responses/403Error'
        404:
          $ref: '#/components/responses/404Error'
        405:
          $ref: '#/components/responses/405Error'
        406:
          $ref: '#/components/responses/406Error'
        429:
          $ref: '#/components/responses/429Error'
        500:
          $ref: '#/components/responses/500Error'
      security:
      - PSUOAuth2Security:
        - payments
  /international-payments:
    post:
      tags:
      - International Payments
      summary: Create International Payments
      operationId: CreateInternationalPayments
      parameters:
      - $ref: '#/components/parameters/x-fapi-auth-date'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address'
      - $ref: '#/components/parameters/x-fapi-interaction-id'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/x-idempotency-key'
      - $ref: '#/components/parameters/x-jws-signature'
      - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteInternational3'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteInternational3'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteInternational3'
        description: Default
        required: true
      responses:
        201:
          $ref: '#/components/responses/201InternationalPaymentsCreated'
        400:
          $ref: '#/components/responses/400Error'
        401:
          $ref: '#/components/responses/401Error'
        403:
          $ref: '#/components/responses/403Error'
        404:
          $ref: '#/components/responses/404Error'
        405:
          $ref: '#/components/responses/405Error'
        406:
          $ref: '#/components/responses/406Error'
        415:
          $ref: '#/components/responses/415Error'
        429:
          $ref: '#/components/responses/429Error'
        500:
          $ref: '#/components/responses/500Error'
      security:
      - PSUOAuth2Security:
        - payments
  /international-payments/{InternationalPaymentId}:
    get:
      tags:
      - International Payments
      summary: Get International Payments
      operationId: GetInternationalPaymentsInternationalPaymentId
      parameters:
      - $ref: '#/components/parameters/InternationalPaymentId'
      - $ref: '#/components/parameters/x-fapi-auth-date'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address'
      - $ref: '#/components/parameters/x-fapi-interaction-id'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        200:
          $ref: '#/components/responses/200InternationalPaymentsInternationalPaymentIdRead'
        400:
          $ref: '#/components/responses/400Error'
        401:
          $ref: '#/components/responses/401Error'
        403:
          $ref: '#/components/responses/403Error'
        404:
          $ref: '#/components/responses/404Error'
        405:
          $ref: '#/components/responses/405Error'
        406:
          $ref: '#/components/responses/406Error'
        429:
          $ref: '#/components/responses/429Error'
        500:
          $ref: '#/components/responses/500Error'
      security:
      - TPPOAuth2Security:
        - payments
components:
  schemas:
    OBWriteInternationalResponse5:
      type: object
      additionalProperties: false
      required:
      - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
          - InternationalPaymentId
          - ConsentId
          - CreationDateTime
          - Status
          - StatusUpdateDateTime
          - Initiation
          properties:
            InternationalPaymentId:
              description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource.'
              type: string
              minLength: 1
              maxLength: 40
            ConsentId:
              description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.'
              type: string
              minLength: 1
              maxLength: 128
            CreationDateTime:
              description: "Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
              type: string
              format: date-time
            Status:
              description: Specifies the status of the payment information group.
              type: string
              enum:
              - AcceptedCreditSettlementCompleted
              - AcceptedSettlementCompleted
              - AcceptedSettlementInProcess
              - AcceptedWithoutPosting
              - Pending
              - Rejected
            StatusUpdateDateTime:
              description: "Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
              type: string
              format: date-time
            ExpectedExecutionDateTime:
              description: "Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
              type: string
              format: date-time
            ExpectedSettlementDateTime:
              description: "Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
              type: string
              format: date-time
            Refund:
              type: object
              additionalProperties: false
              required:
              - Account
              properties:
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Set of elements used to identify a person or an organisation.
                  properties:
                    Name:
                      description: Name by which a party is known and which is usually used to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 140
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress6'
                Agent:
                  type: object
                  additionalProperties: false
                  description: Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
                  properties:
                    SchemeName:
                      $ref: '#/components/schemas/OBExternalFinancialInstitutionIdentification4Code'
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress6'
                Account:
                  type: object
                  additionalProperties: false
                  required:
                  - SchemeName
                  - Identification
                  - Name
                  description: Provides the details to identify an account.
                  properties:
                    SchemeName:
                      $ref: '#/components/schemas/OBExternalAccountIdentification4Code'
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: '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.

                        OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.'
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: Set of elements used to provide details of a charge for the payment initiation.
                required:
                - ChargeBearer
                - Type
                - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBExternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            ExchangeRateInformation:
              type: object
              additionalProperties: false
              required:
              - UnitCurrency
              - ExchangeRate
              - RateType
              description: Further detailed information on the exchange rate that has been used in the payment transaction.
              properties:
                UnitCurrency:
                  description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                ExchangeRate:
                  description: 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.
                  type: number
                RateType:
                  description: Specifies the type used to complete the currency exchange.
                  type: string
                  enum:
                  - Actual
                  - Agreed
                  - Indicative
                ContractIdentification:
                  description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
                  type: string
                  minLength: 1
                  maxLength: 256
                ExpirationDateTime:
                  description: "Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
                  type: string
                  format: date-time
            Initiation:
              type: object
              additionalProperties: false
              required:
              - InstructionIdentification
              - EndToEndIdentification
              - CurrencyOfTransfer
              - InstructedAmount
              - CreditorAccount
              description: 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.
              properties:
                InstructionIdentification:
                  description: '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.'
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: '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.'
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBExternalLocalInstrument1Code'
                InstructionPriority:
                  description: 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.
                  type: string
                  enum:
                  - Normal
                  - Urgent
                Purpose:
                  description: 'Specifies the external purpose code in the format of character string with a maximum length of 4 characters.

                    The list of valid codes is an external code list published separately.

                    External code sets can be downloaded from www.iso20022.org.'
                  type: string
                  minLength: 1
                  maxLength: 4
                ExtendedPurpose:
                  description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBChargeBearerType1Code'
                CurrencyOfTransfer:
                  description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: 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).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                  - Amount
                  - Currency
                  description: '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.'
                  properties:
                    Amount:
                      $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                ExchangeRateInformation:
                  type: object
                  additionalProperties: false
                  required:
                  - UnitCurrency
                  - RateType
                  description: Provides details on the currency exchange rate and contract.
                  properties:
                    UnitCurrency:
                      description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
                      type: string
                      pattern: ^[A-Z]{3,3}$
                    ExchangeRate:
                      description: 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.
                      type: number
                    RateType:
                      description: Specifies the type used to complete the currency exchange.
                      type: string
                      enum:
                      - Actual
                      - Agreed
                      - Indicative
                    ContractIdentification:
                      description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
                      type: string
                      minLength: 1
                      maxLength: 256
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                  - SchemeName
                  - Identification
                  description: Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
                  properties:
                    SchemeName:
                      $ref: '#/components/schemas/OBExternalAccountIdentification4Code'
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: '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.'
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: Name by which a party is known and which is usually used to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 140
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress6'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: '#/components/schemas/OBExternalFinancialInstitutionIdentification4Code'
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress6'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                  - SchemeName
                  - Identification
                  - Name
                  description: Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
                  properties:
                    SchemeName:
                      $ref: '#/components/schemas/OBExternalAccountIdentification4Code'
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: '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.'
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                RemittanceInformation:
                  type: object
                  additionalProperties: false
                  description: 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.
                  properties:
                    Unstructured:
                      description: 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.
                      type: string
                      minLength: 1
                      maxLength: 140
                    Reference:
                      description: 'Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.

                        Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.

                        If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor''s reference or payment remittance identification should be quoted in the end-to-end transaction identification.

                        OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.'
                      type: string
                      minLength: 1
                      maxLength: 35
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            MultiAuthorisation:
              type: object
              additionalProperties: false
              required:
              - Status
              description: The multiple authorisation flow response from the ASPSP.
              properties:
                Status:
                  description: Specifies the status of the authorisation flow in code form.
                  type: string
                  enum:
                  - Authorised
                  - AwaitingFurtherAuthorisation
                  - Rejected
                NumberRequired:
                  description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
                  type: integer
                NumberReceived:
                  description: Number of authorisations received.
                  type: integer
                LastUpdateDateTime:
                  description: "Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
                  type: string
                  format: date-time
                ExpirationDateTime:
                  description: "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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
                  type: string
                  format: date-time
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteFundsConfirmationResponse1:
      type: object
      additionalProperties: false
      required:
      - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          properties:
            FundsAvailableResult:
              type: object
              additionalProperties: false
              required:
              - FundsAvailableDateTime
              - FundsAvailable
              description: Result of a funds availability check.
              properties:
                FundsAvailableDateTime:
                  description: "Date and time at which the funds availability check was generated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
                  type: string
                  format: date-time
                FundsAvailable:
                  description: Flag to indicate the availability of funds given the Amount in the consent request.
                  type: boolean
            SupplementaryData:
              $ref: '#/components/schemas/OBSupplementaryData1'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBExternalExtendedAccountType1Code:
      description: Specifies the extended type of account.
      type: string
      enum:
      - Business
      - BusinessSavingsAccount
      - Charity
      - Collection
      - Corporate
      - Ewallet
      - Government
      - Investment
      - ISA
      - JointPersonal
      - Pension
      - Personal
      - PersonalSavingsAccount
      - Premier
      - Wealth
    OBExternalPaymentChargeType1Code:
      description: Charge type, in a coded form.
      type: string
      x-namespaced-enum:
      - UK.OBIE.CHAPSOut
    OBChargeBearerType1Code:
      description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
      type: string
      enum:
      - BorneByCreditor
      - BorneByDebtor
      - FollowingServiceLevel
      - Shared
    OBSCASupportData1:
      type: object
      properties:
        RequestedSCAExemptionType:
          type: string
          description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation
          enum:
          - BillPayment
          - ContactlessTravel
          - EcommerceGoods
          - EcommerceServices
          - Kiosk
          - Parking
          - PartyToParty
        AppliedAuthenticationApproach:
          type: string
          maxLength: 40
          description: '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'
          enum:
          - CA
          - SCA
        ReferencePaymentOrderId:
          type: string
          maxLength: 40
          minLength: 1
          description: '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  '
      description: Supporting Data provided by TPP, when requesting SCA Exemption.
    Department:
      description: Identification of a division of a large organisation or building.
      type: string
      minLength: 1
      maxLength: 70
    OBActiveOrHistoricCurrencyAndAmount:
      type: o

# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/natwest/refs/heads/main/openapi/natwest-international-payments-api-openapi.yml