Vanquis Banking Group

Vanquis Banking Group File Payments API

The File Payments API from Vanquis Banking Group — 6 operation(s) for file payments.

GitHub OpenAPI
Business capability
Payment Initiation Management BC-1340.10

Operations 7

POST /file-payment-consents Create File Payment Consents #
GET /file-payment-consents/{ConsentId} Get File Payment Consents #
POST /file-payment-consents/{ConsentId}/file Create File Payment Consents #
GET /file-payment-consents/{ConsentId}/file Get File Payment Consents #
POST /file-payments Create File Payments #
GET /file-payments/{FilePaymentId} Get File Payments #
GET /file-payments/{FilePaymentId}/report-file Get File Payments #

Documentation

📖
Documentation
https://openbanking.atlassian.net/wiki/spaces/DZ/pages/937820271/Account+and+Transaction+API+Specification+-+v3.1
📖
APIReference
https://www.vanquis.com/developer-portal/
📖
Documentation
https://openbanking.atlassian.net/wiki/spaces/DZ/pages/937754701/Payment+Initiation+API+Specification+-+v3.1
📖
Documentation
https://openbanking.atlassian.net/wiki/spaces/DZ/pages/937951380/Confirmation+of+Funds+API+Specification+-+v3.1

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vanquis-banking-group/refs/heads/main/openapi/vanquis-banking-group-file-payments-api-openapi.yml

Other Resources

🔗
DeveloperPortal
https://www.vanquis.com/developer-portal/

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/vanquis-banking-group-file-payments-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

vanquis-banking-group-file-payments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Payment Initiation File Payments API
  description: Swagger for Payment Initiation 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.10
