Payments

Authorisation statuses

The current stage of the authorisation lifecycle is represented in scaStatus field. The status of the authorisation can be one of the following:

Name Description
accepted An authorisation or cancellation-authorisation resource has been created successfully on Salt Edge PSD2 Compliance's side and was sent to ASPSP.
received An authorisation or cancellation-authorisation resource has been created successfully on ASPSP's side.
psuIdentified The PSU related to the authorisation or cancellation-authorisation resource has been identified.
psuAuthenticated The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.
scaMethodSelected The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of "received".
started The addressed SCA routine has been started.
unconfirmed SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet.
finalised The SCA routine has been finalised successfully (including a potential confirmation command). This is a final status of the authorisation resource.
failed The SCA routine failed. This is a final status of the authorisation resource.
exempted SCA was exempted for the related transaction, the related authorisation is successful. This is a final status of the authorisation resource.

Payment Order statuses

The current stage of a payment order lifecycle is represented in transactionStatus field. The status of a payment order can be one of the following:

Code Name Description
ACCC AcceptedSettlementCompleted Settlement on the creditor's account has been completed.
ACCP AcceptedCustomerProfile Preceding check of technical validation was successful. Customer profile check was also successful.
ACSC AcceptedSettlementCompleted Settlement on the debtor’s account has been completed.
ACSP AcceptedSettlementInProcess All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
ACTC AcceptedTechnicalValidation Authentication and syntactical and semantical validation are successful.
ACWC AcceptedWithChange Instruction is accepted but a change will be made, such as date or remittance not sent.
ACWP AcceptedWithoutPosting Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account.
RCVD Received Payment initiation has been received by the receiving agent.
PDNG Pending Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
RJCT Rejected Payment initiation or individual transaction included in the payment initiation has been rejected.
CANC Cancelled Payment initiation has been cancelled before execution.
Remark: This code is accepted as new code by ISO20022.
ACFC AcceptedFundsChecked Pre-ceeding check of technical validation and customer profile was successful and an automatic funds check was positive.
Remark: This code is accepted as new code by ISO20022.
PATC PartiallyAcceptedTechnicalCorrect The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful.
Remark: This code is accepted as new code by ISO20022.
PART PartiallyAccepted A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. Remark: This code may be used only in case of bulk payments. It is only used in a situation where all mandated authorisations have been applied, but some payments have been rejected.

Create

