Allica Bank

Allica Bank Payment Details API

The Payment Details API from Allica Bank — 3 operation(s) for payment details.

GitHub OpenAPI
Business capability
Payment Initiation Management BC-1340.10

Operations 3

GET /domestic-payments/{DomesticPaymentId}/payment-details Get Payment Details #
GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details Get Payment Details #
GET /domestic-standing-orders/{DomesticStandingOrderId}/payment-details Get Payment Details #

Documentation

📖
Documentation
https://developer.api.ob.allica.bank/perry/developer/welcome
📖
APIReference
https://developer.api.ob.allica.bank/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml
📖
APIReference
https://developer.api.ob.allica.bank/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/payment-initiation-openapi.yaml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/allica-bank/refs/heads/main/openapi/allica-bank-payment-details-api-openapi.yml

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/allica-bank-payment-details-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

allica-bank-payment-details-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Payment Initiation API Specification Payment Details API
  description: '# PISP API Overview

    These APIs can be used to access PIS for Allica Business Rewards accounts.


    ## Base URL

    The base URL for all PIS APIs is: `https://rs1.api.ob.allica.bank/open-banking/v4.0/pisp/**`

    '
  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: 4.0.0
servers:
- url: /open-banking/v4.0/pisp
tags:
- name: Payment Details
paths:
  /domestic-payments/{DomesticPaymentId}/payment-details:
    get:
      tags:
      - Payment Details
      summary: Get Payment Details
      operationId: GetDomesticPaymentsDomesticPaymentIdPaymentDetails
      parameters:
      - name: DomesticPaymentId
        in: path
        description: DomesticPaymentId
        required: true
        schema:
          type: string
      - in: header
        name: x-fapi-auth-date
        required: false
        description: 'The time when the PSU last logged in with the TPP.

          All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:

          Sun, 10 Sep 2017 19:43:31 UTC'
        schema:
          type: string
          pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
      - in: header
        name: x-fapi-customer-ip-address
        required: false
        description: The PSU's IP address if the PSU is currently logged in with the TPP.
        schema:
          type: string
      - in: header
        name: x-fapi-interaction-id
        required: false
        description: An RFC4122 UID used as a correlation id.
        schema:
          type: string
      - in: header
        name: Authorization
        required: true
        description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        schema:
          type: string
      - in: header
        name: x-customer-user-agent
        description: Indicates the user-agent that the PSU is using.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Payment Details 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:
                type: object
                additionalProperties: false
                required:
                - Data
                properties:
                  Data:
                    type: object
                    additionalProperties: false
                    properties:
                      PaymentStatus:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          description: Payment status details.
                          required:
                          - PaymentTransactionId
                          - Status
                          - StatusUpdateDateTime
                          properties:
                            PaymentTransactionId:
                              description: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
                              type: string
                              minLength: 1
                              maxLength: 210
                            Status:
                              description: Status of a transfe, as assigned by the transaction administrator.
                              type: string
                              enum:
                              - Accepted
                              - AcceptedCancellationRequest
                              - AcceptedCreditSettlementCompleted
                              - AcceptedCustomerProfile
                              - AcceptedFundsChecked
                              - AcceptedSettlementCompleted
                              - AcceptedSettlementInProcess
                              - AcceptedTechnicalValidation
                              - AcceptedWithChange
                              - AcceptedWithoutPosting
                              - Cancelled
                              - NoCancellationProcess
                              - PartiallyAcceptedCancellationRequest
                              - PartiallyAcceptedTechnicalCorrect
                              - PaymentCancelled
                              - Pending
                              - PendingCancellationRequest
                              - Received
                              - Rejected
                              - RejectedCancellationRequest
                            StatusUpdateDateTime:
                              description: 'Date and time at which the status was assigned to the transfer.All dates in the JSON payloads are represented in ISO 8601 date-time format.

                                All date-time fields in responses must include the timezone. An example is below:

                                2017-04-05T10:43:07+00:00'
                              type: string
                              format: date-time
                            StatusDetail:
                              type: object
                              additionalProperties: false
                              required:
                              - Status
                              description: Payment status details as per underlying Payment Rail.
                              properties:
                                LocalInstrument:
                                  description: 'User community specific instrument.

                                    Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.'
                                  type: string
                                  x-namespaced-enum:
                                  - UK.OBIE.BACS
                                  - UK.OBIE.BalanceTransfer
                                  - UK.OBIE.CHAPS
                                  - UK.OBIE.Euro1
                                  - UK.OBIE.FPS
                                  - UK.OBIE.Link
                                  - UK.OBIE.MoneyTransfer
                                  - UK.OBIE.Paym
                                  - UK.OBIE.SEPACreditTransfer
                                  - UK.OBIE.SEPAInstantCreditTransfer
                                  - UK.OBIE.SWIFT
                                  - UK.OBIE.Target2
                                Status:
                                  description: Status of a transfer, as assigned by the transaction administrator.
                                  type: string
                                  minLength: 1
                                  maxLength: 128
                                StatusReason:
                                  description: Reason Code provided for the status of a transfer.
                                  type: string
                                  enum:
                                  - Cancelled
                                  - PendingFailingSettlement
                                  - PendingSettlement
                                  - Proprietary
                                  - ProprietaryRejection
                                  - Suspended
                                  - Unmatched
                                StatusReasonDescription:
                                  description: Reason provided for the status of a transfer.
                                  type: string
                                  minLength: 1
                                  maxLength: 256
                  Links:
                    type: object
                    additionalProperties: false
                    description: Links relevant to the payload
                    properties:
                      Self:
                        type: string
                        format: uri
                      First:
                        type: string
                        format: uri
                      Prev:
                        type: string
                        format: uri
                      Next:
                        type: string
                        format: uri
                      Last:
                        type: string
                        format: uri
                    required:
                    - Self
                  Meta:
                    title: MetaData
                    type: object
                    additionalProperties: false
                    description: Meta Data relevant to the payload
                    properties:
                      TotalPages:
                        type: integer
                        format: int32
                      FirstAvailableDateTime:
                        description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format.

                          All date-time fields in responses must include the timezone. An example is below:

                          2017-04-05T10:43:07+00:00'
                        type: string
                        format: date-time
                      LastAvailableDateTime:
                        description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format.

                          All date-time fields in responses must include the timezone. An example is below:

                          2017-04-05T10:43:07+00:00'
                        type: string
                        format: date-time
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                - Data
                properties:
                  Data:
                    type: object
                    additionalProperties: false
                    properties:
                      PaymentStatus:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          description: Payment status details.
                          required:
                          - PaymentTransactionId
                          - Status
                          - StatusUpdateDateTime
                          properties:
                            PaymentTransactionId:
                              description: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
                              type: string
                              minLength: 1
                              maxLength: 210
                            Status:
                              description: Status of a transfe, as assigned by the transaction administrator.
                              type: string
                              enum:
                              - Accepted
                              - AcceptedCancellationRequest
                              - AcceptedCreditSettlementCompleted
                              - AcceptedCustomerProfile
                              - AcceptedFundsChecked
                              - AcceptedSettlementCompleted
                              - AcceptedSettlementInProcess
                              - AcceptedTechnicalValidation
                              - AcceptedWithChange
                              - AcceptedWithoutPosting
                              - Cancelled
                              - NoCancellationProcess
                              - PartiallyAcceptedCancellationRequest
                              - PartiallyAcceptedTechnicalCorrect
                              - PaymentCancelled
                              - Pending
                              - PendingCancellationRequest
                              - Received
                              - Rejected
                              - RejectedCancellationRequest
                            StatusUpdateDateTime:
                              description: 'Date and time at which the status was assigned to the transfer.All dates in the JSON payloads are represented in ISO 8601 date-time format.

                                All date-time fields in responses must include the timezone. An example is below:

                                2017-04-05T10:43:07+00:00'
                              type: string
                              format: date-time
                            StatusDetail:
                              type: object
                              additionalProperties: false
                              required:
                              - Status
                              description: Payment status details as per underlying Payment Rail.
                              properties:
                                LocalInstrument:
                                  description: 'User community specific instrument.

                                    Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.'
                                  type: string
                                  x-namespaced-enum:
                                  - UK.OBIE.BACS
                                  - UK.OBIE.BalanceTransfer
                                  - UK.OBIE.CHAPS
                                  - UK.OBIE.Euro1
                                  - UK.OBIE.FPS
                                  - UK.OBIE.Link
                                  - UK.OBIE.MoneyTransfer
                                  - UK.OBIE.Paym
                                  - UK.OBIE.SEPACreditTransfer
                                  - UK.OBIE.SEPAInstantCreditTransfer
                                  - UK.OBIE.SWIFT
                                  - UK.OBIE.Target2
                                Status:
                                  description: Status of a transfer, as assigned by the transaction administrator.
                                  type: string
                                  minLength: 1
                                  maxLength: 128
                                StatusReason:
                                  description: Reason Code provided for the status of a transfer.
                                  type: string
                                  enum:
                                  - Cancelled
                                  - PendingFailingSettlement
                                  - PendingSettlement
                                  - Proprietary
                                  - ProprietaryRejection
                                  - Suspended
                                  - Unmatched
                                StatusReasonDescription:
                                  description: Reason provided for the status of a transfer.
                                  type: string
                                  minLength: 1
                                  maxLength: 256
                  Links:
                    type: object
                    additionalProperties: false
                    description: Links relevant to the payload
                    properties:
                      Self:
                        type: string
                        format: uri
                      First:
                        type: string
                        format: uri
                      Prev:
                        type: string
                        format: uri
                      Next:
                        type: string
                        format: uri
                      Last:
                        type: string
                        format: uri
                    required:
                    - Self
                  Meta:
                    title: MetaData
                    type: object
                    additionalProperties: false
                    description: Meta Data relevant to the payload
                    properties:
                      TotalPages:
                        type: integer
                        format: int32
                      FirstAvailableDateTime:
                        description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format.

                          All date-time fields in responses must include the timezone. An example is below:

                          2017-04-05T10:43:07+00:00'
                        type: string
                        format: date-time
                      LastAvailableDateTime:
                        description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format.

                          All date-time fields in responses must include the timezone. An example is below:

                          2017-04-05T10:43:07+00:00'
                        type: string
                        format: date-time
            application/jose+jwe:
              schema:
                type: object
                additionalProperties: false
                required:
                - Data
                properties:
                  Data:
                    type: object
                    additionalProperties: false
                    properties:
                      PaymentStatus:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          description: Payment status details.
                          required:
                          - PaymentTransactionId
                          - Status
                          - StatusUpdateDateTime
                          properties:
                            PaymentTransactionId:
                              description: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
                              type: string
                              minLength: 1
                              maxLength: 210
                            Status:
                              description: Status of a transfe, as assigned by the transaction administrator.
                              type: string
                              enum:
                              - Accepted
                              - AcceptedCancellationRequest
                              - AcceptedCreditSettlementCompleted
                              - AcceptedCustomerProfile
                              - AcceptedFundsChecked
                              - AcceptedSettlementCompleted
                              - AcceptedSettlementInProcess
                              - AcceptedTechnicalValidation
                              - AcceptedWithChange
                              - AcceptedWithoutPosting
                              - Cancelled
                              - NoCancellationProcess
                              - PartiallyAcceptedCancellationRequest
                              - PartiallyAcceptedTechnicalCorrect
                              - PaymentCancelled
                              - Pending
                              - PendingCancellationRequest
                              - Received
                              - Rejected
                              - RejectedCancellationRequest
                            StatusUpdateDateTime:
                              description: 'Date and time at which the status was assigned to the transfer.All dates in the JSON payloads are represented in ISO 8601 date-time format.

                                All date-time fields in responses must include the timezone. An example is below:

                                2017-04-05T10:43:07+00:00'
                              type: string
                              format: date-time
                            StatusDetail:
                              type: object
                              additionalProperties: false
                              required:
                              - Status
                              description: Payment status details as per underlying Payment Rail.
                              properties:
                                LocalInstrument:
                                  description: 'User community specific instrument.

                                    Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.'
                                  type: string
                                  x-namespaced-enum:
                                  - UK.OBIE.BACS
                                  - UK.OBIE.BalanceTransfer
                                  - UK.OBIE.CHAPS
                                  - UK.OBIE.Euro1
                                  - UK.OBIE.FPS
                                  - UK.OBIE.Link
                                  - UK.OBIE.MoneyTransfer
                                  - UK.OBIE.Paym
                                  - UK.OBIE.SEPACreditTransfer
                                  - UK.OBIE.SEPAInstantCreditTransfer
                                  - UK.OBIE.SWIFT
                                  - UK.OBIE.Target2
                                Status:
                                  description: Status of a transfer, as assigned by the transaction administrator.
                                  type: string
                                  minLength: 1
                                  maxLength: 128
                                StatusReason:
                                  description: Reason Code provided for the status of a transfer.
                                  type: string
                                  enum:
                                  - Cancelled
                                  - PendingFailingSettlement
                                  - PendingSettlement
                                  - Proprietary
                                  - ProprietaryRejection
                                  - Suspended
                                  - Unmatched
                                StatusReasonDescription:
                                  description: Reason provided for the status of a transfer.
                                  type: string
                                  minLength: 1
                                  maxLength: 256
                  Links:
                    type: object
                    additionalProperties: false
                    description: Links relevant to the payload
                    properties:
                      Self:
                        type: string
                        format: uri
                      First:
                        type: string
                        format: uri
                      Prev:
                        type: string
                        format: uri
                      Next:
                        type: string
                        format: uri
                      Last:
                        type: string
                        format: uri
                    required:
                    - Self
                  Meta:
                    title: MetaData
                    type: object
                    additionalProperties: false
                    description: Meta Data relevant to the payload
                    properties:
                      TotalPages:
                        type: integer
                        format: int32
                      FirstAvailableDateTime:
                        description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format.

                          All date-time fields in responses must include the timezone. An example is below:

                          2017-04-05T10:43:07+00:00'
                        type: string
                        format: date-time
                      LastAvailableDateTime:
                        description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format.

                          All date-time fields in responses must include the timezone. An example is below:

                          2017-04-05T10:43:07+00:00'
                        type: string
                        format: date-time
        '400':
          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:
                description: An array of detail error codes, and messages, and URLs to documentation to help remediation.
                type: object
                additionalProperties: false
                properties:
                  Code:
                    description: High level textual error code, to help categorize the errors.
                    type: string
                    minLength: 1
                    maxLength: 40
                  Id:
                    description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
                    type: string
                    minLength: 1
                    maxLength: 40
                  Message:
                    description: Brief Error message, e.g., 'There is something wrong with the request parameters provided'
                    type: string
                    minLength: 1
                    maxLength: 500
                  Errors:
                    items:
                      type: object
                      additionalProperties: false
                      properties:
                        ErrorCode:
                          description: Low level textual error code, e.g., UK.OBIE.Field.Missing
                          type: string
                          x-namespaced-enum:
                          - UK.OBIE.Field.Expected
                          - UK.OBIE.Field.Invalid
                          - UK.OBIE.Field.InvalidDate
                          - UK.OBIE.Field.Missing
                          - UK.OBIE.Field.Unexpected
                          - UK.OBIE.Header.Invalid
                          - UK.OBIE.Header.Missing
                          - UK.OBIE.Reauthenticate
                          - UK.OBIE.Resource.ConsentMismatch
                          - UK.OBIE.Resource.InvalidConsentStatus
                          - UK.OBIE.Resource.InvalidFormat
                          - UK.OBIE.Resource.NotFound
                          - UK.OBIE.Rules.AfterCutOffDateTime
                          - UK.OBIE.Rules.DuplicateReference
                          - UK.OBIE.Signature.Invalid
                          - UK.OBIE.Signature.InvalidClaim
                          - UK.OBIE.Signature.Malformed
                          - UK.OBIE.Signature.Missing
                          - UK.OBIE.Signature.MissingClaim
                          - UK.OBIE.Signature.Unexpected
                          - UK.OBIE.UnexpectedError
                          - UK.OBIE.Unsupported.AccountIdentifier
                          - UK.OBIE.Unsupported.AccountSecondaryIdentifier
                          - UK.OBIE.Unsupported.Currency
                          - UK.OBIE.Unsupported.Frequency
                          - UK.OBIE.Unsupported.LocalInstrument
                          - UK.OBIE.Unsupported.Scheme
                        Message:
                          description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future''

                            OBIE doesn''t standardise this field'
                          type: string
                          minLength: 1
                          maxLength: 500
                        Path:
                          description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
                          type: string
                          minLength: 1
                          maxLength: 500
                        Url:
                          description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc
                          type: string
                      required:
                      - ErrorCode
                      - Message
                      minProperties: 1
                    type: array
                    minItems: 1
                required:
                - Code
                - Message
                - Errors
            application/json:
              schema:
                description: An array of detail error codes, and messages, and URLs to documentation to help remediation.
                type: object
                additionalProperties: false
                properties:
                  Code:
                    description: High level textual error code, to help categorize the errors.
                    type: string
                    minLength: 1
                    maxLength: 40
                  Id:
                    description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
                    type: string
                    minLength: 1
                    maxLength: 40
                  Message:
                    description: Brief Error message, e.g., 'There is something wrong with the request parameters provided'
                    type: string
                    minLength: 1
                    maxLength: 500
                  Errors:
                    items:
                      type: object
                      additionalProperties: false
                      properties:
                        ErrorCode:
                          description: Low level textual error code, e.g., UK.OBIE.Field.Missing
                          type: string
                          x-namespaced-enum:
                          - UK.OBIE.Field.Expected
                          - UK.OBIE.Field.Invalid
                          - UK.OBIE.Field.InvalidDate
                          - UK.OBIE.Field.Missing
                          - UK.OBIE.Field.Unexpected
                          - UK.OBIE.Header.Invalid
                          - UK.OBIE.Header.Missing
                          - UK.OBIE.Reauthenticate
                          - UK.OBIE.Resource.ConsentMismatch
                          - UK.OBIE.Resource.InvalidConsentStatus
                          - UK.OBIE.Resource.InvalidFormat
                          - UK.OBIE.Resource.NotFound
                          - UK.OBIE.Rules.AfterCutOffDateTime
                          - UK.OBIE.Rules.DuplicateReference
                          - UK.OBIE.Signature.Invalid
                          - UK.OBIE.Signature.InvalidClaim
                          - UK.OBIE.Signature.Malformed
                          - UK.OBIE.Signature.Missing
                          - UK.OBIE.Signature.MissingClaim
                          - UK.OBIE.Signature.Unexpected
                          - UK.OBIE.UnexpectedError
                          - UK.OBIE.Unsupported.AccountIdentifier
                          - UK.OBIE.Unsupported.AccountSecondaryIdentifier
                          - UK.OBIE.Unsupported.Currency
                          - UK.OBIE.Unsupported.Frequency
                          - UK.OBIE.Unsupported.LocalInstrument
                   

# --- truncated at 32 KB (191 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/allica-bank/refs/heads/main/openapi/allica-bank-payment-details-api-openapi.yml