The current stage of the authorisation lifecycle is represented in
scaStatus
field. The status of the authorisation can be one of the following:
Name
Description
accepted
An authorisation or cancellation-authorisation resource has been created successfully on Salt Edge PSD2 Compliance's side and was sent to ASPSP.
received
An authorisation or cancellation-authorisation resource has been created successfully on ASPSP's side.
psuIdentified
The PSU related to the authorisation or cancellation-authorisation resource has been identified.
psuAuthenticated
The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.
scaMethodSelected
The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of "received".
started
The addressed SCA routine has been started.
unconfirmed
SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet.
finalised
The SCA routine has been finalised successfully (including a potential confirmation command). This is a final status of the authorisation resource.
failed
The SCA routine failed. This is a final status of the authorisation resource.
exempted
SCA was exempted for the related transaction, the related authorisation is successful. This is a final status of the authorisation resource.
×
Payment Order statuses
The current stage of a payment order lifecycle is represented in
transactionStatus
field. The status of a payment order can be one of the following:
Code
Name
Description
ACCC
AcceptedSettlementCompleted
Settlement on the creditor's account has been completed.
ACCP
AcceptedCustomerProfile
Preceding check of technical validation was successful. Customer profile check was also successful.
ACSC
AcceptedSettlementCompleted
Settlement on the debtor’s account has been completed.
ACSP
AcceptedSettlementInProcess
All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
ACTC
AcceptedTechnicalValidation
Authentication and syntactical and semantical validation are successful.
ACWC
AcceptedWithChange
Instruction is accepted but a change will be made, such as date or remittance not sent.
ACWP
AcceptedWithoutPosting
Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account.
RCVD
Received
Payment initiation has been received by the receiving agent.
PDNG
Pending
Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
RJCT
Rejected
Payment initiation or individual transaction included in the payment initiation has been rejected.
CANC
Cancelled
Payment initiation has been cancelled before execution.
Remark:
This code is accepted as new code by ISO20022.
ACFC
AcceptedFundsChecked
Pre-ceeding check of technical validation and customer profile was successful and an automatic funds check was positive.
Remark:
This code is accepted as new code by ISO20022.
PATC
PartiallyAcceptedTechnicalCorrect
The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful.
Remark:
This code is accepted as new code by ISO20022.
PART
PartiallyAccepted
A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. Remark: This code may be used only in case of bulk payments. It is only used in a situation where all mandated authorisations have been applied, but some payments have been rejected.
×
Create
This method is used to instruct Salt Edge PSD2 Compliance Solution to initialize the payment creation.
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description","debtorAccount":{"bban":"836076798"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description","debtorAccount":{"bban":"836076798"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
TPP-Redirect-Preferred
boolean, optional
If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
Default value:
true
Can raise:
BadRequest
TPP-Redirect-URI
url, optional
URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is strongly recommended to add a unique identifier for validation purposes on TPP side.
Psu-IP-Address
string, required
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.
TPP-Explicit-Authorisation-Preferred
boolean, optional
If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
Default value:
false
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
Can raise:
ServiceInvalid, FormatError
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAgentName
string, optional
Agent name
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
iban
string, optional
International Bank Account Number
bic
string, optional
Response headers
Header
Type
Description
ASPSP-SCA-Approach
string, optional
Selected by ASPSP SCA Approach
Allowed values:
REDIRECT, EMBEDDED, DECOUPLED
Response
This method is used to instruct Salt Edge PSD2 Compliance Solution to initialize the payment creation.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG
paymentId
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
ServiceInvalid
400
Something went wrong on Provider(ASPSP) side.
FormatError
400
Invalid input. More info in error_message
CountryNameInvalid
400
Country doesn't exist or is invalid. Expected alpha 2 ISO3166 format.
BadRequest
400
Given value is invalid.
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/target-2-payments/911"},"status":{"href":"/demobank/v1/payments/target-2-payments/911/status"},"scaStatus":{"href":"/demobank/v1/payments/target-2-payments/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/target-2-payments/911"},"status":{"href":"/demobank/v1/payments/target-2-payments/911/status"},"scaStatus":{"href":"/demobank/v1/payments/target-2-payments/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/faster-payment-service/911"},"status":{"href":"/demobank/v1/payments/faster-payment-service/911/status"},"scaStatus":{"href":"/demobank/v1/payments/faster-payment-service/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/faster-payment-service/911"},"status":{"href":"/demobank/v1/payments/faster-payment-service/911/status"},"scaStatus":{"href":"/demobank/v1/payments/faster-payment-service/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description","debtorAccount":{"bban":"836076798"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/internal-transfer/911"},"status":{"href":"/demobank/v1/payments/internal-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/payments/internal-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description","debtorAccount":{"bban":"836076798"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/internal-transfer/911"},"status":{"href":"/demobank/v1/payments/internal-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/payments/internal-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","iban":"FK54RAND61068421435452","sortCode":"22-33-44","swiftCode":"HDSSGBKC131"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/ipayliknks-payment/911"},"status":{"href":"/demobank/v1/payments/ipayliknks-payment/911/status"},"scaStatus":{"href":"/demobank/v1/payments/ipayliknks-payment/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","iban":"FK54RAND61068421435452","sortCode":"22-33-44","swiftCode":"HDSSGBKC131"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/ipayliknks-payment/911"},"status":{"href":"/demobank/v1/payments/ipayliknks-payment/911/status"},"scaStatus":{"href":"/demobank/v1/payments/ipayliknks-payment/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","debtorAccount":{"iban":"FK54RAND61068421435452"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/wu-money-transfer/911"},"status":{"href":"/demobank/v1/payments/wu-money-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/payments/wu-money-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","debtorAccount":{"iban":"FK54RAND61068421435452"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/wu-money-transfer/911"},"status":{"href":"/demobank/v1/payments/wu-money-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/payments/wu-money-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","debtorId":"0101303019","centralBankPurposeCode":"TBD","chargesAccount":"string","serviceLevel":"string","chargeBearer":"string","creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"debtorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"_links":{"self":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","debtorId":"0101303019","centralBankPurposeCode":"TBD","chargesAccount":"string","serviceLevel":"string","chargeBearer":"string","creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"debtorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"_links":{"self":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payment_id(path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
Response
This method returns payment data.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
iban
string, optional
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
iban
string, optional
International Bank Account Number
bic
string, optional
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
×
Authorisation
This method returns the SCA status of a consent initiation's authorisation subresource.
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payment_id(path)
string, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
authorisation_id(path)
string, required
Unique resource identification of the created authorization subresource.
Can raise:
ResourceUnknown
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
scaStatus
string, required
The link to retrieve the scaStatus of the corresponding authorization subresource. Here you can find definitions for all statuses.
Allowed values:
accepted, received, psuIdentified, psuAuthenticated, scaMethodSelected, started, finalised, failed, exempted, unconfirmed
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payment_id(path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
Response
This method returns payment status.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
×
Revoke
It initiates the cancellation of a payment order. Depending on the payment-product and the ASPSP's implementation, this TPP call might be sufficient to cancel a payment.
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
TPP-Redirect-Preferred
boolean, optional
If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
Default value:
true
TPP-Redirect-URI
url, required
URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is strongly recommended to add a unique identifier for validation purposes on TPP side.
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payment_id(path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown, CancellationInvalid
Response headers
Header
Type
Description
ASPSP-SCA-Approach
string, required
Selected by ASPSP SCA Approach
Allowed values:
REDIRECT, EMBEDDED, DECOUPLED
Response
It initiates the cancellation of a payment order. Depending on the payment-product and the ASPSP's implementation, this TPP call might be sufficient to cancel a payment.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
CancellationInvalid
405
The addressed payment is not cancellable e.g. due to cut off time passed or legal constraints.
×
Cancellation Authorisations of Payment
Will deliver an array of resource identifications to all generated cancellation authorisation subresources.
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payment_id(path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
Response
Will deliver an array of resource identifications to all generated cancellation authorisation subresources.
authorisationIds
array, required
An array of all authorisationIds connected to this payment.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
×
Cancellation Authorisation of Payment
This method returns the SCA status of a payment cancellation's authorisation subresource.
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payment_id(path)
string, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
authorisation_id(path)
string, required
Unique resource identification of the created authorization subresource.
Can raise:
ResourceUnknown
Response
This method returns the SCA status of a payment cancellation's authorisation subresource.
scaStatus
string, required
The link to retrieve the scaStatus of the corresponding authorization subresource. Here you can find definitions for all statuses.
Allowed values:
accepted, received, psuIdentified, psuAuthenticated, scaMethodSelected, started, finalised, failed, exempted, unconfirmed
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
×
Periodic Payments
Authorisation statuses
The current stage of the authorisation lifecycle is represented in
scaStatus
field. The status of the authorisation can be one of the following:
Name
Description
accepted
An authorisation or cancellation-authorisation resource has been created successfully on Salt Edge PSD2 Compliance's side and was sent to ASPSP.
received
An authorisation or cancellation-authorisation resource has been created successfully on ASPSP's side.
psuIdentified
The PSU related to the authorisation or cancellation-authorisation resource has been identified.
psuAuthenticated
The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.
scaMethodSelected
The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of "received".
started
The addressed SCA routine has been started.
unconfirmed
SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet.
finalised
The SCA routine has been finalised successfully (including a potential confirmation command). This is a final status of the authorisation resource.
failed
The SCA routine failed. This is a final status of the authorisation resource.
exempted
SCA was exempted for the related transaction, the related authorisation is successful. This is a final status of the authorisation resource.
×
Payment Order statuses
The current stage of a payment order lifecycle is represented in
transactionStatus
field. The status of a payment order can be one of the following:
Code
Name
Description
ACCC
AcceptedSettlementCompleted
Settlement on the creditor's account has been completed.
ACCP
AcceptedCustomerProfile
Preceding check of technical validation was successful. Customer profile check was also successful.
ACSC
AcceptedSettlementCompleted
Settlement on the debtor’s account has been completed.
ACSP
AcceptedSettlementInProcess
All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
ACTC
AcceptedTechnicalValidation
Authentication and syntactical and semantical validation are successful.
ACWC
AcceptedWithChange
Instruction is accepted but a change will be made, such as date or remittance not sent.
ACWP
AcceptedWithoutPosting
Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account.
RCVD
Received
Payment initiation has been received by the receiving agent.
PDNG
Pending
Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
RJCT
Rejected
Payment initiation or individual transaction included in the payment initiation has been rejected.
CANC
Cancelled
Payment initiation has been cancelled before execution.
Remark:
This code is accepted as new code by ISO20022.
ACFC
AcceptedFundsChecked
Pre-ceeding check of technical validation and customer profile was successful and an automatic funds check was positive.
Remark:
This code is accepted as new code by ISO20022.
PATC
PartiallyAcceptedTechnicalCorrect
The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful.
Remark:
This code is accepted as new code by ISO20022.
PART
PartiallyAccepted
A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. Remark: This code may be used only in case of bulk payments. It is only used in a situation where all mandated authorisations have been applied, but some payments have been rejected.
×
Create
This method is used to instruct Salt Edge PSD2 Compliance Solution to initialize the payment creation.
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"bban":"450746508"},"debtorAccount":{"bban":"450746510"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"bban":"450746508"},"debtorAccount":{"bban":"450746510"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","debtorAccount":{"iban":"FK53RAND61068421435422"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","debtorAccount":{"iban":"FK53RAND61068421435422"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","debtorAccount":{"iban":"IS790123260107070101302980","bban":"012326010707"},"creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1"}
{"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","debtorAccount":{"iban":"IS790123260107070101302980","bban":"012326010707"},"creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1"}
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
TPP-Redirect-Preferred
boolean, optional
If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
Default value:
true
Can raise:
BadRequest
TPP-Redirect-URI
url, optional
URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is strongly recommended to add a unique identifier for validation purposes on TPP side.
Psu-IP-Address
string, required
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.
TPP-Explicit-Authorisation-Preferred
boolean, optional
If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
Default value:
false
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, required
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
iban
string, optional
International Bank Account Number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, required
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, required
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
iban
string, optional
International Bank Account Number
bic
string, optional
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
Response headers
Header
Type
Description
ASPSP-SCA-Approach
string, optional
Selected by ASPSP SCA Approach
Allowed values:
REDIRECT, EMBEDDED, DECOUPLED
Response
This method is used to instruct Salt Edge PSD2 Compliance Solution to initialize the payment creation.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG
periodicPaymentId
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CountryNameInvalid
400
Country doesn't exist or is invalid. Expected alpha 2 ISO3166 format.
BadRequest
400
Given value is invalid.
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/target-2-payments/911"},"status":{"href":"/demobank/v1/periodic-payments/target-2-payments/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/target-2-payments/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/target-2-payments/911"},"status":{"href":"/demobank/v1/periodic-payments/target-2-payments/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/target-2-payments/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911"},"status":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911"},"status":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"bban":"450746508"},"debtorAccount":{"bban":"450746510"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/internal-transfer/911"},"status":{"href":"/demobank/v1/periodic-payments/internal-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/internal-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"bban":"450746508"},"debtorAccount":{"bban":"450746510"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/internal-transfer/911"},"status":{"href":"/demobank/v1/periodic-payments/internal-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/internal-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911"},"status":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911"},"status":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","debtorAccount":{"iban":"FK53RAND61068421435422"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911"},"status":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","debtorAccount":{"iban":"FK53RAND61068421435422"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911"},"status":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","debtorAccount":{"iban":"IS790123260107070101302980","bban":"012326010707"},"creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1","_links":{"self":{"href":"/demobank/v1/periodic-payments/credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","debtorAccount":{"iban":"IS790123260107070101302980","bban":"012326010707"},"creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1","_links":{"self":{"href":"/demobank/v1/periodic-payments/credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
periodic_payment_id(path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
Response
This method returns payment data.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, required
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
iban
string, optional
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, required
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, required
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
iban
string, optional
International Bank Account Number
bic
string, optional
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
×
Periodic Authorisation
This method returns the SCA status of a consent initiation's authorisation subresource.
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
periodic_payment_id(path)
string, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
authorisation_id(path)
string, required
Unique resource identification of the created authorization subresource.
Can raise:
ResourceUnknown
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
scaStatus
string, required
The link to retrieve the scaStatus of the corresponding authorization subresource. Here you can find definitions for all statuses.
Allowed values:
accepted, received, psuIdentified, psuAuthenticated, scaMethodSelected, started, finalised, failed, exempted, unconfirmed
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
periodic_payment_id(path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
Response
This method returns payment status.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
×
Revoke
It initiates the cancellation of a payment order. Depending on the payment-product and the ASPSP's implementation, this TPP call might be sufficient to cancel a payment.
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
TPP-Redirect-Preferred
boolean, optional
If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
Default value:
true
TPP-Redirect-URI
url, required
URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is strongly recommended to add a unique identifier for validation purposes on TPP side.
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
periodic_payment_id(path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown, CancellationInvalid
Response headers
Header
Type
Description
ASPSP-SCA-Approach
string, required
Selected by ASPSP SCA Approach
Allowed values:
REDIRECT, EMBEDDED, DECOUPLED
Response
It initiates the cancellation of a payment order. Depending on the payment-product and the ASPSP's implementation, this TPP call might be sufficient to cancel a payment.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
CancellationInvalid
405
The addressed payment is not cancellable e.g. due to cut off time passed or legal constraints.
×
Cancellation Authorisations of Periodic Payment
Will deliver an array of resource identifications to all generated cancellation authorisation subresources.
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
periodic_payment_id(path)
string, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
Response
Will deliver an array of resource identifications to all generated cancellation authorisation subresources.
authorisationIds
array, required
An array of all authorisationIds connected to this payment.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
×
Cancellation Authorisation of Periodic Payment
This method returns the SCA status of a payment cancellation's authorisation subresource.
ID of the request, unique to the call, as determined by the initiating party.
Digest
string, required
Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "".
Can raise:
CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date
datetime, required
Endpoint request execution date.
Psu-ID
string, optional
Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID
string, optional
Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID
string, optional
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent
string, optional
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location
string, optional
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate
string, required
The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds).
Can raise:
CertificateMissing, CertificateInvalid
Signature
string, required
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Can raise:
CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type
string, required
The media type of the body of the request.
Allowed values:
application/json
Request parameters
provider_code(path)
string, required
Human readable Provider identifier.
payment_product(path)
string, required
The addressed payment product.
Allowed values:
internal-transfer, sepa-credit-transfers, instant-sepa-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
periodic_payment_id(path)
string, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
authorisation_id(path)
string, required
Unique resource identification of the created authorization subresource.
Can raise:
ResourceUnknown
Response
This method returns the SCA status of a payment cancellation's authorisation subresource.
scaStatus
string, required
The link to retrieve the scaStatus of the corresponding authorization subresource. Here you can find definitions for all statuses.
Allowed values:
accepted, received, psuIdentified, psuAuthenticated, scaMethodSelected, started, finalised, failed, exempted, unconfirmed
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
Class
Code
Description
CertificateMissing
401
This request cannot be performed without Certificate header.
CertificateInvalid
401
Given certificate is invalid.
SignatureInvalid
401
Given signature is invalid.
SignatureMissing
401
This request cannot be performed without Signature header.
SignatureMalformed
401
Given signature is malformed.
ProductInvalid
403
The payment product is not supported by the addressed service/resource.
ProductUnknown
404
The payment product wasn't found.
ResourceUnknown
404
The addressed resource is unknown relative to the TPP.
