Consents

Create

The API allows the TPP to ask an ASPSP to create a new payment-access-consent resource.

CURL

curl -i  \ 
 -H "Authorization: Bearer authorization" \ 
 -H "Content-Type: application/json" \ 
 -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ 
 -H "Accept: application/json" \ 
 -H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \ 
 -H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \ 
 -H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \ 
 -H "x-fapi-customer-ip-address: 104.25.212.99" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkF1dGhvcmlzYXRpb24iOnsiQXV0aG9yaXNhdGlvblR5cGUiOiJUQkQiLCJDb21wbGV0aW9uRGF0ZVRpbWUiOiJUQkQifSwiSW5pdGlhdGlvbiI6eyJJbnN0cnVjdGlvbklkZW50aWZpY2F0aW9uIjoiQU5TTTAyMyIsIkVuZFRvRW5kSWRlbnRpZmljYXRpb24iOiJGUkVTQ08uMjEzMDIuR0ZYLjM3IiwiTG9jYWxJbnN0cnVtZW50IjoiVUsuT0JJRS5TV0lGVCIsIkluc3RydWN0aW9uUHJpb3JpdHkiOiJVcmdlbnQiLCJQdXJwb3NlIjoiVEJEIiwiQ2hhcmdlQmVhcmVyIjoiVEJEIiwiQ3VycmVuY3lPZlRyYW5zZmVyIjoiRVVSIiwiSW5zdHJ1Y3RlZEFtb3VudCI6eyJBbW91bnQiOiIyMC4wMCIsIkN1cnJlbmN5IjoiR0JQIn0sIkV4Y2hhbmdlUmF0ZUluZm9ybWF0aW9uIjp7IlVuaXRDdXJyZW5jeSI6IkVVUiIsIkV4Y2hhbmdlUmF0ZSI6IjAuOTkiLCJSYXRlVHlwZSI6IlRCRCIsIkNvbnRyYWN0SWRlbnRpZmljYXRpb24iOiJUQkQifSwiQ3JlZGl0b3IiOnsiTmFtZSI6IkpvaG4gU21pdGgiLCJQb3N0YWxBZGRyZXNzIjp7IkFkZHJlc3NUeXBlIjoiQWRkcmVzcyB3aXRoIGhvdXNlIG51bWJlciBhbmQgc3RyZWV0IiwiRGVwYXJ0bWVudCI6IlByaW1lIE1pbmlzdGVyJ3MgT2ZmaWNlIiwiU3ViRGVwYXJ0bWVudCI6IkNhYmluZXQgT2ZmaWNlIiwiU3RyZWV0TmFtZSI6IlNpciBHZW9yZ2UgRG93bmluZyIsIkJ1aWxkaW5nTnVtYmVyIjoiMTAiLCJQb3N0Q29kZSI6IlNXMUEgMkFBIiwiVG93bk5hbWUiOiJDaXR5IG9mIFdlc3RtaW5zdGVyIExvbmRvbiwiLCJDb3VudHJ5U3ViRGl2aXNpb24iOiJMb25kb24iLCJDb3VudHJ5IjoiR0IiLCJBZGRyZXNzTGluZSI6WyIxMCBEb3duaW5nIFN0LCBXZXN0bWluc3RlciwgTG9uZG9uIFNXMUEgMkFBLCBVbml0ZWQgS2luZ2RvbSJdfX0sIkNyZWRpdG9yQWdlbnQiOnsiTmFtZSI6IkpvaG4gU21pdGgiLCJTY2hlbWVOYW1lIjoiVUsuT0JJRS5CSUNGSSIsIklkZW50aWZpY2F0aW9uIjoiMDgwODAwMjEzMjU2OTgiLCJQb3N0YWxBZGRyZXNzIjp7IkFkZHJlc3NUeXBlIjoiQWRkcmVzcyB3aXRoIGhvdXNlIG51bWJlciBhbmQgc3RyZWV0IiwiRGVwYXJ0bWVudCI6IlByaW1lIE1pbmlzdGVyJ3MgT2ZmaWNlIiwiU3ViRGVwYXJ0bWVudCI6IkNhYmluZXQgT2ZmaWNlIiwiU3RyZWV0TmFtZSI6IlNpciBHZW9yZ2UgRG93bmluZyIsIkJ1aWxkaW5nTnVtYmVyIjoiMTAiLCJQb3N0Q29kZSI6IlNXMUEgMkFBIiwiVG93bk5hbWUiOiJDaXR5IG9mIFdlc3RtaW5zdGVyIExvbmRvbiwiLCJDb3VudHJ5U3ViRGl2aXNpb24iOlsiTG9uZG9uIl0sIkNvdW50cnkiOiJHQiIsIkFkZHJlc3NMaW5lIjpbIjEwIERvd25pbmcgU3QsIFdlc3RtaW5zdGVyLCBMb25kb24gU1cxQSAyQUEsIFVuaXRlZCBLaW5nZG9tIl19fSwiRGVidG9yQWNjb3VudCI6eyJTY2hlbWVOYW1lIjoiVUsuT0JJRS5Tb3J0Q29kZUFjY291bnROdW1iZXIiLCJJZGVudGlmaWNhdGlvbiI6IjExMjgwMDAxMjM0NTY3IiwiTmFtZSI6IkFuZHJlYSBTbWl0aCIsIlNlY29uZGFyeUlkZW50aWZpY2F0aW9uIjoiMDAwMiJ9LCJDcmVkaXRvckFjY291bnQiOnsiU2NoZW1lTmFtZSI6IlVLLk9CSUUuU29ydENvZGVBY2NvdW50TnVtYmVyIiwiSWRlbnRpZmljYXRpb24iOiIwODA4MDAyMTMyNTY5OCIsIk5hbWUiOiJCb2IgQ2xlbWVudHMiLCJTZWNvbmRhcnlJZGVudGlmaWNhdGlvbiI6IjAwMDMifSwiUmVtaXR0YW5jZUluZm9ybWF0aW9uIjp7IlJlZmVyZW5jZSI6IkZSRVNDTy0wMzciLCJVbnN0cnVjdHVyZWQiOiJJbnRlcm5hbCBvcHMgY29kZSA1MTIwMTAzIn0sIlN1cHBsZW1lbnRhcnlEYXRhIjp7fX0sIlNDQVN1cHBvcnREYXRhIjp7IkFwcGxpZWRBdXRoZW50aWNhdGlvbkFwcHJvYWNoIjoiVEJEIiwiUmVmZXJlbmNlUGF5bWVudE9yZGVySWQiOiJUQkQiLCJSZXF1ZXN0ZWRTQ0FFeGVtcHRpb25UeXBlIjoiVEJEIn19LCJSaXNrIjp7IlBheW1lbnRDb250ZXh0Q29kZSI6IlBhcnR5VG9QYXJ0eSIsIk1lcmNoYW50Q2F0ZWdvcnlDb2RlIjoiVEJEIiwiTWVyY2hhbnRDdXN0b21lcklkZW50aWZpY2F0aW9uIjoiMDUzNTk4NjUzMjU0IiwiRGVsaXZlcnlBZGRyZXNzIjp7IkFkZHJlc3NMaW5lIjpbIjEwIERvd25pbmcgU3QsIFdlc3RtaW5zdGVyLCBMb25kb24gU1cxQSAyQUEsIFVuaXRlZCBLaW5nZG9tIl0sIlN0cmVldE5hbWUiOiJTaXIgR2VvcmdlIERvd25pbmciLCJCdWlsZGluZ051bWJlciI6IjEwIiwiUG9zdENvZGUiOiJTVzFBIDJBQSIsIlRvd25OYW1lIjoiQ2l0eSBvZiBXZXN0bWluc3RlciBMb25kb24sIiwiQ291bnRyeVN1YkRpdmlzaW9uIjpbIkxvbmRvbiJdLCJDb3VudHJ5IjoiR0IifX19.GlpptuQQp3xA9FTRY9hjxViYRiHxM6S2asWfi3mtgqL3jzbEzeQHl0BrieBJe2g2aVfFjw6gbyrlM5KtejMCPiiSk9pNvHed7O33r2otopju6uy0_sPQQADuwYH_ze8SvhZS1uVs-Ep66i5IJ_yAb102Ij4ATUxSHwwIUKb7LMQdzEXhF1kb2wXlSSgfdfH9o614TG2uBFx_Mv3JtqWxLc4-1bKTPbG4k-4QsNZcZlIkKAqgD_T7AV9nql_OhB0DaVisqmu0fgGNl7DhAePg5035XzYlvD8MQRKAOLQEPEVao6lsopEcJrbfQRSathuAJug7Ai_-x-BXqkyGXO_Tvw' \ 
