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.
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.

CURL

curl -i  \ 
 -H "TPP-Redirect-URI: https://redirect-my-psu-here.please" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2029 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "Psu-IP-Address: 255.255.255.255" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -H "Content-Type: application/json" \ 
 -H "TPP-Redirect-Preferred: true" \ 
 -d '{
  "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"
}' \ 
-X POST "/:provider_code/api/berlingroup/v1/payments/:payment_product"

Example of parameters

Example of response

Request

POST /:provider_code/api/berlingroup/v1/payments/:payment_product

Headers
Header Type Description
X-Request-ID string, required 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
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.
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-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
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 string, 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.
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
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.


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.
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.

Show

This method returns payment data.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id

Headers
Header Type Description
X-Request-ID string, required 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
Date datetime, required Endpoint request execution date.
PSU-Device-ID string, required 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-Geo-Location string, optional The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
Psu-IP-Address string, required The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
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
Content-Type string, required The media type of the body of the request. Allowed values: application/json
PSU-Device-Name string, required Name/model (generic) of the device from which the end user (PSU) connects.
Request parameters
provider_code (path)
string, required
Human readable Provider identifier.
payment_product (path)
string, required
The addressed payment product. Allowed values: sepa-credit-transfers, cross-border-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
Response headers
Header Type Description
ASPSP-SCA-Approach string, optional Selected by ASPSP SCA Approach Allowed values: REDIRECT, EMBEDDED, DECOUPLED
Response

This method returns payment data.


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.
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.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 414" \ 
 -H "Psu-Corporate-ID: 4142" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id/authorisations/:authorisation_id"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id/authorisations/:authorisation_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-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.


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.
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.

Status

This method returns payment status.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id/status"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id/status

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-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
Response

This method returns payment status.


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.
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.

CURL

curl -i  \ 
 -H "TPP-Redirect-URI: https://redirect-my-psu-here.please" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -H "Content-Type: application/json" \ 
 -H "TPP-Redirect-Preferred: true" \ 
 -d '{}' \ 
-X DELETE "/:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id"

Example of response

Request

DELETE /:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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 string, 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: sepa-credit-transfers, cross-border-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, 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.


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.
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.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 414" \ 
 -H "Psu-Corporate-ID: 4142" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id/cancellation-authorisations"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id/cancellation-authorisations

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-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
Response

Will deliver an array of resource identifications to all generated cancellation authorisation subresources.


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.
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.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 414" \ 
 -H "Psu-Corporate-ID: 4142" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id/cancellation-authorisations/:authorisation_id"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/payments/:payment_product/:payment_id/cancellation-authorisations/:authorisation_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-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.


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.
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 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.

Bulk 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.
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.

CURL

curl -i  \ 
 -H "TPP-Redirect-URI: https://redirect-my-psu-here.please" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2029 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "Psu-IP-Address: 255.255.255.255" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -H "Content-Type: application/json" \ 
 -H "TPP-Redirect-Preferred: true" \ 
 -d '{
  "payments": [
    {
      "instructedAmount": {
        "amount": "145.3",
        "currency": "EUR"
      },
      "creditorName": "John Smith",
      "creditorAccount": {
        "iban": "FK53RAND61068421435422"
      },
      "remittanceInformationUnstructured": "Payment description"
    }
  ],
  "debtorAccount": {
    "iban": "FK54RAND61068421435452"
  },
  "paymentInformationId": "cc5a8022-5e71-460e-82fa-ab0be1997a54",
  "batchBookingPreferred": false,
  "requestedExecutionDate": "2029-06-01",
  "requestedExecutionTime": "2029-06-01T13:50:49+03:00"
}' \ 
-X POST "/:provider_code/api/berlingroup/v1/bulk-payments/:payment_product"

Example of parameters

Example of response

Request

POST /:provider_code/api/berlingroup/v1/bulk-payments/:payment_product

Headers
Header Type Description
X-Request-ID string, required 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
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.
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-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
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 string, 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.
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
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.


Related Errors
Class Code Description
CountryNameInvalid 400 Country doesn't exist or is invalid. Expected alpha 2 ISO3166 format.
ServiceInvalid 400 Something went wrong on Provider(ASPSP) side.
FormatError 400 Invalid input. More info in error_message
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.
ProductInvalid 403 The payment product is not supported by the addressed service/resource.
ResourceUnknown 404 The addressed resource is unknown relative to the TPP.
ProductUnknown 404 The payment product wasn't found.

Show

This method returns payment data.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-credit-transfers, instant-sepa-credit-transfers Can raise: ProductUnknown, ProductInvalid
bulk_payment_id (path)
string, required
Payment identifier on Salt Edge PSD2 Compliance side. Can raise: ResourceUnknown
Response

This method returns payment data.


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.
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.

Bulk Authorisation

This method returns the SCA status of a consent initiation's authorisation subresource.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 414" \ 
 -H "Psu-Corporate-ID: 4142" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id/authorisations/:authorisation_id"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id/authorisations/:authorisation_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-credit-transfers, instant-sepa-credit-transfers Can raise: ProductUnknown, ProductInvalid
