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": "Pending",
"StatusUpdateDateTime": "2023-11-07T05:31:56Z",
"CreationDateTime": "2023-11-07T05:31:56Z",
"Instruction": {
"Amount": {
"Amount": "100.00",
"Currency": "AED"
}
},
"PaymentPurposeCode": "<string>",
"OpenFinanceBilling": {
"Type": "Collection",
"MerchantId": "<string>"
},
"PaymentTransactionId": "<string>",
"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>"
},
"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
}{
"iss": "c50f0152-49bb-4dc4-b866-b625271c4e78",
"exp": 3349494246,
"nbf": 1675765189,
"aud": [
"e63df191-5fff-4e9c-bba2-b273c94e87f0"
],
"iat": 1675765189,
"message": {
"Errors": [
{
"Code": "GenericError",
"Message": {
"en": "A mandatory field is missing."
}
}
]
}
}{
"iss": "c50f0152-49bb-4dc4-b866-b625271c4e78",
"exp": 3349494246,
"nbf": 1675765189,
"aud": [
"e63df191-5fff-4e9c-bba2-b273c94e87f0"
],
"iat": 1675765189,
"message": {
"Errors": [
{
"Code": "AccessToken.InvalidScope",
"Message": {
"en": "The access token did not have an appropriate scope attached to it."
}
}
]
}
}{
"iss": "c50f0152-49bb-4dc4-b866-b625271c4e78",
"exp": 3349494246,
"nbf": 1675765189,
"aud": [
"e63df191-5fff-4e9c-bba2-b273c94e87f0"
],
"iat": 1675765189,
"message": {
"Errors": [
{
"Code": "GenericError",
"Message": {
"en": "An Internal Server error has occurred. Please retry in 60 seconds."
}
}
]
}
}Retrieve a Payment
Retrieve a Payment
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": "Pending",
"StatusUpdateDateTime": "2023-11-07T05:31:56Z",
"CreationDateTime": "2023-11-07T05:31:56Z",
"Instruction": {
"Amount": {
"Amount": "100.00",
"Currency": "AED"
}
},
"PaymentPurposeCode": "<string>",
"OpenFinanceBilling": {
"Type": "Collection",
"MerchantId": "<string>"
},
"PaymentTransactionId": "<string>",
"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>"
},
"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
}{
"iss": "c50f0152-49bb-4dc4-b866-b625271c4e78",
"exp": 3349494246,
"nbf": 1675765189,
"aud": [
"e63df191-5fff-4e9c-bba2-b273c94e87f0"
],
"iat": 1675765189,
"message": {
"Errors": [
{
"Code": "GenericError",
"Message": {
"en": "A mandatory field is missing."
}
}
]
}
}{
"iss": "c50f0152-49bb-4dc4-b866-b625271c4e78",
"exp": 3349494246,
"nbf": 1675765189,
"aud": [
"e63df191-5fff-4e9c-bba2-b273c94e87f0"
],
"iat": 1675765189,
"message": {
"Errors": [
{
"Code": "AccessToken.InvalidScope",
"Message": {
"en": "The access token did not have an appropriate scope attached to it."
}
}
]
}
}{
"iss": "c50f0152-49bb-4dc4-b866-b625271c4e78",
"exp": 3349494246,
"nbf": 1675765189,
"aud": [
"e63df191-5fff-4e9c-bba2-b273c94e87f0"
],
"iat": 1675765189,
"message": {
"Errors": [
{
"Code": "GenericError",
"Message": {
"en": "An Internal Server error has occurred. Please retry in 60 seconds."
}
}
]
}
}Authorizations
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
An authorization Token as per https://tools.ietf.org/html/rfc6750
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
^(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)$The User's IP address if the User is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
Indicates the user-agent that the User is using.
Path Parameters
Unique identification as assigned by the LFI to uniquely identify the payment resource.
1 - 40Response
Payment Id
Payment Response Signed Schema
Payment Id Response Schema
Show child attributes
Show child attributes
Was this page helpful?

