OPopenbankinguk
File Payments

Get a File Payment by FilePaymentId

Changed on

Enables a PISP to retrieve the status of a file payment.

get/file-payments/{FilePaymentId}

Request

  • Base URL
    /open-banking/v4.0/pisp (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /open-banking/v4.0/pisp/file-payments/{FilePaymentId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://authserver.example/token scopes: payments

Path parameters

FilePaymentIdstring required

FilePaymentId

Headers

x-fapi-auth-datestring

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

x-fapi-customer-ip-addressstring

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstring required

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

x-client-idstring

Only used if an ASPSP requires the client ID in order to return rate limit headers.

TPPs must refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.

This header must not be used for client authentication

Response

File Payments Read

Example response

{
  "Data": {
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN"
      }
    ],
    "Initiation": {
      "CreditorAgent": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "UltimateDebtor": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "RemittanceInformation": {
        "Structured": [
          {
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562"
          }
        ]
      }
    },
    "Debtor": {
      "LEI": "IZ9Q00LZEVUKWCQY6X15"
    }
  }
}

Changes

  • 5dbf59c53db8Revision changes
    • info

      added the new optional header request parameter x-client-id

  • 2e4e040f09e0Revision changes
    • breaking

      the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/json; charset=utf-8)

    • breaking

      the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/json)

    • breaking

      the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/jose+jwe)

    • info

      the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/json; charset=utf-8)

    • info

      the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/json)

    • info

      the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/jose+jwe)