bulk_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.


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.
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.

Status

This method returns payment status.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id/status"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id/status

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-credit-transfers, instant-sepa-credit-transfers Can raise: ProductUnknown, ProductInvalid
bulk_payment_id (path)
string, required
Payment identifier on Salt Edge PSD2 Compliance side. Can raise: ResourceUnknown
Response

This method returns payment status.


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.
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.

CURL

curl -i  \ 
 -H "TPP-Redirect-URI: https://redirect-my-psu-here.please" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -H "Content-Type: application/json" \ 
 -H "TPP-Redirect-Preferred: true" \ 
 -d '{}' \ 
-X DELETE "/:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id"

Example of response

Request

DELETE /:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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 string, 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: sepa-credit-transfers, cross-border-credit-transfers, instant-sepa-credit-transfers Can raise: ProductUnknown, ProductInvalid
bulk_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.


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.
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 Bulk Payment

Will deliver an array of resource identifications to all generated cancellation authorisation subresources.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 414" \ 
 -H "Psu-Corporate-ID: 4142" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id/cancellation-authorisations"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id/cancellation-authorisations

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-credit-transfers, instant-sepa-credit-transfers Can raise: ProductUnknown, ProductInvalid
bulk_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.


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.
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 Bulk Payment

This method returns the SCA status of a payment cancellation's authorisation subresource.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 414" \ 
 -H "Psu-Corporate-ID: 4142" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id/cancellation-authorisations/:authorisation_id"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/bulk-payments/:payment_product/:bulk_payment_id/cancellation-authorisations/:authorisation_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-credit-transfers, instant-sepa-credit-transfers Can raise: ProductUnknown, ProductInvalid
bulk_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.


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.
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 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.
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.

CURL

curl -i  \ 
 -H "TPP-Redirect-URI: https://redirect-my-psu-here.please" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "Psu-IP-Address: 255.255.255.255" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -H "Content-Type: application/json" \ 
 -H "TPP-Redirect-Preferred: true" \ 
 -d '{
  "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"
}' \ 
-X POST "/:provider_code/api/berlingroup/v1/periodic-payments/:payment_product"

Example of parameters

Example of response

Request

POST /:provider_code/api/berlingroup/v1/periodic-payments/:payment_product

Headers
Header Type Description
X-Request-ID string, required 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
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.
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-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
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 string, 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.
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
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.


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.
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.

Show

This method returns payment data.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-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.


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.
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.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 414" \ 
 -H "Psu-Corporate-ID: 4142" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id/authorisations/:authorisation_id"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id/authorisations/:authorisation_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-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.


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.
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.

Status

This method returns payment status.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id/status"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id/status

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-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.


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.
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.

CURL

curl -i  \ 
 -H "TPP-Redirect-URI: https://redirect-my-psu-here.please" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 531" \ 
 -H "Psu-Corporate-ID: 511" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -H "Content-Type: application/json" \ 
 -H "TPP-Redirect-Preferred: true" \ 
 -d '{}' \ 
-X DELETE "/:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id"

Example of response

Request

DELETE /:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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 string, 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: sepa-credit-transfers, cross-border-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.


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.
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.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 414" \ 
 -H "Psu-Corporate-ID: 4142" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id/cancellation-authorisations"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id/cancellation-authorisations

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-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.


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.
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.

CURL

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "X-Request-ID: cc5a8022-5e71-460e-82fa-ab0be1997a54" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "Psu-ID: 414" \ 
 -H "Psu-Corporate-ID: 4142" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{}' \ 
-X GET "/:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id/cancellation-authorisations/:authorisation_id"

Example of response

Request

GET /:provider_code/api/berlingroup/v1/periodic-payments/:payment_product/:periodic_payment_id/cancellation-authorisations/:authorisation_id

Headers
Header Type Description
X-Request-ID string, required 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
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.
Psu-IP-Address string, optional 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-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
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: sepa-credit-transfers, cross-border-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.


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.
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.

Codes for VO

In case of RUB transfer.