servers:
- url: /open-banking/v3.1/pisp
tags:
- name: File Payments
paths:
  /file-payment-consents:
    post:
      tags:
      - File Payments
      summary: Create File Payment Consents
      operationId: CreateFilePaymentConsents
      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/OBWriteFileConsent3'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteFileConsent3'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteFileConsent3'
        description: Default
        required: true
      responses:
        201:
          $ref: '#/components/responses/201FilePaymentConsentsCreated'
        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
  /file-payment-consents/{ConsentId}:
    get:
      tags:
      - File Payments
      summary: Get File Payment Consents
      operationId: GetFilePaymentConsentsConsentId
      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/200FilePaymentConsentsConsentIdRead'
        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
  /file-payment-consents/{ConsentId}/file:
    post:
      tags:
      - File Payments
      summary: Create File Payment Consents
      operationId: CreateFilePaymentConsentsConsentIdFile
      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-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/File'
          application/json:
            schema:
              $ref: '#/components/schemas/File'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/File'
        description: Default
        required: true
      responses:
        200:
          $ref: '#/components/responses/200FilePaymentConsentsConsentIdFileCreated'
        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
    get:
      tags:
      - File Payments
      summary: Get File Payment Consents
      operationId: GetFilePaymentConsentsConsentIdFile
      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/200FilePaymentConsentsConsentIdFileRead'
        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
  /file-payments:
    post:
      tags:
      - File Payments
      summary: Create File Payments
      operationId: CreateFilePayments
      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/OBWriteFile2'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteFile2'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteFile2'
        description: Default
        required: true
      responses:
        201:
          $ref: '#/components/responses/201FilePaymentsCreated'
        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
  /file-payments/{FilePaymentId}:
    get:
      tags:
      - File Payments
      summary: Get File Payments
      operationId: GetFilePaymentsFilePaymentId
      parameters:
      - $ref: '#/components/parameters/FilePaymentId'
      - $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/200FilePaymentsFilePaymentIdRead'
        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
  /file-payments/{FilePaymentId}/report-file:
    get:
      tags:
      - File Payments
      summary: Get File Payments
      operationId: GetFilePaymentsFilePaymentIdReportFile
      parameters:
      - $ref: '#/components/parameters/FilePaymentId'
      - $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/200FilePaymentsFilePaymentIdReportFileRead'
        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:
  responses:
    403Error:
      description: Forbidden
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: 'Header containing a detached JWS signature of the body of the payload.

            '
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
    500Error:
      description: Internal Server Error
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: 'Header containing a detached JWS signature of the body of the payload.

            '
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
    406Error:
      description: Not Acceptable
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    200FilePaymentsFilePaymentIdRead:
      description: File Payments Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: 'Header containing a detached JWS signature of the body of the payload.

            '
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
    201FilePaymentsCreated:
      description: File Payments Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: 'Header containing a detached JWS signature of the body of the payload.

            '
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
    200FilePaymentsFilePaymentIdReportFileRead:
      description: File Payments Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: 'Header containing a detached JWS signature of the body of the payload.

            '
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/File'
        application/json:
          schema:
            $ref: '#/components/schemas/File'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/File'
    405Error:
      description: Method Not Allowed
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    200FilePaymentConsentsConsentIdFileRead:
      description: File Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: 'Header containing a detached JWS signature of the body of the payload.

            '
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/File'
        application/json:
          schema:
            $ref: '#/components/schemas/File'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/File'
    201FilePaymentConsentsCreated:
      description: File Payment Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: 'Header containing a detached JWS signature of the body of the payload.

            '
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
    200FilePaymentConsentsConsentIdFileCreated:
      description: File Payment Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    429Error:
      description: Too Many Requests
      headers:
        Retry-After:
          description: Number in seconds to wait
          schema:
            type: integer
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    200FilePaymentConsentsConsentIdRead:
      description: File Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: 'Header containing a detached JWS signature of the body of the payload.

            '
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
    401Error:
      description: Unauthorized
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    415Error:
      description: Unsupported Media Type
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    404Error:
      description: Not found
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    400Error:
      description: Bad request
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: 'Header containing a detached JWS signature of the body of the payload.

            '
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
  schemas:
    OBWriteFileConsent3:
      type: object
      additionalProperties: false
      required:
      - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
          - Initiation
          properties:
            Initiation:
              type: object
              additionalProperties: false
              required:
              - FileType
              - FileHash
              description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
              properties:
                FileType:
                  description: Specifies the payment file type.
                  type: string
                  x-namespaced-enum:
                  - UK.OBIE.PaymentInitiation.3.1
                  - UK.OBIE.pain.001.001.08
                FileHash:
                  description: A base64 encoding of a SHA256 hash of the file to be uploaded.
                  type: string
                  minLength: 1
                  maxLength: 44
                FileReference:
                  description: Reference for the file.
                  type: string
                  minLength: 1
                  maxLength: 40
                NumberOfTransactions:
                  description: Number of individual transactions contained in the payment information group.
                  type: string
                  pattern: '[0-9]{1,15}'
                ControlSum:
                  description: Total of all individual amounts included in the group, irrespective of currencies.
                  type: number
                RequestedExecutionDateTime:
                  description: "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.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
                LocalInstrument:
                  $ref: '#/components/schemas/OBExternalLocalInstrument1Code'
                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'
                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'
            Authorisation:
              type: object
              additionalProperties: false
              required:
              - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested.
                  type: string
                  enum:
                  - Any
                  - Single
                CompletionDateTime:
                  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
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
    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.
    Meta:
      title: MetaData
      type: object
      additionalProperties: false
      description: Meta Data relevant to the payload
      properties:
        TotalPages:
          type: integer
          format: int32
        FirstAvailableDateTime:
          $ref: '#/components/schemas/ISODateTime'
        LastAvailableDateTime:
          $ref: '#/components/schemas/ISODateTime'
    ActiveOrHistoricCurrencyCode:
      description: 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".
      type: string
      pattern: ^[A-Z]{3,3}$
    OBCashAccountDebtor4:
      type: object
      description: ^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent.
      properties:
        SchemeName:
          type: string
          description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code
        Identification:
          type: string
          description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text
        Name:
          type: string
          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.
        SecondaryIdentification:
          type: string
          description: ^ 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
    OBWriteFile2:
      type: object
      additionalProperties: false
      required:
      - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
          - ConsentId
          - Initiation
          properties:
            ConsentId:
              description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.'
              type: string
              minLength: 1
              maxLength: 128
            Initiation:
              type: object
              additionalProperties: false
              required:
              - FileType
              - FileHash
              description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
              properties:
                FileType:
                  description: Specifies the payment file type.
                  type: string
                  x-namespaced-enum:
                  - UK.OBIE.PaymentInitiation.3.1
                  - UK.OBIE.pain.001.001.08
                FileHash:
                  description: A base64 encoding of a SHA256 hash of the file to be uploaded.
                  type: string
                  minLength: 1
                  maxLength: 44
                FileReference:
                  description: Reference for the file.
                  type: string
                  minLength: 1
                  maxLength: 40
                NumberOfTransactions:
                  description: Number of individual transactions contained in the payment information group.
                  type: string
                  pattern: '[0-9]{1,15}'
                ControlSum:
                  description: Total of all individual amounts included in the group, irrespective of currencies.
                  type: number
                RequestedExecutionDateTime:
                  description: "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.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
                LocalInstrument:
                  $ref: '#/components/schemas/OBExternalLocalInstrument1Code'
                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'
                RemittanceInformation:
                  type: object
                  additionalProperties: false
                  description: Information supplied to enable the matching of an entry with the items that the transfer is 

# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vanquis-banking-group/refs/heads/main/openapi/vanquis-banking-group-file-payments-api-openapi.yml