Skip to main content
GET
/
file-payments
/
{PaymentId}
Error
A valid request URL is required to generate request examples
{
  "iss": "<string>",
  "exp": 123,
  "nbf": 123,
  "message": {
    "Data": {
      "PaymentId": "83b47199-90c2-4c05-9ef1-aeae68b0fc7c",
      "ConsentId": "aac-69255d98-ab0e-4758-92a7-cacbf3073efa",
      "Status": "Received",
      "StatusUpdateDateTime": "2023-11-07T05:31:56Z",
      "CreationDateTime": "2023-11-07T05:31:56Z",
      "Instruction": {
        "FileType": "<string>",
        "FileHash": "<string>",
        "NumberOfTransactions": 123,
        "ControlSum": "100.00",
        "FileReference": "<string>",
        "RequestedExecutionDate": "2023-12-25"
      },
      "PaymentPurposeCode": "<string>",
      "Charges": [
        {
          "ChargeBearer": "BorneByCreditor",
          "Type": "VAT",
          "Amount": {
            "Amount": "100.00",
            "Currency": "AED"
          }
        }
      ],
      "OpenFinanceBilling": {
        "NumberOfSuccessfulTransactions": 123
      }
    },
    "Links": {
      "Self": "https://api.lfi.sa/open-banking/payment/2023.11.01-final/payments/83b47199-90c2-4c05-9ef1-aeae68b0fc7c",
      "Related": "https://api.lfi.sa/open-banking/payment/2023.11.01-final/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa"
    },
    "Meta": {}
  },
  "aud": [
    "<string>"
  ],
  "iat": 123
}

Authorizations

​
Authorization
string
header
required

TPP confidential client authorization with the LFI to stage a consent. Please refer to OpenID FAPI Security Profile 1.0 -Part 2 Advanced - 5.2.2 point 14 - shall authenticate the confidential client using one of the following methods private_key_jwt and OpenID Connect Core 1.0 9. Client Authentication private_key_jwt

Headers

​
authorization
string
required

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

​
x-fapi-auth-date
string

The time when the User 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 2023 19:43:31 UTC

​
x-fapi-customer-ip-address
string

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

​
x-fapi-interaction-id
string

An RFC4122 UID used as a correlation id.

​
x-customer-user-agent
string

Indicates the user-agent that the User is using.

Path Parameters

​
PaymentId
string
required

Unique identification as assigned by the LFI to uniquely identify the payment resource.

Required string length: 1 - 40

Response

File Payment Id