Code Description
01010 Sale of a foreign currency for the currency of the Russian Federation by a resident
01030 Purchase of a foreign currency for the currency of the Russian Federation by a resident
01040 Purchase (sale) of one foreign currency for another foreign currency by a resident
02010 Purchase of the currency of the Russian Federation for a foreign currency by a non-resident
02020 Sale of the currency of the Russian Federation for a foreign currency by a non-resident
10100 Payments by a non-resident to a resident in the form of a prepayment for goods being exported from the territory of the Russian Federation including payments under a contract of commission (a brokerage contract, a contract of agency) (an advance payment), excluding payments specified in the group 22 of this List
10200 Payments by a non-resident if a resident has allowed a delay of payment for goods having been exported from the territory of the Russian Federation including payments under a contract of commission (a brokerage contract, a contract of agency) (a delay of payment), excluding payments specified in the group 22 of this List
10800 Payments of a resident in favour of a non-resident concerned with the return of overpaid (erroneous) monetary funds while exporting of goods from the territory of the Russian Federation, excluding payments under the code 22800
11100 Payments by a resident to a non-resident in the form of a prepayment for goods being imported to the territory of the Russian Federation including payments under a contract of commission (a brokerage contract, a contract of agency) (an advance payment), excluding payments specified in the group 23 of this List
11200 Payments by a resident if a non-resident has allowed a delay of payment for goods having been imported to the territory of the Russian Federation including payments under a contract of commission (a brokerage contract, a contract of agency) (a delay of payment), excluding payments specified in the group 23 of this List.
11900 Payments of a non-resident in favour of a resident concerned with the return of overpaid (erroneous) monetary funds while importing of goods to the Russian Federation, excluding payments under the code 23900
12050 Payments of a non-resident in favour of a resident for goods being sold outside the territory of the Russian Federation without their import to the territory of the Russian Federation, excluding payments under the codes 22110, 22210, 22300
12060 Payments of a resident in favour of a non-resident for goods being sold outside the territory of the Russian Federation without their import to the territory of the Russian Federation, excluding payments under the codes 23110, 23210, 23300
12800 Payments of a resident in favour of a non-resident concerned with the return of overpaid (erroneous) monetary funds while selling goods outside the territory of the Russian Federation, excluding payments under the code 22800
12900 Payments of a non-resident in favour of a resident concerned with the return of overpaid (erroneous) monetary funds while selling goods outside the territory of the Russian Federation, excluding payments under the code 23900
13010 Payments of a non-resident in favour of a resident for goods being sold in the territory of the Russian Federation, excluding payments under the codes 22110, 22210, 22300
13020 Payments of a resident in favour of a non-resident for goods being sold in the territory of the Russian Federation, excluding payments under the codes 23110, 23210, 23300
13800 Payments of a resident in favour of a non-resident concerned with the return of overpaid (erroneous) monetary funds while selling goods in the territory of the Russian Federation, excluding payments under the code 22800
13900 Payments of a non-resident in favour of a resident concerned with the return of overpaid (erroneous) monetary funds while selling goods in the territory of the Russian Federation, excluding payments under the code 23900
20100 Payments by a non-resident in the form of a prepayment for resident's performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them, including fulfillment of the specified obligations under the commission agreement (agency agreement, contract of assignment), as well as payments related to the prepaymen of remuneration to the resident–trust manager under the contract of trust management of property, resident-broker under the contract of brokerage services, residentthe clearing organization under the contract of clearing services (an advance payment), excluding payments by the code 20400, payments specified in group 22 of this List
20200 Payments by a non-resident in the form of a prepayment for resident's performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them, including fulfillment of the specified obligations under the commission agreement (agency agreement, contract of assignment), as well as payments related to the prepaymen of remuneration to the resident–trust manager under the contract of trust management of property, resident-broker under the contract of brokerage services, residentthe clearing organization under the contract of clearing services (a delay of payment), excluding payments by the code 20400, payments specified in group 22 of this List
20500 Payments of a resident commission agent (an agent, a warrantor) in favour of a non-resident committent (a principal) concerned with a resident's provision of services such as realization of non-resident's goods, works, services, data and results of intellectual activities, including exclusive rights to them, for other persons under a contract of commission (a brokerage contract, a contract of agency), excluding payments specified in the group 58 of this List
20800 Payments of a resident in favour of a non-resident concerned with the return of overpaid (erroneous) monetary funds for resident's performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them, excluding payments specified in the groups 22 and 58 of this List
21100 Payments by a resident in the form of a prepayment for non-resident's performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them, including fulfillment of the specified obligations under the commission agreement (agency agreement, contract of assignment), as well as payments related to the prepaymen of remuneration to the non-resident–trust manager under the contract of trust management of property, non-resident-broker under the contract of brokerage services, nonresident-the clearing organization under the contract of clearing services (an advance payment), excluding payments by the code 21400, payments specified in group 23 of this List
21200 Payments by a resident in the form of a prepayment for non-resident's performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them, including fulfillment of the specified obligations under the commission agreement (agency agreement, contract of assignment), as well as payments related to the prepaymen of remuneration to the non-resident–trust manager under the contract of trust management of property, non-resident-broker under the contract of brokerage services, nonresident-the clearing organization under the contract of clearing services (a delay of payment), excluding payments by the code 21400, payments specified in group 23 of this List
21500 Payments of a non-resident commission agent (an agent, a warrantor) in favour of a resident committent (a principal) concerned with a non-resident's provision of services such as realization of resident's goods, works, services, data and results of intellectual activities, including exclusive rights to them, for other persons under a contract of commission (a brokerage contract, a contract of agency), excluding payments specified in the group 58 of this List
21900 Payments of a non-resident in favour of a resident concerned with the return of overpaid (erroneous) monetary funds for non-resident's performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them, excluding payments specified in the groups 23 and 58 of this List
22100 Payments by a non-resident, including which committent (a principal) to a resident, including which commission agent (an agent, a warrantor) in the form of a prepayment for the export of goods from the territory of the Russian Federation, performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them (an advance payment), excluding payments under the codes 20100 and 22110
22110 Payments by a non-resident to a resident in the form of a prepayment for delivery goods, performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them under contracts (agreements) specified in the subparagraph 4.1.2 of the paragraph 4.1 of this Instruction (an advance payment)
22200 Payments by a non-resident, including which committent (a principal) if a resident, including which commission agent (an agent, a warrantor) has allowed a delay of payment for goods having been exported from the territory of the Russian Federation, performed works, provided services, transferred data and results of intellectual activities including exclusive rights to them (a delay of payment), excluding payments under the codes 20200 22210
22210 Payments by a non-resident if a resident has allowed a delay of payment for delivered goods, performed works, provided services, transferred data and results of intellectual activities including exclusive rights to them under contracts (agreements) specified in the subparagraph 4.1.2 of the paragraph 4.1 of this Instruction (a delay of payment)
22300 Payments of a non-resident in favour of a resident under a contract of financial lease (leasing)
22800 Payments of a resident in favour of a non-resident concerned with the return of overpaid (erroneous) monetary funds under mixed contracts
23100 Payments by a residen, including which committent (a principal) to a non-resident, including which commission agent (an agent, a warrantor) in the form of a prepayment for goods being imported to the territory of the Russian Federation, performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them (an advance payment), excluding payments under the codes 21100 and 23110
23110 Payments by a resident to a non-resident in the form of a prepayment for delivery goods, performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them under contracts specified in the subparagraph 4.1.2 of the paragraph 4.1 of this Instruction (an advance payment)
23200 Payments by a resident, including which committent (a principal) if a non-resident, including which commission agent (an agent, a warrantor) has allowed a delay of payment for goods having been imported to the territory of the Russian Federation, performed works, provided services, transferred data and results of intellectual activities including exclusive rights to them (a delay of payment), excluding payments under the codes 21200 and 23210
23210 Payments by a resident if a non-resident has allowed a delay of payment for delivered goods, performed works, provided services,transferred data and results of intellectual activities including exclusive rights to them under contracts specified in the subparagraph 4.1.2 of the paragraph 4.1 of this Instruction (a delay of payment)
23300 Payments of a resident in favour of a non-resident under a contract of financial lease (leasing)
23900 Payments of a non-resident in favour of a resident concerned with the return of overpaid (erroneous) monetary funds under mixed contracts
30010 Payments of a non-resident in favour of a resident for real estate being purchased outside the territory of the Russian Federation including payments related to the non-resident's share participation in the resident's real estate development outside the territory of the Russian Federation
30020 Payments of a resident in favour of a non-resident for real estate being purchased outside the territory of the Russian Federation including payments related to the resident's share participation in the non-resident's real estate development outside the territory of the Russian Federation
30030 Payments of a non-resident in favour of a resident for real estate being purchased in the territory of the Russian Federation including payments related to the non-resident's share participation in the resident's real estate development in the territory of the Russian Federation
30040 Payments of a resident in favour of a non-resident for real estate being purchased in the territory of the Russian Federation including payments related to the resident's share participation in the non-resident's real estate development in the territory of the Russian Federation
30800 Payments of a resident in favour of a non-resident concerned with the return of overpaid (erroneous) monetary funds in the course of real estate operations including payments related to a share participation in a real estate development
30900 Payments of a non-resident in favour of a resident concerned with the return of overpaid (erroneous) monetary funds in the course of real estate operations including payments related to a share participation in a real estate development
32010 Payments of a non-resident in favour of a resident for a claim being assigned by the resident to the non-resident under a contract of cession
32015 Payments of a resident in favour of a non-resident for a claim being assigned by the nonresident to the resident under a contract of cession
32020 Payments of a non-resident in favour of a resident for a debt being transferred by the nonresident to the resident under a contract of debt transfer
32025 Payments of a resident in favour of a non-resident for a debt being transferred by the resident to the non-resident under a contract of debt transfer
35030 Payments of a non-resident in favour of a resident in the course of other operations concerned with foreign trade activity that have not been directly specified in the groups 10–23 of this List
35040 Payments of a resident in favour of a non-resident in the course of other operations connected with foreign trade activity that have not been directly specified in the groups 10–23 of this List
40030 Payments of a resident in favour of a non-resident while providing with monetary funds under a loan contract
40900 Payments of a non-resident in favour of a resident concerned with the return of overpaid (erroneous) monetary funds while providing of a loan for the non-resident under a loan contract by the resident
41030 Payments by a non-resident in favour of a resident while providing with monetary funds under a credit agreement, a loan contract
41800 Payments by a resident in favour of a non-resident connected with the return of overpaid (erroneous) monetary funds while providing the resident by the non-resident with a loan or a credit under a credit agreement, a loan contract
42015 Payments of a resident in favour of a non-resident for repayment of a principal debt under a credit agreement, a loan contract
42035 Payments of a resident in favour of a non-resident for repayment of interest under a credit agreement, a loan contract
42050 Other payments of a resident in favour of a non-resident concerned with payment of premiums (commissions) and other monetary funds under a taken out credit, loan
42900 Payments of a non-resident in favour of a resident concerned with the return of overpaid (erroneous) monetary funds upon repayment of a principal debt under a credit agreement, a loan contract
42950 Payments of a non-resident in favour of a resident concerned with the return of overpaid interest under a credit agreement, a loan contract
43015 Payments of a non-resident in favour of a resident for repayment of a principal debt under a loan contract
43035 Payments of a non-resident in favour of a resident for repayment of interest under a loan contract
43050 Other payments of a non-resident in favour of a resident concerned with payment of premiums (commissions) and other monetary funds under a taken out loan
43800 Payments of a resident in favour of a non-resident concerned with the return of overpaid (erroneous) monetary funds upon non-resident's repayment of a principal debt under a loan contract
43850 Payments of a resident in favour of a non-resident concerned with the return of overpaid (erroneous) monetary funds upon repayment of interest under a loan contract
50100 Payments of a resident in favour of a non-resident in the course of operations with participatory shares, deposits, contributions to estate (a charter or a share capital, a co-op share fund) of a legal entity, as well as under a contract of particular partnership
50110 Payments of a resident in favour of a non-resident upon payment of dividends (an income) from investments in the form of capital investments
50200 Payments of a non-resident in favour of a resident in the course of operations with participatory shares, deposits, contributions to estate (a charter or a share capital, a co-op share fund) of a legal entity, as well as under a contract of particular partnership
50210 Payments of a non-resident in favour of a resident upon payment of dividends (an income) from investments in the form of capital investments
50800 Payments of a resident in favor of a non-resident related to the return to a non-resident of overpaid (erroneous) monetary funds on transactions related to payment by a non-resident of a share, a deposit, a share in the property (charter or share capital, share fund of the cooperative) of a legal entity, as well as a contribution under a simple partnership agreement with investment in the form of capital investments, as in the liquidation of a resident legal entity.
50900 Payments of a non-resident in favor of a resident related to the return to a non-resident of overpaid (erroneous) monetary funds on transactions related to payment by a non-resident of a share, a deposit, a share in the property (charter or share capital, share fund of the cooperative) of a legal entity, as well as a contribution under a simple partnership agreement with investment in the form of capital investments, as in the liquidation of a non-resident legal entity
51210 Payments of a non-resident in favour of a resident for purchase of resident's bonds, shares and other equity securities
51215 Payments of a non-resident in favour of a resident for purchase of non-resident's bonds, shares and other equity securities
51230 Payments of a non-resident in favour of a resident for purchase of shares of investment funds founded by the resident
51235 Payments of a non-resident in favour of a resident for purchase of shares of investment funds founded by the non-resident
51250 Payments of a non-resident in favour of a resident for purchase of bills and other non-equity securities issued by the resident
51255 Payments of a non-resident in favour of a resident for purchase of bills and other non-equity securities issued by non-residents
51800 Payments of a resident in favour of a non-resident concered with the return of overpaid (erroneous) monetary funds in the course of operations with securities (rights certified by securities), as well as monetary funds under such defaulted obligations
52210 Payments of a resident in favour of a non-resident for purchase of residents' bonds, shares and other equity securities
52215 Payments of a resident in favour of a non-resident for purchase of non-residents' bonds, shares and other equity securities
52230 Payments of a resident in favour of a non-resident for purchase of shares of investment funds founded by the non-resident
52235 Payments of a resident in favour of a non-resident for purchase of shares of investment funds founded by the resident
52250 Payments of a resident in favour of a non-resident for purchase of bills and other non-equity securities issued by residents
52255 Payments of a resident in favour of a non-resident for purchase of bills and other non-equity securities issued by non-residents
52900 Payments of a non-resident in favour of a resident concered with the return of overpaid (erroneous) monetary funds in the course of operations with securities (rights certified by securities), as well as monetary funds under such defaulted obligations
55210 Payments of a resident in favour of a non-resident while fulfilling obligations by the resident concerning bonds, shares and other equity securities
55230 Payments of a resident in favour of a non-resident upon payment of income received from investment funds' shares
55250 Payments of a resident in favour of a non-resident while fullfilling obligations by the resident concerning bills and other non-equity securities
55310 Payments of a non-resident in favour of a resident while fulfilling obligations by the nonresident concerning bonds and other equity securities
55330 Payments of a non-resident in favour of a resident upon payment of income received from investment funds' shares
55350 Payments of a non-resident in favour of a resident while fullfilling obligations by the nonresident concerning bills and other non-equity securities
55800 Payments of a resident in favour of a non-resident connected with the return of overpaid (erroneous) monetary funds while fulfilling obligations concerning operations with securities, as well as monetary funds under defaulted obligations
55900 (erroneous) monetary funds while fulfilling obligations concerning operations with securities, as well as monetary funds under defaulted obligations
56010 Payments ofy a non-resident in favour of a resident in the course of operations with futures transactions and financial derivatives (premiums, margin and guarantee fees, and other monetary funds being transferred in accordance with the terms and conditions of such contracts, excluding payments concerning a delivery of underlying asset)
56060 Payments of a resident in favour of a non-resident in the course of operations with futures transactions and financial derivatives (premiums, margin and guarantee fees, and other monetary funds being transferred in accordance with the terms and conditions of such contracts, excluding payments concerning a delivery of underlying asset)
56800 Payments by a resident connected with the return to a non-resident of overpaid (erroneous) monetary funds, as well as monetary funds under defaulted obligations specified in this group
56900 Payments by a non-resident connected with the return to a resident of overpaid (erroneous) monetary funds, as well as monetary funds under defaulted obligations specified in this group
57010 Payments in a foreign currency of a resident-trustor in favour of a resident-trustee, including payments of the trustee's remuneration
57015 Payments in a foreign currency of a resident-trustee in favour of a resident-trustor
57020 Payments in a foreign currency and in the currency of the Russian Federation of a non-residenttrustor in favour of a resident-trustee, except for the payments of the trustee's remuneration
57025 Payments in a foreign currency and in the currency of the Russian Federation of a residenttrustee in favour of a non-resident-trustor
57800 Resident's payments connected with the return of overpaid (erroneous) monetary funds to a non-resident under contracts of real estate trust management
57900 Non-resident's payments connected with the return of overpaid (erroneous) monetary funds to a resident under contracts of real estate trust management
58010 Payments of a resident in favour of a non-resident broker, under a contract of broking service, except for the payments of remuneration to the non-resident broker
58020 Payments of a non-resident in favour of a resident broker under a contract of broking service, except for the payments of remuneration to the resident broker
58030 Payments between residents in a foreign currency under a contract of broking service, including payments of remuneration to a broker
58700 Settlements of resident brokers related to returning funds to a resident on the basis of a brokerage contract
58800 Payments by a resident connected with the return of overpaid (erroneous) monetary funds to a non-resident under a contract of broking service
58900 Payments by a non-resident connected with the return of overpaid (erroneous) monetary funds to a resident under a contract of broking service
60070 Transfers of the currency of the Russian Federation from a non-resident’s bank account in the currency of the Russian Federation to another bank account (a deposit account) of the same non-resident in the currency of the Russian Federation opened in the same authorized bank, and from a non-resident’s deposit account in the currency of the Russian Federation to a bank account of the same non-resident opened in the same authorized bank
60071 Transfers of the currency of the Russian Federation from a non-resident’s bank account in the currency of the Russian Federation opened in an authorized bank to a bank account (a deposit account) of the same non-resident in the currency of the Russian Federation opened in another authorized bank, and from a non-resident’s deposit account in the currency of the Russian Federation to a bank account of the same non-resident opened in another authorized bank
60075 Transfers of the currency of the Russian Federation from a non-resident’s bank account in the currency of the Russian Federation opened in an authorized bank to a bank account (a deposit account) of the same non-resident in the currency of the Russian Federation opened in a nonresident bank
60080 Transfers of the currency of the Russian Federation from a non-resident’s bank account in the currency of the Russian Federation to a bank account of another non-resident (a deposit account) in the currency of the Russian Federation opened in the same authorized bank
60081 Transfers of the currency of the Russian Federation from a non-resident’s bank account in the currency of the Russian Federation opened in an authorized bank to a bank account (a deposit account) of another non-resident in the currency of the Russian Federation opened in another authorized bank
60090 Withdrawal of the currency of the Russian Federation from a non-resident’s account in the currency of the Russian Federation opened in an authorized bank
60095 Crediting with the currency of the Russian Federation a non-resident’s account in the currency of the Russian Federation opened in an authorized bank
61070 Payments between residents in a foreign currency under contracts of freigt forwarding, carriage and affreightment (charter) while providing by a forwarder, a carrier and a freighter with services connected with carriage of cargo being exported from the Russian Federation or being imported to the Russian Federation, transit carriage of cargo through the territory of the Russian Federation, as well as under insurance contracts of the specified cargo
61100 Transfers of a foreign currency from a resident’s transit currency account to another transit currency account of this resident or to a foreign currency current account of this resident
61115 Payments in a foreign currency between residents who are commission agents (agents, attorneies) and residents who are principals (principals, trustors) while providing by the commission agents (agents, attorneies) of services relating to conclusion and execution of contracts with non-residents concerning a delivery of goods, performance of works, provision of services, transfer of data and results of intellectual activities including exclusive rights to them, including operations of the return of monetary funds to the principals (the principals, the trustors), excluding payments under the codes 57010, 58030 and 61162
61130 Transfers of a foreign currency from a resident’s foreign currency current account opened in an authorized bank to a foreign currency account of the same resident opened in the same authorized bank, and from a resident’s foreign currency account opened in an authorized bank to a foreign currency current account of the same resident opened in the same authorized bank
61135 Transfers of a foreign currency from a resident’s foreign currency current account opened in an authorized bank to a foreign currency account of the same resident opened in another authorized bank, and from a resident’s foreign currency account of a resident opened in an authorized bank to a foreign currency current account of the same resident opened in another authorized bank
61140 Transfers of a foreign currency or the currency of the Russian Federation from a resident’s account opened in a non-resident bank to an account of the same resident opened in an authorized bank
61145 Transfers of a foreign currency from a resident’s account opened in a non-resident bank to an account of another resident opened in an authorized bank
61150 Transfers of a foreign currency from a resident’s current account opened in an authorized bank to an account of the same resident opened in a non-resident bank
61155 Transfers of a foreign currency or the currency of the Russian Federation from a resident’s current account opened in an authorized bank to an account of another resident opened in a non-resident bank
61160 Payments between residents in a foreign currency connected with depositing and return of individual, collective and (or) another clearing collateral in accordance with the Federal Law dated February,7, 2011, No. 7-FZ On clearing, clearing activities and central counterparty
61161 Payments between residents in a foreign currency on the basis of the results of clearing being made in accordance with the Federal Law On clearing, clearing activities and central counterparty
61162 Payments in a foreign currency between residents who are commission agents (agents, attorneies) and residents who are principals (principals, trustors) while providing by the commission agents (the agents, the attorneies) of services relating to conclusion and execution of contracts upon which obligations are to be fulfilled on the basis of the results of clearing being made in accordance with the Federal Law On clearing, clearing activities and central counterparty , including the return of monetary funds to the principals (the principals, the trustors)
61163 Payments in a foreign currency between residents connected with execution and (or) termination of a contract that is a financial derivative
61170 Withdrawal of a cash foreign currency from a resident’s foreign currency account opened in an authorized bank
61175 Crediting a resident’s foreign currency account with a cash foreign currency opened in an authorized bank
70010 Payments of a non-resident in favour of a resident connected with payment of taxes, fees and other duties, excluding payments under the code 70120
70020 Payments of a resident in favour of a non-resident connected with payment of taxes, fees and other duties, excluding payments under the code 70125
70030 Payments connected with payment of pensions, benefits and other social benefits by a nonresident to a resident , excluding payments under the code 70120
70040 Payments connected with payment of pensions, benefits and other social benefits by a resident to a non-resident, excluding payments under the code 70125
70050 Payments connected with wage payments and other similar payments by a non-resident to a resident, excluding payments under the code 70120
70060 Payments connected with wage payments and other similar payments by a resident to a nonresident, excluding payments under the code 70125
70090 Payments connected with rendering of gratuitous financial aid by a non-resident to a resident, excluding payments under the code 70100
70095 Payments connected with rendering of gratuitous financial aid by a resident to a non-resident, excluding payments under the code 70105
70100 Payments connected with rendering of charitable aid, collection of donations, payment (receipt) of grants and other non-repayable payments by a non-resident to a resident
70105 Payments connected with rendering of charitable aid, collection of donations, payment (receipt) of grants and other non-repayable payments by a resident to a non-resident
70110 Payments of a non-resident in favour of a resident connected with payment of an insurance claim under a contract of insurance or reinsurance
70115 Payments of a resident in favour of a non-resident connected with payment of an insurance claim under a contract of insurance or reinsurance
70120 Payments of a non-resident in favour of a resident connected with execution of court decisions
70125 Payments of a resident in favour of a non-resident connected with execution of court decisions
70200 Other payments of a non-resident in favour of a resident in the course of non-trade operations, excluding payments under the codes 70010, 70030, 70050, 70090, 70100, 70110, 70120
70205 Other payments of a resident in favour of a non-resident in the course of non-trade operations, excluding payments under the codes 70020, 70040, 70060, 70095, 70105, 70115, 70125
70800 Payments of a resident in favour of a non-resident connected with return of overpaid (erroneous) monetary funds in the course of non-trade operations
70900 Payments of a non-resident in favour of a resident connected with the return of overpaid (erroneous) monetary funds in the course of non-trade operations
80010 Payments between a non-resident and an authorized bank in the currency of the Russian Federation under a loan contract
80020 Debiting the currency of the Russian Federation from a non-resident’s bank account in the currency of the Russian Federation due to opening of a letter of credit
80021 Crediting the currency of the Russian Federation to a non-resident’s bank account in the currency of the Russian Federation in connection with the return of the unused amount of the letter of credit under closing of a letter of credit
80050 Payments between non-residents and an authorized bank in the currency of the Russian Federation in the course of other operations, excluding payments specified in groups 02, 57 and 58 of this List, and excluding payments under the codes 80010, 80020, 80021
80110 Payments between a resident and an authorized bank in a foreign currency under a loan contract
80120 Debiting a foreign currency, currency of the Russian Federation from a resident’s current account in an authorized bank due to opening of a letter of credit in favour of a non-resident
80121 Crediting a foreign currency, currency of the Russian Federation to a resident’s current account in an authorized bank in connection with the return of the unused amount of the letter of credit under closing of a letter of credit
80150 Payments between a resident and an authorized bank in a foreign currency in the course of other operations, excluding payments specified in groups 01, 57 and 58 of this List, and excluding payments under the codes 80110, 80120, 80121
99010 Return of wrongly debited (credited) monetary funds to a resident, including the return of funds correspondent banks
99020 Return of wrongly debited (credited) monetary funds to a non-resident
99090 Payments concerning operations unspecified in the groups 01–80 of this List, excluding payments under the codes 99010, 99020, 99030, 99035 as well