-X POST "/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product"

Example of request

Example of response

Request

POST /api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product

Headers
Header Type Description
Content-Type string, required The media type of the body of the request. Default value: application/json Can raise: FieldInvalid
x-fapi-interaction-id string, optional An RFC4122 UID used as a correlation Id. Can raise: FieldInvalid
Accept string, optional Media type that is acceptable for the response. Can raise: FieldInvalid
x-fapi-auth-date string, optional The time when the PSU last logged in with the TPP. Can raise: FieldInvalid
x-fapi-customer-ip-address string, optional The PSU's IP address if the PSU is currently logged in with the TPP. Can raise: FieldInvalid
Authorization string, required Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden
x-jws-signature string, optional A detached JWS signature of the body of the payload.
Idempotency-Key string, optional Unique uuid used to recognize subsequent retries of the same request valid for 24 hours. Allowed length: max: 40 characters
Request parameters
Response headers
Header Type Description
Content-Type string, required The media type of the body of the request.
x-fapi-interaction-id string, required An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header.
Retry-After integer, optional Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request.
Response

Upon successful request, 201 status code will be returned. See ‘Related Errors’ table for other possibilities.


Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.
UnsupportedCurrency 400 The currency is not supported.
CountryNameInvalid 400 Country doesn't exist or is invalid. Expected alpha 2 ISO3166 format.
ResourceNotFound 400 Specified resource doesn't exist.
UnsupportedFrequency 400 Specified frequency is unsupported.
HeaderMissing 400 A required HTTP header has not been provided.
HeaderInvalid 400 An invalid value is supplied in the HTTP header.
Forbidden 403 Action is forbidden. More details in error_message.

