Retrieve Payment Consents by BaseConsentId

Retrieve all Payment Consents for an BaseConsentId

GET /payment-consents

Error

A valid request URL is required to generate request examples

200

{
  "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",
        "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": [],
        "Charges": [
          {
            "Amount": {
              "Amount": "100.00",
              "Currency": "AED"
            }
          }
        ],
        "ExchangeRate": {
          "UnitCurrency": "<string>",
          "ExchangeRate": 123,
          "ContractIdentification": "<string>",
          "ExpirationDateTime": "2023-11-07T05:31:56Z"
        },
        "CurrencyRequest": {
          "ExtendedPurpose": "<string>",
          "CurrencyOfTransfer": "<string>",
          "DestinationCountryCode": "<string>",
          "ExchangeRateInformation": {
            "UnitCurrency": "<string>",
            "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"
            }
          ]
        }
      }
    }
  ],
  "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

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)$

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.

Query Parameters

baseConsentId · string · required

A specific baseConsentId. For example:

baseConsentId=abc-19877d98-ab0e-4758-92a7-vvffr1234abv

Response

200

application/jwt

Retrieve Payment Consents by BaseConsentId

Payment Consents By BaseConsentId Response Signed Schema

iss · string · required

https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1

exp · number · required

https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4

nbf · number · required

https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5

message · object[] · required

Show child attributes

aud · string[]

https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3

iat · number

https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6