Codes for UAE

In case of transfers to UAE.

Code Description
ACM Agency Commissions
AES Advance payment against EOS
AFA Receipts or payments from personal residents bank account or deposits abroad
AFL Receipts or payments from personal non-resident bank account in the UAE
ALW Allowance
ATS Air transport
BON Bonus
CCP Corporate Card Payments
CEA Equity and investment fund shares for the establishment of new company from residents abroad, equity of merger or acquisition of companies abroad from residents and participation to capital increase of related companies abroad
CEL Equity and investment fund shares for the establishment of new company in the UAE from nonresidents, equity of merger or acquisition of companies in the UAE from non- residents and participation to capital increase of related companies from non- residents in the UAE
CHC Charitable Contributions (Charity and Aid)
CIN Commercial Investments
COM Commission
COP Compensation
CRP Credit Card Payment
DCP Debit Card Payments
DIV Dividend Payouts From FI
DLA Purchases and sales of foreign debt securities in not related companies - more than a year
DLF Debt instruments intragroup loans, deposits foreign (above 10% share)
DLL Purchases and sales of securities issued by residents in not related companies - more than a year
DOE Dividends on equity not intragroup
DSA Purchases and sales of foreign debt securities in not related companies - less than a year
DSF Debt instruments intragroup foreign securities
DSL Purchases and sales of securities issued by residents in not related companies - less than a year
EDU Educational Support
EMI Equated Monthly Installments
EOS End of Service / Final Settlem
FAM Family Support (Workers' remittances)
FDA Financial derivatives foreign
FDL Financial derivatives in the UAE
FIA Investment fund shares foreign
FIL Investment fund shares in the UAE
FIS Financial services
FSA Equity other than investment fund shares in not related companies abroad
FSL Equity other than investment fund shares in not related companies in the UAE
GDE Goods sold (Exports in fob value)
GDI Goods bought (Imports in cif value)
GMS Processing repair and maintenance services on goods
GOS Government goods and services embassies etc
GRI Government related income taxes, tariffs, capital transfers, etc.
IFS Information services
IGD Dividends intragroup
IGT INTER GROUP TRANSFER
IID Interest on debt intragroup
INS Insurance services
IOD Income on deposits
IOL Income on loans
IPC Charges for the use of intellectual property royalties
IPO IPO Subscriptions
IRP INTEREST RATE SWAP PAYMENTS
IRW INTERST RATE UNWIND PAYMENTS
ISH Income on investment funds shares
ISL Interest on securities more than a year
ISS Interest on securities less than a year
ITS Computer services
LAS Leave Salary
LDL Debt instruments intragroup loans, deposits in the UAE (above 10% share)
LDS Debt instruments intragroup securities in the UAE
LEA Leasing abroad
LEL Leasing in the UAE
LIP Loan Interest Payments
LLA Loans - Long Drawings or Repayments on loans extended to nonresidents term
LLL Loans - Long Drawings or Repayments on foreign loans extended to residents term
LNC Loan Charges
LND Loan Disbursements From FI
MCR Monetary Claim Reimbursements
MWI MOBILE WALLET CARD CASH IN
MWO MOBILE WALLET CARD CASH OUT
MWP MOBILE WALLET CARD PAYMENTS
OAT OWN ACCOUNT TRNSFER
OTS Other modes of transport (including Postal and courier services)
OVT Overtime
PEN Pension
PIN Personal Investments
PIP Profits on Islamic products
PMS Professional and management consulting services
POR Refunds/Reversals on IPO subscriptions
POS POS Merchant Settlement
PPA Purchase of real estate abroad from residents
PPL Purchase of real estate in the UAE from non-residents
PRP PROFIT RATE SWAP PAYMENTS
PRR Profits or rents on real estate
PRS Personal, cultural, audiovisual and recreational services
PRW PROFIT RATE UNWIND PAYMENTS
RDA Reverse debt instruments abroad
RDL Reverse debt instruments in the UAE
RDS Research and development services
REA Reverse equity share abroad
REL Reverse equity share in the UAE
RFS Repos on foreign securities
RLS Repos on securities issued by residents
RNT Rent Payments
SAA Salary Advance
SAL Salary (Compensation of employees)
SCO Construction
SLA Loans – Short Drawings or Repayments on loans extended to nonresidents term
SLL Loans – Short Drawings or Repayments on foreign loans extended to residents term
STR Travel
STS Sea transport
SVI STORED VALUE CARD CASH IN
SVO STORED VALUE CARD CASH OUT
SVP STORED VALUE CARD PAYMENTS
TCP Trade credits and advances payable
TCR Trade credits and advances receivable
TCS Telecommunication services
TKT Tickets
TOF Transfer of funds between persons Normal and Juridical
TTS Technical, traded and other business services relate
UFP Unclaimed Funds Placement
UTL Utility Bill Payments
TAX TAX Payment
XAT TAX Refund