This method is used to instruct Salt Edge PSD2 Compliance Solution to initialize the payment creation.

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 '{
  "remittanceInformationUnstructured": "Payment description",
  "creditorName": "John Smith",
  "instructedAmount": {
    "currency": "EUR",
    "amount": "145.3"
  },
  "requestedExecutionDate": "2029-06-11",
  "endToEndIdentification": "cc5a8022-5e71-460e-82fa-ab0be1997a5",
  "debtorAccount": {
    "iban": "FK54RAND61068421435452"
  },
  "creditorAddress": {
    "streetName": "str. First of May",
    "buildingNumber": "43c",
    "townName": "Budapest",
    "postCode": "445511",
    "country": "HU"
  },
  "creditorAgentName": "Smith John"
}' \ 
-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, SignatureMalformed
Date datetime, required Endpoint request execution date.
Psu-ID string, optional Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID string, optional Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID string, optional UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent string, optional The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location string, optional The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate string, required The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds). Can raise: CertificateMissing, CertificateInvalid
Signature string, required A signature of the request by the TPP on application level. This might be mandated by ASPSP. Can raise: CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type string, required The media type of the body of the request. Allowed values: application/json
TPP-Redirect-Preferred boolean, optional If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. Default value: true Can raise: BadRequest
TPP-Redirect-URI url, optional URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is strongly recommended to add a unique identifier for validation purposes on TPP side.
Psu-IP-Address string, required The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.
TPP-Explicit-Authorisation-Preferred boolean, optional If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket. Default value: false
Request parameters
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.
FieldInvalid 400
BadRequest 400 Given value is invalid.
CertificateMissing 401 This request cannot be performed without Certificate header.
CertificateInvalid 401 Given certificate is invalid.
SignatureInvalid 401 Given signature is invalid.
SignatureMissing 401 This request cannot be performed without Signature header.
SignatureMalformed 401 Given signature is malformed.
ProductInvalid 403 The payment product is not supported by the addressed service/resource.
ProductUnknown 404 The payment product wasn't found.
ResourceUnknown 404 The addressed resource is unknown relative to the TPP.

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, SignatureMalformed
Date datetime, required Endpoint request execution date.
Psu-ID string, optional Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID string, optional Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID string, optional UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent string, optional The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location string, optional The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate string, required The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds). Can raise: CertificateMissing, CertificateInvalid
Signature string, required A signature of the request by the TPP on application level. This might be mandated by ASPSP. Can raise: CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Request parameters
provider_code (path)
string, required
Human readable Provider identifier.
payment_product (path)
string, required
The addressed payment product. Allowed values: sepa-credit-transfers, instant-sepa-credit-transfers, faster-payment-service, cross-border-credit-transfers, fedwire-credit-transfers Can raise: ProductUnknown, ProductInvalid
payment_id (path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side. Can raise: ResourceUnknown
Response

This method returns payment data.


Related Errors
Class Code Description
CertificateMissing 401 This request cannot be performed without Certificate header.
CertificateInvalid 401 Given certificate is invalid.
SignatureInvalid 401 Given signature is invalid.
SignatureMissing 401 This request cannot be performed without Signature header.
SignatureMalformed 401 Given signature is malformed.
ProductInvalid 403 The payment product is not supported by the addressed service/resource.
ProductUnknown 404 The payment product wasn't found.
ResourceUnknown 404 The addressed resource is unknown relative to the TPP.

Authorisation

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

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, SignatureMalformed
Date datetime, required Endpoint request execution date.
Psu-ID string, optional Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID string, optional Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID string, optional UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent string, optional The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location string, optional The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate string, required The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds). Can raise: CertificateMissing, CertificateInvalid
Signature string, required A signature of the request by the TPP on application level. This might be mandated by ASPSP. Can raise: CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Request parameters
provider_code (path)
string, required
Human readable Provider identifier.
payment_product (path)
string, required
The addressed payment product. Allowed values: sepa-credit-transfers, instant-sepa-credit-transfers, faster-payment-service, cross-border-credit-transfers, fedwire-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.
SignatureMalformed 401 Given signature is malformed.
ProductInvalid 403 The payment product is not supported by the addressed service/resource.
ProductUnknown 404 The payment product wasn't found.
ResourceUnknown 404 The addressed resource is unknown relative to the TPP.

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, SignatureMalformed
Date datetime, required Endpoint request execution date.
Psu-ID string, optional Client ID of the PSU in the ASPSP client interface.
Psu-Corporate-ID string, optional Only used in a corporate context. If provided, specific corporate accounts will be returned.
PSU-Device-ID string, optional UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-User-Agent string, optional The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Geo-Location string, optional The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
TPP-Signature-Certificate string, required The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds). Can raise: CertificateMissing, CertificateInvalid
Signature string, required A signature of the request by the TPP on application level. This might be mandated by ASPSP. Can raise: CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type string, required The media type of the body of the request. Allowed values: application/json
Request parameters
provider_code (path)
string, required
Human readable Provider identifier.
payment_product (path)
string, required
The addressed payment product. Allowed values: sepa-credit-transfers, instant-sepa-credit-transfers, faster-payment-service, cross-border-credit-transfers, fedwire-credit-transfers Can raise: ProductUnknown, ProductInvalid
payment_id (path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side. Can raise: ResourceUnknown
Response

This method returns payment status.


Related Errors
Class Code Description
CertificateMissing 401 This request cannot be performed without Certificate header.
CertificateInvalid 401 Given certificate is invalid.
SignatureInvalid 401 Given signature is invalid.
SignatureMissing 401 This request cannot be performed without Signature header.
SignatureMalformed 401 Given signature is malformed.
ProductInvalid 403 The payment product is not supported by the addressed service/resource.
ProductUnknown 404 The payment product wasn't found.
ResourceUnknown 404 The addressed resource is unknown relative to the TPP.

Codes

All Payment Purpose Codes

Purpose of Payment Code for all countries except Bahrain and UAE

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

AE Payment Purpose Codes

Purpose of Payment Code for United Arab Emirates

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

BH Payment Purpose Codes

Purpose of Payment Code for Bahrain

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