Skip to main content
GET
/
payment-consents
/
{ConsentId}
Error
A valid request URL is required to generate request examples
{
  "iss": "<string>",
  "exp": 123,
  "nbf": 123,
  "message": {
    "Data": {
      "ConsentId": "aac-69255d98-ab0e-4758-92a7-cacbf3073efa",
      "BaseConsentId": "abc-19877d98-ab0e-4758-92a7-vvffr1234abv",
      "ExpirationDateTime": "2023-11-07T05:31:56Z",
      "Status": "AwaitingAuthorization",
      "CreationDateTime": "2023-11-07T05:31:56Z",
      "StatusUpdateDateTime": "2023-11-07T05:31:56Z",
      "ControlParameters": {
        "IsDelegatedAuthentication": true,
        "ConsentSchedule": {
          "SinglePayment": {
            "Type": "SingleInstantPayment",
            "Amount": {
              "Amount": "100.00",
              "Currency": "AED"
            }
          },
          "MultiPayment": {
            "PeriodicSchedule": {
              "Type": "FixedDefinedSchedule",
              "Schedule": [
                {
                  "PaymentExecutionDate": "2023-12-25",
                  "Amount": {
                    "Amount": "100.00",
                    "Currency": "AED"
                  }
                }
              ]
            },
            "MaximumCumulativeValueOfPayments": {
              "Amount": "100.00",
              "Currency": "AED"
            },
            "MaximumCumulativeNumberOfPayments": 123
          },
          "FilePayment": {
            "FileType": "<string>",
            "FileHash": "<string>",
            "NumberOfTransactions": 123,
            "ControlSum": "100.00",
            "FileReference": "<string>",
            "RequestedExecutionDate": "2023-12-25"
          }
        }
      },
      "PaymentPurposeCode": "<string>",
      "PaymentConsumption": {
        "CumulativeNumberOfPayments": 4,
        "CumulativeValueOfPayments": {
          "Amount": "100.00",
          "Currency": "AED"
        },
        "CumulativeNumberOfPaymentsInCurrentPeriod": 1,
        "CumulativeValueOfPaymentsInCurrentPeriod": {
          "Amount": "100.00",
          "Currency": "AED"
        }
      },
      "IsSingleAuthorization": true,
      "AuthorizationExpirationDateTime": "2023-11-07T05:31:56Z",
      "Permissions": [
        "ReadAccountsBasic"
      ],
      "RevokedBy": "LFI",
      "Charges": [
        {
          "ChargeBearer": "BorneByCreditor",
          "Type": "VAT",
          "Amount": {
            "Amount": "100.00",
            "Currency": "AED"
          }
        }
      ],
      "ExchangeRate": {
        "UnitCurrency": "<string>",
        "ExchangeRate": 123,
        "RateType": "Actual",
        "ContractIdentification": "<string>",
        "ExpirationDateTime": "2023-11-07T05:31:56Z"
      },
      "CurrencyRequest": {
        "ExtendedPurpose": "<string>",
        "CurrencyOfTransfer": "<string>",
        "InstructionPriority": "Normal",
        "ChargeBearer": "BorneByCreditor",
        "DestinationCountryCode": "<string>",
        "ExchangeRateInformation": {
          "UnitCurrency": "<string>",
          "RateType": "Actual",
          "ExchangeRate": 123,
          "ContractIdentification": "<string>"
        }
      },
      "DebtorReference": "<string>",
      "CreditorReference": "<string>",
      "SponsoredTPPInformation": {
        "Name": "<string>",
        "Identification": "<string>"
      },
      "OpenFinanceBilling": {
        "IsLargeCorporate": true
      }
    },
    "Links": {
      "Self": "https://api.lfi.sa/open-banking/payment/2023.11.01-final/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa",
      "Related": []
    },
    "Subscription": {
      "Webhook": {
        "Url": "https://api.tpp.com/webhook/callbackUrl",
        "IsActive": false
      }
    },
    "Meta": {
      "MultipleAuthorizers": {
        "TotalRequired": 123,
        "Authorizations": [
          {
            "AuthorizerId": "<string>",
            "AuthorizerType": "<string>",
            "AuthorizationDate": "2023-11-07T05:31:56Z",
            "AuthorizationStatus": "Pending"
          }
        ]
      }
    }
  },
  "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

​
ConsentId
string
required

Unique identification as assigned by the LFI to uniquely identify the Consent resource

Response

Payment Consent Retrieve