Show

The API allows the TPP to ask an ASPSP to show a payment-access-consent resource.

CURL

curl -i  \ 
 -H "Authorization: Bearer authorization" \ 
 -H "Content-Type: application/json" \ 
 -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ 
 -H "Accept: application/json" \ 
 -H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \ 
 -H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \ 
 -H "x-fapi-customer-ip-address: 104.25.212.99" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.iJphu_NagxskUGxz5EzTNT506tel5yJ1qww8sSBCKyKwB7eQStKi7hQFbRFodGipm2gF4roM5ChL6OMSD8jdzL0aBy45qM7r67h-VkcP9g6OHIYy1zDirAf-j0UIFMyYOqSvKrPQv7K2Fd4ApNWEu6TlGtEIiIZ4UUosb3tNEWVMz3yB79Tk23wRIlPnl7_Gb2lBuQqaj7u15fiDxOS4U5hy1xRMJAmMes2qfB1f_Ve2LaHMldebSEbQZLHz1cbtDf_xB4yPuTtPiTAaP-R4JXkongS7PIOYTmA5tSly64sEORxmjw3iN4mV8lDa8595rW9eBMawp4kkMTWAU4j2UA' \ 
-X GET "/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product/:consent_id"

Example of response

Request

GET /api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product/:consent_id

Headers
Header Type Description
Content-Type string, required The media type of the body of the request. Default value: application/json Can raise: FieldInvalid
x-fapi-interaction-id string, optional An RFC4122 UID used as a correlation Id. Can raise: FieldInvalid
Accept string, optional Media type that is acceptable for the response. Can raise: FieldInvalid
x-fapi-auth-date string, optional The time when the PSU last logged in with the TPP. Can raise: FieldInvalid
x-fapi-customer-ip-address string, optional The PSU's IP address if the PSU is currently logged in with the TPP. Can raise: FieldInvalid
Authorization string, required Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound
consent_payment_product (path)
string, required
The addressed consent payment resource. Allowed values: domestic-payment-consents, international-payment-consents Can raise: FieldInvalid, ResourceNotFound
consent_id (path)
string, required
The consent identifier assigned to the created resource. Can raise: FieldInvalid, ResourceNotFound
Response headers
Header Type Description
Content-Type string, required The media type of the body of the request.
x-fapi-interaction-id string, required An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header.
Retry-After integer, optional Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request.
Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.


Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.
ResourceNotFound 400 Specified resource doesn't exist.
HeaderMissing 400 A required HTTP header has not been provided.
HeaderInvalid 400 An invalid value is supplied in the HTTP header.
Forbidden 403 Action is forbidden. More details in error_message.

