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.eyJEYXRhIjp7IlBlcm1pc3Npb24iOiJDcmVhdGUiLCJBdXRob3Jpc2F0aW9uIjp7IkF1dGhvcmlzYXRpb25UeXBlIjoiQXV0aCIsIkNvbXBsZXRpb25EYXRlVGltZSI6IjIwMTctMDYtMDVUMTU6MTU6MTMrMDA6MDAifSwiU0NBU3VwcG9ydERhdGEiOnsiQXBwbGllZEF1dGhlbnRpY2F0aW9uQXBwcm9hY2giOiJBcHBsaWVkQXV0aGVudGljYXRpb25BcHByb2FjaCIsIlJlZmVyZW5jZVBheW1lbnRPcmRlcklkIjoiMTU2NDUyIiwiUmVxdWVzdGVkU0NBRXhlbXB0aW9uVHlwZSI6IlJlcXVlc3RlZFNDQUV4ZW1wdGlvblR5cGUifSwiSW5pdGlhdGlvbiI6eyJGcmVxdWVuY3kiOiJFdnJ5RGF5IiwiRmlyc3RQYXltZW50RGF0ZVRpbWUiOiIyMDE3LTA2LTA1VDE1OjE1OjEzKzAwOjAwIiwiRmlyc3RQYXltZW50QW1vdW50Ijp7IkFtb3VudCI6IjIwLjAwIiwiQ3VycmVuY3kiOiJHQlAifSwiRmluYWxQYXltZW50QW1vdW50Ijp7IkFtb3VudCI6IjIwLjAwIiwiQ3VycmVuY3kiOiJHQlAifSwiUmVjdXJyaW5nUGF5bWVudEFtb3VudCI6eyJBbW91bnQiOiIyMC4wMCIsIkN1cnJlbmN5IjoiR0JQIn0sIkRlYnRvckFjY291bnQiOnsiU2NoZW1lTmFtZSI6IlVLLk9CSUUuU29ydENvZGVBY2NvdW50TnVtYmVyIiwiSWRlbnRpZmljYXRpb24iOiIxMTI4MDAwMTIzNDU2NyIsIk5hbWUiOiJBbmRyZWEgU21pdGgiLCJTZWNvbmRhcnlJZGVudGlmaWNhdGlvbiI6IjAwMDIifSwiQ3JlZGl0b3JBY2NvdW50Ijp7IlNjaGVtZU5hbWUiOiJVSy5PQklFLlNvcnRDb2RlQWNjb3VudE51bWJlciIsIklkZW50aWZpY2F0aW9uIjoiMDgwODAwMjEzMjU2OTgiLCJOYW1lIjoiQm9iIENsZW1lbnRzIiwiU2Vjb25kYXJ5SWRlbnRpZmljYXRpb24iOiIwMDAzIn0sIlN1cHBsZW1lbnRhcnlEYXRhIjp7fX19LCJSaXNrIjp7IlBheW1lbnRDb250ZXh0Q29kZSI6IkVjb21tZXJjZUdvb2RzIiwiTWVyY2hhbnRDYXRlZ29yeUNvZGUiOiI1OTY3IiwiTWVyY2hhbnRDdXN0b21lcklkZW50aWZpY2F0aW9uIjoiMDUzNTk4NjUzMjU0IiwiRGVsaXZlcnlBZGRyZXNzIjp7IkFkZHJlc3NMaW5lIjpbIkZsYXQgNyIsIkFjYWNpYSBMb2RnZSJdLCJTdHJlZXROYW1lIjoiQWNhY2lhIEF2ZW51ZSIsIkJ1aWxkaW5nTnVtYmVyIjoiMjciLCJQb3N0Q29kZSI6IkdVMzEgMlpaIiwiVG93bk5hbWUiOiJTcGFyc2hvbHQiLCJDb3VudHJ5U3ViRGl2aXNpb24iOiJXZXNzZXgiLCJDb3VudHJ5IjoiR0IifX19.lY9nluhmqQ0-XCMA4uVvcrunzYNuqkAYF72D57FGb1f5wjc8v4uxolDdEjCjGgNYWze7oo0tj5-zOdIBbZud-zCRlXFCl0vZ_L_h9v6ynZP08lupUYpu6HXJUlmbO4CtcFxI8iqcz_z1eH2UrjdcCSJ8qXa1psmFn-fp92har7VPlqWta0b8Uf_XogQSRaEok18uC1mozKIeAGBoTHSDsAdgABjB3lh_dOwZ9twDPSEOquDwu4MWWiEK0XJTvO67rcAVjzZ0zCC4S3dH7ZKPr0WdkZrbev1yjgMQ4JBLZYgPphnQ9yz4DbJ-Zkz_gEPuiefy_YGUfb8FL5u4-GyFyg' \ 
-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.djF-2VWW96pslNGlpx2f6YSxK8Hr0Boc_F6rszqYP9g7NBC-FZHLsuU7kbSjUBqar99POE5gpZ-1aA7Y_SMijLsw_FLjBtt3zQHs_tWjKxNlr6qTtL35JctrU6fL_8KwyjdUrucqET5OxPO_bMf0zpnKTR8ZY0udJo0Lb2YnsXP7xwaqQKtkUOLUOXslHYgO_TXi3RPAj7d_ekknyhURAdNJ-VbVWPDjIq2c7aRnyIzh_EAJ0_uINb62YZttoqO144GzGZu6SVMtnl8yqxiAuOvZHXdq7cN9NKvY__AFhofmz9pCMLizXbWjsYlpgwiTj7Dk04UmqcOk4PMVpS3CTw' \ 
-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.IP3igsaP0xprm9575iWv4ybxGEqEClipht5mSCf_7q83s1eHdzZVMIsZuN5bt75iQFMKwMVBCLpO5LvKx5geRKbCIicexOCcAFf2TcbX9VqcZ0BzvpdvwhYJY174ayNx8GfBAHqDZ6nHKypRX9Vv22DCvX48W-aiJ3qsztowO6LIUmsEqbzeiCQDAHvsDeoms9QcZ8GekLlb6xcKG8ixoKG9uI66kwItV-nW9rHLEIL3F_jwGpXPtmZSag6qcGieE61j7rxOAzO1ElKdXta_DJVnqkG3MhprX0oMluUov1slpoYoFD5cyR978khDCbfADc2yrCEmsjE3Y9nmf7VUbA' \ 
-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.

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.eyJEYXRhIjp7IkNvbnNlbnRJZCI6IjU4OTI0IiwiSW5pdGlhdGlvbiI6eyJJbnN0cnVjdGlvbklkZW50aWZpY2F0aW9uIjoiQUNNRTQxMiIsIkVuZFRvRW5kSWRlbnRpZmljYXRpb24iOiJGUkVTQ08uMjEzMDIuR0ZYLjM3IiwiUmVxdWVzdGVkRXhlY3V0aW9uRGF0ZVRpbWUiOiIyMDMzLTA4LTA2VDAwOjAwOjAwKzAwOjAwIiwiTG9jYWxJbnN0cnVtZW50IjoiVUsuT0JJRS5TV0lGVCIsIkluc3RydWN0aW9uUHJpb3JpdHkiOiJVcmdlbnQiLCJQdXJwb3NlIjoiQUJDRCIsIkV4dGVuZGVkUHVycG9zZSI6IkV4dGVuZGVkUHVycG9zZSIsIkRlc3RpbmF0aW9uQ291bnRyeUNvZGUiOiJSTyIsIkNoYXJnZUJlYXJlciI6IlRCRCIsIkN1cnJlbmN5T2ZUcmFuc2ZlciI6IkdCUCIsIkluc3RydWN0ZWRBbW91bnQiOnsiQW1vdW50IjoiMjAuMDAiLCJDdXJyZW5jeSI6IkdCUCJ9LCJFeGNoYW5nZVJhdGVJbmZvcm1hdGlvbiI6eyJVbml0Q3VycmVuY3kiOiJFVVIiLCJFeGNoYW5nZVJhdGUiOiIwLjk5IiwiUmF0ZVR5cGUiOiJUQkQiLCJDb250cmFjdElkZW50aWZpY2F0aW9uIjoiVEJEIn0sIkNyZWRpdG9yIjp7Ik5hbWUiOiJKb2huIFNtaXRoIiwiUG9zdGFsQWRkcmVzcyI6eyJBZGRyZXNzVHlwZSI6IkFkZHJlc3Mgd2l0aCBob3VzZSBudW1iZXIgYW5kIHN0cmVldCIsIkRlcGFydG1lbnQiOiJQcmltZSBNaW5pc3RlcidzIE9mZmljZSIsIlN1YkRlcGFydG1lbnQiOiJDYWJpbmV0IE9mZmljZSIsIlN0cmVldE5hbWUiOiJTaXIgR2VvcmdlIERvd25pbmciLCJCdWlsZGluZ051bWJlciI6IjEwIiwiUG9zdENvZGUiOiJTVzFBIDJBQSIsIlRvd25OYW1lIjoiQ2l0eSBvZiBXZXN0bWluc3RlciBMb25kb24sIiwiQ291bnRyeVN1YkRpdmlzaW9uIjoiTG9uZG9uIiwiQ291bnRyeSI6IkdCIiwiQWRkcmVzc0xpbmUiOlsiMTAgRG93bmluZyBTdCwgV2VzdG1pbnN0ZXIsIExvbmRvbiBTVzFBIDJBQSwgVW5pdGVkIEtpbmdkb20iXX19LCJDcmVkaXRvckFnZW50Ijp7Ik5hbWUiOiJKb2huIFNtaXRoIiwiU2NoZW1lTmFtZSI6IlVLLk9CSUUuQklDRkkiLCJJZGVudGlmaWNhdGlvbiI6IjA4MDgwMDIxMzI1Njk4IiwiUG9zdGFsQWRkcmVzcyI6eyJBZGRyZXNzVHlwZSI6IkFkZHJlc3Mgd2l0aCBob3VzZSBudW1iZXIgYW5kIHN0cmVldCIsIkRlcGFydG1lbnQiOiJQcmltZSBNaW5pc3RlcidzIE9mZmljZSIsIlN1YkRlcGFydG1lbnQiOiJDYWJpbmV0IE9mZmljZSIsIlN0cmVldE5hbWUiOiJTaXIgR2VvcmdlIERvd25pbmciLCJCdWlsZGluZ051bWJlciI6IjEwIiwiUG9zdENvZGUiOiJTVzFBIDJBQSIsIlRvd25OYW1lIjoiQ2l0eSBvZiBXZXN0bWluc3RlciBMb25kb24sIiwiQ291bnRyeVN1YkRpdmlzaW9uIjpbIkxvbmRvbiJdLCJDb3VudHJ5IjoiR0IiLCJBZGRyZXNzTGluZSI6WyIxMCBEb3duaW5nIFN0LCBXZXN0bWluc3RlciwgTG9uZG9uIFNXMUEgMkFBLCBVbml0ZWQgS2luZ2RvbSJdfX0sIkRlYnRvckFjY291bnQiOnsiU2NoZW1lTmFtZSI6IlVLLk9CSUUuU29ydENvZGVBY2NvdW50TnVtYmVyIiwiSWRlbnRpZmljYXRpb24iOiIxMTI4MDAwMTIzNDU2NyIsIk5hbWUiOiJBbmRyZWEgU21pdGgiLCJTZWNvbmRhcnlJZGVudGlmaWNhdGlvbiI6IjAwMDIifSwiQ3JlZGl0b3JBY2NvdW50Ijp7IlNjaGVtZU5hbWUiOiJVSy5PQklFLlNvcnRDb2RlQWNjb3VudE51bWJlciIsIklkZW50aWZpY2F0aW9uIjoiMDgwODAwMjEzMjU2OTgiLCJOYW1lIjoiQm9iIENsZW1lbnRzIiwiU2Vjb25kYXJ5SWRlbnRpZmljYXRpb24iOiIwMDAzIn0sIlJlbWl0dGFuY2VJbmZvcm1hdGlvbiI6eyJSZWZlcmVuY2UiOiJGUkVTQ08tMDM3IiwiVW5zdHJ1Y3R1cmVkIjoiSW50ZXJuYWwgb3BzIGNvZGUgNTEyMDEwMyJ9LCJTdXBwbGVtZW50YXJ5RGF0YSI6e319fSwiUmlzayI6eyJQYXltZW50Q29udGV4dENvZGUiOiJQYXJ0eVRvUGFydHkiLCJNZXJjaGFudENhdGVnb3J5Q29kZSI6IlRCRCIsIk1lcmNoYW50Q3VzdG9tZXJJZGVudGlmaWNhdGlvbiI6IjA1MzU5ODY1MzI1NCIsIkRlbGl2ZXJ5QWRkcmVzcyI6eyJBZGRyZXNzTGluZSI6WyIxMCBEb3duaW5nIFN0LCBXZXN0bWluc3RlciwgTG9uZG9uIFNXMUEgMkFBLCBVbml0ZWQgS2luZ2RvbSJdLCJTdHJlZXROYW1lIjoiU2lyIEdlb3JnZSBEb3duaW5nIiwiQnVpbGRpbmdOdW1iZXIiOiIxMCIsIlBvc3RDb2RlIjoiU1cxQSAyQUEiLCJUb3duTmFtZSI6IkNpdHkgb2YgV2VzdG1pbnN0ZXIgTG9uZG9uLCIsIkNvdW50cnlTdWJEaXZpc2lvbiI6WyJMb25kb24iXSwiQ291bnRyeSI6IkdCIn19fQ.LTZWsNABDPtz_Juo433YwkSTRhRnD42Qf6jBMsPyHVL96bf5C0_y-nq19l8xyG_6fgw_bfhMQ6cmIeOdwBrbDAfGzLhw-9pM8oNFy08RR2UEjGQdhwMdjegYIDgQdtUEGGHJzm3-AbLzW6GqKcO8IJA5-9LTWvZAUM2jAb7IuEJrqjl3gGBYB9A6YId4tdZRJEDqdwamfZhe3E_RNIBF75tG-0F1hYs4L4ZaD8DLAPFVBxynUnHgjptV5eooSC3eOekXcXf57mTHiDui-jmBJeW4VjTUNZZQTxU7ZZDERqJPweIhA4HcZpDV_3ODvU4YJ07BE8HDZkeCQdHCTvf6AQ' \ 
-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