The Bank of London

The Bank of London Payments V2 API

The Payments V2 API from The Bank of London — 9 operation(s) for payments v2.

Documentation GitHub OpenAPI

Operations 10

POST /v2/fx-quotes Create an FX Quote #

GET /v2/fx-quotes/{quoteId} Get an FX Quote #

POST /v2/payments/internal Create an Internal Payment #

POST /v2/payments/faster-payment Create a Faster Payment #

POST /v2/payments/bacs Create a Bacs Payment #

POST /v2/payments/chaps Create a CHAPS Payment #

POST /v2/payments/agency Create an Agency Payment #

POST /v2/payments Create a Cross-border Payment #

GET /v2/payments Get Payments #

GET /v2/payments/{paymentId} Get Payment #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/the-bank-of-london-payments-v2-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Bank of London Payments V2 API
  version: 2.0.0
  description: ''
servers:
- description: Sandbox
  url: https://sandbox-api.bankoflondon.com/
- description: Live
  url: https://api.bankoflondon.com/
- description: Mock Server
  url: https://developer.bankoflondon.com/api/mock/the-bank-of-london-api
tags:
- name: Payments V2
paths:
  /v2/fx-quotes:
    post:
      operationId: CreateAnFXQuoteV2
      summary: Create an FX Quote
      description: '**Attention** \

        This endpoint requires specific permissions and is restricted to clients who have been granted access. If you would like to avail of this functionality, please reach out to our customer service team at client.partners@thebankoflondon.com to enable this functionality.


        Creates a guaranteed rate quote for a specific time period.

        This endpoint provides real-time foreign exchange rates,

        ensuring accurate and reliable pricing for your FX transactions.


        The quote will include an exchange rate, quote ID for future reference,

        and expiration time indicating how long the rate is guaranteed.'
      parameters:
      - $ref: '#/components/parameters/JwsSignature'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAnFXQuoteRequest'
            examples:
              buyRequest:
                summary: Buy Request - Specify amount to buy.
                description: Request where you specify the amount you want to buy (USD 10,000) and the system calculates how much GBP you need to sell
                value:
                  sell:
                    currency: GBP
                  buy:
                    currency: USD
                    amount: '10000.00'
              sellRequest:
                summary: Sell Request - Specify amount to sell
                description: Request where you specify the amount you want to sell (GBP 8,500) and the system calculates how much USD you will receive
                value:
                  sell:
                    currency: GBP
                    amount: '8500.00'
                  buy:
                    currency: USD
      responses:
        '200':
          description: Quote created successfully
          headers:
            x-correlation-id:
              description: A unique identifier assigned to each request, facilitating issue tracing. In the event that a problem arises with a request, this ID can be provided to Bank of London support team for assistance.
              schema:
                type: string
              example: '2579248247516384065'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAnFXQuoteResponse'
              example:
                quoteId: j0zMRPAN_Kl5WbKwAAe5A
                sell:
                  currency: GBP
                  amount: '7843.14'
                buy:
                  currency: USD
                  amount: '10000.00'
                exchangeRate: '1.2750'
                expiresAtDateTime: '2024-06-16T15:30:00.000Z'
                createdDateTime: '2024-06-16T10:25:50.000Z'
                quoteType: BUY
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          $ref: '#/components/responses/422'
        '500':
          $ref: '#/components/responses/500'
      tags:
      - Payments V2
  /v2/fx-quotes/{quoteId}:
    get:
      operationId: GetAnFXQuoteV2
      summary: Get an FX Quote
      description: '**Attention** \

        This endpoint requires specific permissions and is restricted to clients who have been granted access. If you would like to avail of this functionality, please reach out to our customer service team at client.partners@thebankoflondon.com to enable this functionality.


        Retrieves a previously generated foreign exchange quote by its ID.

        This endpoint allows you to access the details of a specific FX quote,

        including the exchange rate, amounts involved, and expiration time.'
      parameters:
      - $ref: '#/components/parameters/JwsSignature'
      - in: path
        name: quoteId
        required: true
        schema:
          $ref: '#/components/schemas/QuoteId'
      responses:
        '200':
          description: Quote retrieved successfully
          headers:
            x-correlation-id:
              description: A unique identifier assigned to each request, facilitating issue tracing. In the event that a problem arises with a request, this ID can be provided to Bank of London support team for assistance.
              schema:
                type: string
              example: '2579248247516384065'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAnFXQuoteResponse'
              example:
                quoteId: j0zMRPAN_Kl5WbKwAAe5A
                sell:
                  currency: GBP
                  amount: '7843.14'
                buy:
                  currency: USD
                  amount: '10000.00'
                exchangeRate: '1.2750'
                expiresAtDateTime: '2024-06-16T15:30:00.000Z'
                createdDateTime: '2024-06-16T10:25:50.000Z'
                quoteType: BUY
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
        '500':
          $ref: '#/components/responses/500'
      tags:
      - Payments V2
  /v2/payments/internal:
    post:
      operationId: CreateAnInternalPayment
      summary: Create an Internal Payment
      description: 'This operation initiates a payment in the context of

        an application registered with Bank of London Developer Studio. It takes a request body

        that contains all the necessary information required to issue a single internal payment.


        All payments must originate from a Bank of London account (`sender` field).

        The `recipient` field must be a Bank of London account ID that is owned by the requesting account holder, otherwise the request will be rejected.

        A customer can only transfer between two of their own accounts eg. Operating Account → Client Collateral Account.


        ## Single Internal Debit Payment


        The API will return the ID of the created payment along with its

        status after initiation. The ID can be used to retrieve the payment

        details (`GET /payments/{paymentId}`) including its current status in the

        future.


        ## Immediate and Future Payments


        Providing `plannedExecutionDateTime` for `INTERNAL_DEBIT` payment will schedule a future payment whereas omitting the

        `plannedExecutionDateTime` will result in an immediate payment.


        The consumer application (identified by the API key) must always have

        the permission to execute payments from the sender''s account.'
      parameters:
      - $ref: '#/components/parameters/JwsSignature'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                title: Internal Payment Request
                description: Payment object that is required to initiate a single Internal Debit payment.
                properties:
                  type:
                    type: string
                    description: Represents an immediate or future dated Internal payment.
                    enum:
                    - INTERNAL_DEBIT
                  sender:
                    $ref: '#/components/schemas/PaymentSender'
                  recipient:
                    $ref: '#/components/schemas/PaymentRecipientTbol'
                  amount:
                    $ref: '#/components/schemas/PaymentAmount'
                  reference:
                    $ref: '#/components/schemas/PaymentReferenceRequest'
                  notes:
                    $ref: '#/components/schemas/PaymentNotes'
                  plannedExecutionDateTime:
                    $ref: '#/components/schemas/PlannedPaymentExecutionDateTime'
                  idempotencyId:
                    $ref: '#/components/schemas/IdempotencyId'
                required:
                - type
                - sender
                - recipient
                - amount
                - reference
                - idempotencyId
      responses:
        '202':
          description: "Accepted\n\n<span style=\"color:#f46d2a; font-size:14px; font-family:Inter;\">**Attention**</span> \\\n<span style=\"font-size:14px; font-family:Inter;\">Please note that the oneOf in the **body** below, is extensible and new objects can be \nreturned with a new payment **type** in the future without a major version change. Please ensure this is factored into your\napplication code.</span>\n"
          headers:
            x-correlation-id:
              description: A unique identifier assigned to each request, facilitating issue tracing. In the event that a problem arises with a request, this ID can be provided to Bank of London support team for assistance.
              schema:
                type: string
              example: '2579248247516384065'
              required: true
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/InternalSinglePayment'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/PaymentUnauthorizedError'
        '403':
          $ref: '#/components/responses/PaymentForbiddenError'
        '404':
          $ref: '#/components/responses/BankAccountNotFoundError'
        '409':
          $ref: '#/components/responses/ErrorResponseConflictIdempotencyId'
        '422':
          $ref: '#/components/responses/CreateInternalPaymentUnprocessableError'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      tags:
      - Payments V2
  /v2/payments/faster-payment:
    post:
      operationId: CreateAFasterPayment
      summary: Create a Faster Payment
      description: 'This operation initiates a payment in the context of

        an application registered with Bank of London Developer Studio. It takes a request body

        that contains all the necessary information required to issue a single payment.


        All payments must originate from a Bank of London account (`sender` field)

        and can be transferred to either a Bank of London account or any UK domestic

        account of another bank.


        ## Single FPS Debit Payment


        The API will return the ID of the created payment along with its

        status after initiation. The ID can be used to retrieve the payment

        details (`GET /payments/{paymentId}`) including its current status in the

        future.


        ## Immediate and Future Payments


        Providing `plannedExecutionDateTime` for `FPS_DEBIT` payment will schedule a future payment whereas omitting the

        `plannedExecutionDateTime` will result in an immediate payment.


        The consumer application (identified by the API key) must always have

        the permission to execute payments from the sender''s account.'
      parameters:
      - $ref: '#/components/parameters/JwsSignature'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                title: FPS Payment Request
                description: Payment object that is required to initiate a single FPS Debit payment.
                properties:
                  type:
                    type: string
                    description: Represents an immediate or future dated FPS payment.
                    enum:
                    - FPS_DEBIT
                  sender:
                    $ref: '#/components/schemas/PaymentSender'
                  recipient:
                    $ref: '#/components/schemas/PaymentRecipient'
                  amount:
                    $ref: '#/components/schemas/PaymentAmount'
                  reference:
                    $ref: '#/components/schemas/PaymentReferenceRequest'
                  notes:
                    $ref: '#/components/schemas/PaymentNotes'
                  plannedExecutionDateTime:
                    $ref: '#/components/schemas/PlannedPaymentExecutionDateTime'
                  idempotencyId:
                    $ref: '#/components/schemas/IdempotencyId'
                required:
                - type
                - sender
                - recipient
                - amount
                - reference
                - idempotencyId
      responses:
        '202':
          description: "Accepted\n\n<span style=\"color:#f46d2a; font-size:14px; font-family:Inter;\">**Attention**</span> \\\n<span style=\"font-size:14px; font-family:Inter;\">Please note that the oneOf in the **body** below, is extensible and new objects can be \nreturned with a new payment **type** in the future without a major version change. Please ensure this is factored into your\napplication code.</span>\n"
          headers:
            x-correlation-id:
              description: A unique identifier assigned to each request, facilitating issue tracing. In the event that a problem arises with a request, this ID can be provided to Bank of London support team for assistance.
              schema:
                type: string
              example: '2579248247516384065'
              required: true
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/FPSSinglePayment'
                - $ref: '#/components/schemas/InternalSinglePayment'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/PaymentUnauthorizedError'
        '403':
          $ref: '#/components/responses/PaymentForbiddenError'
        '404':
          $ref: '#/components/responses/BankAccountNotFoundError'
        '409':
          $ref: '#/components/responses/ErrorResponseConflictIdempotencyId'
        '422':
          $ref: '#/components/responses/CreateFPSUnprocessableError'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      tags:
      - Payments V2
  /v2/payments/bacs:
    post:
      operationId: CreateABacsPayment
      summary: Create a Bacs Payment
      description: 'This operation initiates a Bacs payment in the context of

        an application registered with Bank of London Developer Studio. It takes a request body

        that contains all the necessary information required to issue either a

        single or a standing order Bacs payment. The `type` field serves as a discriminator.


        Bacs operates on a 3 working day cycle between Monday to Friday. The scheme does not operate on weekends and Bank holidays (England & Wales).


        On successful acceptance and processing of your payments, funds will be held in your account on Day 1 and will typically be credited to the recipient''s account on Day 3.


        You can recall a Bacs payment only up to 5.30PM on the day you initiate the payment; for any recalls, please contact the customer service team by email: `uksupport@thebankoflondon.com` or call us on `+44 3301 659 131`


        All payments must originate from a Bank of London account (`sender` field)

        and can be transferred to any UK domestic account of another bank.


        The consumer application (identified by the API key) must always have

        the permission to execute payments from the sender''s account.


        ## Single Bacs Debit Payment


        The API will return the ID of the created payment along with its

        status after initiation. The ID can be used to retrieve the payment

        details (`GET /payments/{paymentId}`) including its current status in the

        future.


        ## Immediate and Future Payments


        Providing a future date for `plannedExecutionDate` for `BACS_DEBIT` payment will schedule a future payment. Providing today''s date for `plannedExecutionDate` will result in an immediate payment.


        Payments are processed in the Europe/London timezone so `plannedExecutionDate` must be a UK date in the format `YYYY-MM-DD`.'
      parameters:
      - $ref: '#/components/parameters/JwsSignature'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/BacsDebitPaymentRequest'
      responses:
        '202':
          description: "Accepted\n\n<span style=\"color:#f46d2a; font-size:14px; font-family:Inter;\">**Attention**</span> \\\n<span style=\"font-size:14px; font-family:Inter;\">Please note that the oneOf in the **body** below, is extensible and new objects can be \nreturned with a new payment **type** in the future without a major version change. Please ensure this is factored into your\napplication code.</span>\n"
          headers:
            x-correlation-id:
              description: A unique identifier assigned to each request, facilitating issue tracing. In the event that a problem arises with a request, this ID can be provided to Bank of London support team for assistance.
              schema:
                type: string
              example: '2579248247516384065'
              required: true
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/BacsSinglePayment'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/PaymentUnauthorizedError'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/BankAccountNotFoundError'
        '409':
          $ref: '#/components/responses/ErrorResponseConflictIdempotencyId'
        '422':
          $ref: '#/components/responses/CreateBacsPaymentUnprocessableError'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      tags:
      - Payments V2
  /v2/payments/chaps:
    post:
      operationId: CreateACHAPSPayment
      summary: Create a CHAPS Payment
      description: 'This operation initiates a CHAPS payment in the context of

        an application registered with Bank of London Developer Studio. It takes a request body

        that contains all the necessary information required to issue a

        single CHAPS payment.


        CHAPS operates same day processing between Monday to Friday; our current cut off for same day payment is 4:00 PM,

        and payments submitted after this cut-off time will be processed the next working day. The scheme does not

        operate on weekends and bank holidays (England & Wales).


        Please ensure that any CHAPS payments are only made on your behalf and not on behalf of your clients

        (if applicable).


        Virtual Accounts cannot be used for CHAPS payments.


        TBOL uses an agency bank to process CHAPS payments on its behalf; CHAPS payments cannot be reversed. If you need

        any assistance, please contact us as soon as possible at uksupport@thebankoflondon.com or call us on

        +443301 659 131


        ## Single CHAPS Payment


        The API will return details of the created payment along with its status after initiation. The ID can be used to

        retrieve the payment details (`GET /payments/{paymentId}`) including its current status in the future.'
      parameters:
      - $ref: '#/components/parameters/JwsSignature'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                title: CHAPS Payment Request
                description: Payment object that is required to initiate a single CHAPS payment.
                properties:
                  type:
                    type: string
                    description: Represents an immediate or future dated CHAPS payment.
                    enum:
                    - CHAPS_DEBIT
                  sender:
                    $ref: '#/components/schemas/PaymentSender'
                  recipient:
                    $ref: '#/components/schemas/PaymentRecipient'
                  amount:
                    $ref: '#/components/schemas/ChapsPaymentAmount'
                  reference:
                    $ref: '#/components/schemas/PaymentReferenceRequest'
                  notes:
                    $ref: '#/components/schemas/PaymentNotes'
                  plannedExecutionDateTime:
                    $ref: '#/components/schemas/PlannedChapsPaymentExecutionDateTime'
                  idempotencyId:
                    $ref: '#/components/schemas/IdempotencyId'
                required:
                - type
                - sender
                - recipient
                - amount
                - reference
                - idempotencyId
      responses:
        '202':
          description: Accepted
          headers:
            x-correlation-id:
              description: A unique identifier assigned to each request, facilitating issue tracing. In the event that a problem arises with a request, this ID can be provided to Bank of London support team for assistance.
              schema:
                type: string
              example: '2579248247516384065'
              required: true
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/CHAPSSinglePayment'
        '400':
          $ref: '#/components/responses/CreateChapsBadRequestError'
        '401':
          $ref: '#/components/responses/PaymentUnauthorizedError'
        '403':
          $ref: '#/components/responses/PaymentForbiddenError'
        '404':
          $ref: '#/components/responses/BankAccountNotFoundError'
        '409':
          $ref: '#/components/responses/ErrorResponseConflictIdempotencyId'
        '422':
          $ref: '#/components/responses/CreateChapsPaymentUnprocessableError'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      tags:
      - Payments V2
  /v2/payments/agency:
    post:
      operationId: CreateAgencyPayment
      summary: Create an Agency Payment
      description: '**Attention** \

        This endpoint requires specific permissions and is restricted to clients who have been granted access.


        This operation initiates a payment in the context of

        an application registered with Bank of London Developer Studio. It takes a request body

        that contains all the necessary information required to issue a single payment.


        This endpoint is used to initiate a Faster Payment (FPS) on behalf of your end customer,

        where you (the agency client) are not the actual payer, but act as the conduit for clearing and settlement via the Bank of London.

        This model supports regulated financial institutions that offer embedded payment services to their own customers - such as fintech platforms,

        EMIs, or payment institutions - without requiring direct access to UK payment schemes.'
      parameters:
      - $ref: '#/components/parameters/JwsSignature'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                title: Nested Payment Request
                description: Payment object that is required to initiate a single Nested Debit payment.
                properties:
                  type:
                    type: string
                    enum:
                    - FPS_DEBIT
                  paymentType:
                    $ref: '#/components/schemas/PaymentType'
                  sender:
                    $ref: '#/components/schemas/PaymentSender'
                  recipient:
                    $ref: '#/components/schemas/PaymentRecipient'
                  originator:
                    $ref: '#/components/schemas/PaymentOriginator'
                  amount:
                    $ref: '#/components/schemas/PaymentAmount'
                  reference:
                    $ref: '#/components/schemas/PaymentReferenceRequest'
                  notes:
                    $ref: '#/components/schemas/PaymentNotes'
                  idempotencyId:
                    $ref: '#/components/schemas/IdempotencyId'
                required:
                - type
                - paymentType
                - sender
                - recipient
                - originator
                - amount
                - reference
                - idempotencyId
      responses:
        '202':
          description: "Accepted\n\n<span style=\"color:#f46d2a; font-size:14px; font-family:Inter;\">**Attention**</span> \\\n<span style=\"font-size:14px; font-family:Inter;\">Please note that the oneOf in the **body** below, is extensible and new objects can be \nreturned with a new payment **type** in the future without a major version change. Please ensure this is factored into your\napplication code.</span>\n"
          headers:
            x-correlation-id:
              description: A unique identifier assigned to each request, facilitating issue tracing. In the event that a problem arises with a request, this ID can be provided to Bank of London support team for assistance.
              schema:
                type: string
              example: '2579248247516384065'
              required: true
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/InternalSinglePayment'
                - $ref: '#/components/schemas/FPSSinglePayment'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/PaymentUnauthorizedError'
        '403':
          $ref: '#/components/responses/PaymentForbiddenError'
        '404':
          $ref: '#/components/responses/BankAccountNotFoundError'
        '409':
          $ref: '#/components/responses/ErrorResponseConflictIdempotencyId'
        '422':
          $ref: '#/components/responses/CreateFPSUnprocessableError'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      tags:
      - Payments V2
  /v2/payments:
    post:
      operationId: CreatePaymentV2
      summary: Create a Cross-border Payment
      description: '**Attention** \

        This endpoint requires specific permissions and is restricted to clients who have been granted access. If you would like to avail of this functionality, please reach out to our customer service team at client.partners@thebankoflondon.com to enable this functionality.


        This operation initiates a cross-border payment in the context of

        an application registered with Bank of London Developer Studio. It takes a request body

        that contains all the necessary information required to issue a

        cross-border payment.'
      parameters:
      - $ref: '#/components/parameters/JwsSignature'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/CrossBorderPaymentRequest'
            examples:
              DirectCrossBorderPayment:
                summary: Direct Cross-border Payment (USD to US Bank)
                value:
                  scheme: CROSSBORDER
                  debtor:
                    account:
                      accountId: GB-040075-12345678
                  amount:
                    currency: USD
                    value: '10000.50'
                  creditorAgent:
                    bic: CHASUS33XXX
                  creditor:
                    name: John Doe International Inc
                    postalAddress:
                      townName: New York
                      country: US
                    account:
                      iban: GB29NWBK60161331926819
                  reference:
                    unstructured: Cross-border invoice payment for international services - USD transfer to US bank
                  quoteId: 03967d18-5152-4f5a-9276-7f96c96f05ba
                  endToEndId: R5T-8WV2.N9K+L4M7
                  idempotencyId: 32ed5f75-638e-454c-a91b-ec16dc8f6e84
      responses:
        '202':
          description: "Accepted\n\n<span style=\"color:#f46d2a; font-size:14px; font-family:Inter;\">**Attention**</span> \\\n<span style=\"font-size:14px; font-family:Inter;\">Please note that the oneOf in the **body** below, is extensible and new objects can be \nreturned with a new payment **type** in the future without a major version change. Please ensure this is factored into your\napplication code.</span>\n"
          headers:
            x-correlation-id:
              description: A unique identifier assigned to each request, facilitating issue tracing. In the event that a problem arises with a request, this ID can be provided to Bank of London support team for assistance.
              schema:
                type: string
              example: '2579248247516384065'
              required: true
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/CrossBorderPaymentResponse'
              examples:
                DirectCrossBorderPaymentResponse:
                  summary: Direct Cross-border Payment Response (USD to US Bank via BIC)
                  value:
                    id: FItJ8s2G-aOUfXUFqzRXE
                    scheme: CROSSBORDER
                    debtor:
                      account:
                        accountId: GB-040075-12345678
                    amount:
                      currency: USD
                      value: '10000.50'
                    creditorAgent:
                      bic: CHASUS33XXX
                    creditor:
                      name: John Doe International Inc
                      postalAddress:
                        townName: New York
                        country: US
                      account:
                        iban: GB29NWBK60161331926819
                    reference:
                      unstructured: Cross-border invoice payment for international services - USD transfer to US bank
                    quoteId: 03967d18-5152-4f5a-9276-7f96c96f05ba
                    fxDetails:
                      exchangeRate: '1.2345'
                      sell:
                        currency: GBP
                        amount: '8100.41'
                      buy:
                        currency: USD
                        amount: '10000.50'
                    status:
                      identifier: PENDING
                    createdDateTime: '2024-11-01T12:15:00.000+00:00'
                    endToEndId: XB7K-9M2P.Q4R8+W3N5
                    plannedExecutionDate: '2024-11-01'
                    idempotencyId: 32ed5f75-638e-454c-a91b-ec16dc8f6e84
                    creator:
                      type: API
                      key: 03967d18-5152-4f5a-9276-7f96c96f05ba
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/PaymentUnauthorizedError'
        '403':
          $ref: '#/components/responses/PaymentForbiddenError'
        '404':
          $ref: '#/components/responses/BankAccountNotFoundError'
        '409':
          $ref: '#/components/responses/ErrorResponseConflictIdempotencyId'
        '422':
          $ref: '#/components/responses/CreateCrossBorderUnprocessableError'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '503':
          $ref: '#/components/responses

# --- truncated at 32 KB (131 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/the-bank-of-london/refs/heads/main/openapi/the-bank-of-london-payments-v2-api-openapi.yml