Funds Confirmation

The API allows the TPP to ask an ASPSP to check funds on a payment-access-consent resource.

CURL

curl -i  \ 
 -H "Authorization: Bearer authorization" \ 
 -H "Content-Type: application/json" \ 
 -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ 
 -H "Accept: application/json" \ 
 -H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \ 
 -H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \ 
 -H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \ 
 -H "x-fapi-customer-ip-address: 104.25.212.99" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.Ytg_BYg1k1lb4LOx_dnRze3RvFscJCrCbWwYdh-nJwaDkSX_Gspw6K59xXN6ZGa34AqC8x5hYpChxixczPFTZTY9eLIHAx7GAXAk-apInfz29pYcf7SUxA6oFDBpSA1EQ43djhRsC9RV27r-9AaM8n6Q3qG55zVTy_zg2HrBCpK_cHD4I6378JMZUaE2kJogLu4fmcEYAy2BTSgf-T93a7_8mkduUWvFR-4fYGYTMzbNh1jzV7PrAg7G0e9cyggmjsHxwacG-oRBUvhffa228MYk4B1OhH7JjunAH3AiUjptMdlF1jEaqKJsIQcm-ON9jpzVGc1tmh9g71gSRstAaA' \ 
-X GET "/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product/:consent_id/funds-confirmation"

Example of response

{"Data":{"FundsAvailableResult":{"FundsAvailable":"true","FundsAvailableDateTime":"2017-06-05T15:15:13+00:00"},"SupplementaryData":{}}}
Request

GET /api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product/:consent_id/funds-confirmation

Headers
Header Type Description
Content-Type string, required The media type of the body of the request. Default value: application/json Can raise: FieldInvalid
x-fapi-interaction-id string, optional An RFC4122 UID used as a correlation Id. Can raise: FieldInvalid
Accept string, optional Media type that is acceptable for the response. Can raise: FieldInvalid
x-fapi-auth-date string, optional The time when the PSU last logged in with the TPP. Can raise: FieldInvalid
x-fapi-customer-ip-address string, optional The PSU's IP address if the PSU is currently logged in with the TPP. Can raise: FieldInvalid
Authorization string, required Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound
consent_payment_product (path)
string, required
The addressed consent payment resource. Allowed values: domestic-payment-consents, international-payment-consents Can raise: FieldInvalid, ResourceNotFound
consent_id (path)
string, required
The consent identifier assigned to the created resource. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus
Response headers
Header Type Description
Content-Type string, required The media type of the body of the request.
x-fapi-interaction-id string, required An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header.
Retry-After integer, optional Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request.
Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.


Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.
ResourceNotFound 400 Specified resource doesn't exist.
ResourceInvalidConsentStatus 400 The action can't be performed with current status of consent.
HeaderMissing 400 A required HTTP header has not been provided.
HeaderInvalid 400 An invalid value is supplied in the HTTP header.
Unauthorized 401 Unauthorized access.
Forbidden 403 Action is forbidden. More details in error_message.

Payments

Create

The API allows the TPP to ask an ASPSP to create a new payment.

CURL

curl -i  \ 
 -H "Authorization: Bearer authorization" \ 
 -H "Content-Type: application/json" \ 
 -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ 
 -H "Accept: application/json" \ 
 -H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \ 
 -H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \ 
 -H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \ 
 -H "x-fapi-customer-ip-address: 104.25.212.99" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkNvbnNlbnRJZCI6InN0cmluZyIsIkluaXRpYXRpb24iOnsiSW5zdHJ1Y3Rpb25JZGVudGlmaWNhdGlvbiI6IkFOU00wMjMiLCJFbmRUb0VuZElkZW50aWZpY2F0aW9uIjoiRlJFU0NPLjIxMzAyLkdGWC4zNyIsIkxvY2FsSW5zdHJ1bWVudCI6IlVLLk9CSUUuRlBTIiwiSW5zdHJ1Y3RlZEFtb3VudCI6eyJBbW91bnQiOiIyMC4wMCIsIkN1cnJlbmN5IjoiR0JQIn0sIkRlYnRvckFjY291bnQiOnsiU2NoZW1lTmFtZSI6IlVLLk9CSUUuU29ydENvZGVBY2NvdW50TnVtYmVyIiwiSWRlbnRpZmljYXRpb24iOiIxMTI4MDAwMTIzNDU2NyIsIk5hbWUiOiJBbmRyZWEgU21pdGgiLCJTZWNvbmRhcnlJZGVudGlmaWNhdGlvbiI6IjAwMDIifSwiQ3JlZGl0b3JBY2NvdW50Ijp7IlNjaGVtZU5hbWUiOiJVSy5PQklFLlNvcnRDb2RlQWNjb3VudE51bWJlciIsIklkZW50aWZpY2F0aW9uIjoiMDgwODAwMjEzMjU2OTgiLCJOYW1lIjoiQm9iIENsZW1lbnRzIiwiU2Vjb25kYXJ5SWRlbnRpZmljYXRpb24iOiIwMDAzIn0sIkNyZWRpdG9yUG9zdGFsQWRkcmVzcyI6eyJBZGRyZXNzTGluZSI6WyIxMCBEb3duaW5nIFN0LCBXZXN0bWluc3RlciwgTG9uZG9uIFNXMUEgMkFBLCBVbml0ZWQgS2luZ2RvbSJdLCJBZGRyZXNzVHlwZSI6IkFkZHJlc3Mgd2l0aCBob3VzZSBudW1iZXIgYW5kIHN0cmVldCIsIkRlcGFydG1lbnQiOiJQcmltZSBNaW5pc3RlcidzIE9mZmljZSIsIlN1YkRlcGFydG1lbnQiOiJDYWJpbmV0IE9mZmljZSIsIlN0cmVldE5hbWUiOiJTaXIgR2VvcmdlIERvd25pbmciLCJCdWlsZGluZ051bWJlciI6IjEwIiwiUG9zdENvZGUiOiJTVzFBIDJBQSIsIlRvd25OYW1lIjoiQ2l0eSBvZiBXZXN0bWluc3RlciBMb25kb24sIiwiQ291bnRyeVN1YkRpdmlzaW9uIjoiTG9uZG9uIiwiQ291bnRyeSI6IkdCIn0sIlJlbWl0dGFuY2VJbmZvcm1hdGlvbiI6eyJSZWZlcmVuY2UiOiJGUkVTQ08tMDM3IiwiVW5zdHJ1Y3R1cmVkIjoiSW50ZXJuYWwgb3BzIGNvZGUgNTEyMDEwMyJ9LCJTdXBwbGVtZW50YXJ5RGF0YSI6e319fSwiUmlzayI6eyJQYXltZW50Q29udGV4dENvZGUiOiJzdHJpbmciLCJNZXJjaGFudENhdGVnb3J5Q29kZSI6InN0cmluZyIsIk1lcmNoYW50Q3VzdG9tZXJJZGVudGlmaWNhdGlvbiI6InN0cmluZyIsIkRlbGl2ZXJ5QWRkcmVzcyI6eyJBZGRyZXNzTGluZSI6InN0cmluZyIsIlN0cmVldE5hbWUiOiJzdHJpbmciLCJCdWlsZGluZ051bWJlciI6InN0cmluZyIsIlBvc3RDb2RlIjoic3RyaW5nIiwiVG93bk5hbWUiOiJzdHJpbmciLCJDb3VudHJ5U3ViRGl2aXNpb24iOiJzdHJpbmciLCJDb3VudHJ5IjoiR0IifX19.mXs96rfjn47ys8sFs3nI3QZYGw1qzTONWNYCUbSSI0Rzga5AArqjGM5YWmuzWmPuGycsaWFagwZj8EVVjwY_PfPrK_xO3GjX7U80olD-nxz8zH_0HnJ0SflmFXXvaG2_JoqBIwAfAkoi_Av8aTihPAlpeXKV76EsvlQeRiIDSST5MtllfjGhctJJ0JZ7Yy3OaxVO_xJtWv9khvhJ24utAQxiXgP3TS4UQY7ZtiUBVe_Pxvo5VDVbX6tFzc0oyJ51QJbH89fi4ryrxuiZuzkffxLFEPH_vHrsofgXkCjgIc-5mqGKZmO5lrd6K9_3jUAalPuIOInUlgpbz6UOh2xAng' \ 
-X POST "/api/:provider_code/open-banking/v3.1/pisp/:payment_product"

Example of request

Example of response

Request

POST /api/:provider_code/open-banking/v3.1/pisp/:payment_product

Headers
Header Type Description
Content-Type string, required The media type of the body of the request. Default value: application/json Can raise: FieldInvalid
x-fapi-interaction-id string, optional An RFC4122 UID used as a correlation Id.
Accept string, optional Media type that is acceptable for the response.
x-fapi-auth-date string, optional The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address string, optional The PSU's IP address if the PSU is currently logged in with the TPP.
Authorization string, required Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden
x-jws-signature string, optional A detached JWS signature of the body of the payload.
Idempotency-Key string, optional Unique uuid used to recognize subsequent retries of the same request valid for 24 hours. Allowed length: max: 40 characters
Request parameters
Response headers
Header Type Description
Content-Type string, required The media type of the body of the request.
x-fapi-interaction-id string, optional An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header.
Retry-After integer, optional Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request.
x-jws-signature string, optional A detached JWS signature of the body of the payload.
Response

Upon successful request, 201 status code will be returned. See ‘Related Errors’ table for other possibilities.


Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.
ResourceNotFound 400 Specified resource doesn't exist.
ResourceInvalidConsentStatus 400 The action can't be performed with current status of consent.
UnsupportedCurrency 400 The currency is not supported.
CountryNameInvalid 400 Country doesn't exist or is invalid. Expected alpha 2 ISO3166 format.
UnsupportedFrequency 400 Specified frequency is unsupported.
HeaderMissing 400 A required HTTP header has not been provided.
HeaderInvalid 400 An invalid value is supplied in the HTTP header.
Unauthorized 401 Unauthorized access.
Forbidden 403 Action is forbidden. More details in error_message.

Show

The API allows the TPP to ask an ASPSP to show a payment.

CURL

curl -i  \ 
 -H "Authorization: Bearer authorization" \ 
 -H "Content-Type: application/json" \ 
 -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ 
 -H "Accept: application/json" \ 
 -H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \ 
 -H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \ 
 -H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \ 
 -H "x-fapi-customer-ip-address: 104.25.212.99" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.iYjRS-f7CfXsgW-fzHk0qhkSmq_pM8swLgzLMwjeBFL3pfrIanxscfDYQBistHwpgh6iOUq57y5an1Qr72dE7RFCWMfK_4dVteRvw_nMR7G1uMBvGOnwFuJo5P8tCoWRDQLOhPJFWU4NJRYNOfNegR56E4I3Ts8772aJLuLPS1HQrevONKmM1a4QfRAM4e5M8SPPvMGSyNCy-2jLm4JYRgN-zt5iOycJzbtaoPFrgaWcArqOpvP-Tc_6NcCeDzYgq-GIuu3ltVUpzOyOyNBThjH7FZX1RnnQJC2t_d-5_8P0mvL70JE6sDzSLf1O9J12Mp6D6xRqeUP-aWbXx_jUIQ' \ 
-X GET "/api/:provider_code/open-banking/v3.1/pisp/:payment_product/:payment_id"

Example of response

Request

GET /api/:provider_code/open-banking/v3.1/pisp/:payment_product/:payment_id

Headers
Header Type Description
Content-Type string, required The media type of the body of the request. Default value: application/json Can raise: FieldInvalid
x-fapi-interaction-id string, optional An RFC4122 UID used as a correlation Id. Can raise: FieldInvalid
Accept string, optional Media type that is acceptable for the response. Can raise: FieldInvalid
x-fapi-auth-date string, optional The time when the PSU last logged in with the TPP. Can raise: FieldInvalid
x-fapi-customer-ip-address string, optional The PSU's IP address if the PSU is currently logged in with the TPP. Can raise: FieldInvalid
Authorization string, required Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden
Request parameters
provider_code (path)
string, required
Human readable Provider identifier. Can raise: FieldInvalid, ResourceNotFound
payment_product (path)
string, required
The addressed payment resource. Allowed values: domestic-payments, international-payments Can raise: FieldInvalid, ResourceNotFound
payment_id (path)
string, required
Unique identification as assigned by the ASPSP to identify the domestic payment resource. Can raise: FieldInvalid, ResourceNotFound
Response headers
Header Type Description
Content-Type string, required The media type of the body of the request.
x-fapi-interaction-id string, required An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header.
Retry-After integer, optional Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request.
Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.


Related Errors
Class Code Description
FieldInvalid 400 An invalid value is supplied in the field. More details in error_message.
ResourceNotFound 400 Specified resource doesn't exist.
HeaderMissing 400 A required HTTP header has not been provided.
HeaderInvalid 400 An invalid value is supplied in the HTTP header.
Forbidden 403 Action is forbidden. More details in error_message.

Codes

All Payment Purpose Codes

Purpose of Payment Code for all countries except Bahrain and UAE

Values
Payment for goods and services
Direct capital investment
Salary/Payroll
Refund
Loan
Repayment of loan
Merchant Settlement
Intercompany/group transfer
Tax Settlement
Expenses
Other
Property purchase

AE Payment Purpose Codes

Purpose of Payment Code for United Arab Emirates

Code Description
ACM Agency Commission
AES Advance payment against EOS
AFA Receipts or payments from personal residents bank account or deposits abroad
AFL Receipts or payments from personal non-resident bank account in the UAE
ALW Allowances
ATS Air transport
BON Bonus
CCP Corporate Card Payment
CEA Equity and investment fund shares for the establishment of new company from residents abroad, equity of merger or acquisition of companies abroad from residents and participation to capital increase of related companies abroad
CEL Equity and investment fund shares for the establishment of new company in the UAE from non-residents, equity of merger or acquisition of companies in the UAE from non-residents and participation to capital increase of related companies from non-residents in the UAE
CHC Charitable Contributions
CIN Commercial Investments
COM Commission
COP Compensation
CRP Credit Card Payments
DCP Pre-Paid Reloadable & Personalized Debit Card Payments
DIV Dividend Payouts
DLA Purchases and sales of foreign debt securities in not related companies – More than a year
DLF Debt instruments intragroup loans, deposits foreign
DLL Purchases and sales of securities issued by residents in not related companies – More than a year
DOE Dividends on equity not intra group
DSA Purchases and sales of foreign debt securities in not related companies – Less than a year
DSF Debt instruments intragroup foreign securities
DSL Purchases and sales of securities issued by residents in not related companies – Less than a year
EDU Educational Support
EMI Equated Monthly Instalments
EOS End of Service
FAM Family Support
FDA Financial derivatives foreign
FDL Financial derivatives in the UAE
FIA Investment fund shares foreign
FIL Investment fund shares in the UAE
FIS Financial services
FSA Equity other than investment fund shares in not related companies abroad
FSL Equity other than investment fund shares in not related companies in the UAE
GDE Goods Sold
GDI Goods bought
GMS Processing repair and maintenance services on goods
GOS Government goods and services embassies etc
GRI Government related income taxes tariffs capital transfers etc
IFS Information services
IGD Intra group dividends
IGT Inter group transfer
IID Intra group interest on debt
INS Insurance services
IOD Income on deposits
IOL Income on loans
IPC Charges for the use of intellectual property royalties
IPO IPO subscriptions
IRP Interest rate swap payments
IRW Interest rate unwind payments
ISH Income on investment funds share
ISL Interest on securities more than a year
ISS Interest on securities less than a year
ITS Computer services
LAS Leave salary
LDL Debt instruments intragroup loans, deposits in the UAE
LDS Debt instruments intragroup securities in the UAE
LEA Leasing abroad
LEL Leasing in the UAE
LIP Loan interest payments
LLA Loans – Drawings or Repayments on loans extended to nonresidents – Long-term
LLL Loans – Drawings or Repayments on foreign loans extended to residents – Long-term
LNC Loan charges
LND Loan disbursements
MCR Monetary Claim Reimbursements Medical Insurance or Auto Insurance etc.
MWI Mobile wallet cash in
MWO Mobile wallet cash out
MWP Mobile wallet payments
OAT Own account transfer
OTS Other modes of transport
OVT Overtime
PEN Pension
PIN Personal Investments
PIP Profits on Islamic products
PMS Professional and management consulting services
POR Refunds or Reversals on IPO subscriptions
POS POS Merchant Settlement
PPA Purchase of real estate abroad from residents
PPL Purchase of real estate in the UAE from non-residents
PRP Profit rate swap payments
PRR Profits or rents on real estate
PRS Personal cultural audio visual and recreational services
PRW Profit rate unwind payments
RDS Research and development services
RFS Repos on foreign securities
RLS Repos on securities issued by residents
RNT Rent payments
SAA Salary advance
SAL Salary
SCO Construction
SLA Loans – Drawings or Repayments on loans extended to nonresidents – Short-term
SLL Loans – Drawings or Repayments on foreign loans extended to residents – Short-term
STR Travel
STS Sea transport
SVI Stored value card cash-in
SVO Stored value card cash-out
SVP Stored value card payments
TCP Trade credits and advances payable
TCR Trade credits and advances receivable
TCS Telecommunication services
TKT Tickets
TOF Transfer of funds between persons Normal and Juridical
TTS Technical trade-related and other business services
UTL Utility Bill Payments

BH Payment Purpose Codes

Purpose of Payment Code for Bahrain

Code Description
GDE Goods sold (Exports in fob value)
GDI Goods bought (Imports in cif value)
STS Sea Transport
ATS Air transport
OTS OTS Other methods of transport (including Postal and courier services)
STR Travel
GMS Processing repair and maintenance services on goods
SCO Construction
INS Insurance Services
FIS Financial Services
IPC Charges for the use of intellectual property royalties
TCS Telecommunications services
ITS Computer services
IFS Information services
RDS Research and development services
PMS Professional and management consulting services
TTS Technical, trade- related and other business services
PRS Personal, cultural, audiovisual and recreational services
IGD Dividends intragroup
IID Interest on debt intragroup
PIP Profits on Islamic products
PRR Profits or rents on real estate
DOE Dividends on equity not Intragroup
ISH Income on investment funds shares
ISL Interest on securities more than a year
ISS Interest on securities less than a year
IOL Income on loans
IOD Income on deposits
GOS Government goods and services embassies etc
GRI Government related income taxes, tariffs, capital transfers, etc
CHC Charitable Contributions (Charity and Aid)
FAM Family Support (Workers’ remittances)
SAL Salary (Compensation of employees)
PPA Purchase of real estate abroad from residents
PPL Purchase of real estate in Bahrain from non-residents
CEA Equity and Investment fund shares for the establishment of new company from residents abroad, equity of merger or acquisition of companies abroad from residents and participation to capital increase of related companies abroad
DSF Debt instruments Intragroup foreign securities
REL Reverse equity share in Bahrain
RDL Reverse debt instruments in Bahrain
FSA Equity other than investment fund shares in not related companies abroad
FIA Investment fund shares foreign
DSA Purchases and sales of foreign debt securities in not related companies- Less than a year
DLA Purchases and sales of foreign debt securities in not related companies- More than a year
FDA Financial derivatives foreign
DLF Debt Instruments Intragroup loans, deposits foreign (above 10% share)
AFA Receipts or payments from personal residents bank account or deposits abroad
SLA Loans- Drawings or Repayments on loans extended to nonresidents- Short-term
LLA Loans- Drawings or Repayments on loans extended to nonresidents- Long-term
LEA Leasing abroad
RFS Repos on foreign securities
TCR Trade credits and advances receivable
CEL Equity and Investment fund shares for the establishment of new company in Bahrain from non-residents, equity of merger or acquisition of companies in Bahrain from non-residents and participation to capital increase of related companies from non-residents in Bahrain
LDS Debt instruments intragroup securities in Bahrain
REA Reverse equity share abroad
RDA Reverse debt instruments abroad
FSL Equity other than investment fund shares in not related companies in Bahrain
FIL Investment fund shares in Bahrain
DSL Purchases and sales of securities issued by residents in not related companies- Less than a year
DLL Purchases and sales of securities issued by residents in not related companies- More than a year
FDL Financial derivatives in Bahrain
LDL Debt Instruments Intragroup loans, deposits in Bahrain (above 10% share)
AFL Receipts or payments from personal nonresidents bank account in Bahrain
SLL Loans- Drawings or Repayments on foreign loans extended to residents- Short-term
LLL Loans- Drawings or Repayments on foreign loans extended to residents- Long-term
LEL Leasing in Bahrain
RLS Repos on securities issued by residents
TCP Trade credits and advances payable