Signing Baskets
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. |
×
![]()
Signing Basket statuses
The current stage of a signing basket lifecycle is represented in
transactionStatus
field. The status of a signing basket order can be one of the following:
| Code | Name | Description |
|---|---|---|
| ACTC | AcceptedTechnicalValidation | Authentication and syntactical and semantical validation are successful. |
| RCVD | Received | Signing Basket has been received by the receiving agent. |
| RJCT | Rejected | Signing Basket or individual transaction included in the Signing Basket has been rejected. |
| CANC | Cancelled |
Signing Basket has been cancelled before execution.
Remark: This code is accepted as new code by ISO20022. |
| PATC | PartiallyAcceptedTechnicalCorrect |
The signing basket 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. |
×
![]()
Create
Create a signing basket resource for authorising several transactions with one SCA method. The resource identifications of these transactions are contained in the payload of this access method.
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 '{ "paymendIds": [ 213, 214, 215 ] }' \ -X POST "/:provider_code/api/berlingroup/v1/signing-baskets"
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 '{
"paymendIds": [
213,
214,
215
]
}' \
-X POST "/:provider_code/api/berlingroup/v1/signing-baskets"Example of parameters
{"paymendIds":[213,214,215]}
{"paymendIds":[213,214,215]}
Example of response
{"basketId":105,"transactionStatus":"RCVD","_links":{"scaStatus":{"href":"/demobank/v1/signing-baskets/105/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"self":{"href":"/demobank/v1/signing-baskets/105"},"status":{"href":"/demobank/v1/signing-baskets/105/status"}}}
{"basketId":105,"transactionStatus":"RCVD","_links":{"scaStatus":{"href":"/demobank/v1/signing-baskets/105/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"self":{"href":"/demobank/v1/signing-baskets/105"},"status":{"href":"/demobank/v1/signing-baskets/105/status"}}}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
Request
POST
/:provider_code/api/berlingroup/v1/signing-baskets
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 |
TPP-Redirect-URI
|
url, required | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. |
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. |
Request parameters
provider_code
(path)
string, required
Human readable Provider identifier.
paymentIds
array, required
A non empty array of paymentIds.
Can raise:
ReferenceMixInvalid, ReferenceStatusInvalid
Response headers
| Header | Type | Description |
|---|---|---|
Location
|
string, required | Location of the created resource (if created). |
ASPSP-SCA-Approach
|
string, required | Selected by ASPSP SCA Approach Allowed values: REDIRECT, EMBEDDED, DECOUPLED |
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
basketId
integer, required
ID of the corresponding signing basket object.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
RCVD
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, required
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| ReferenceMixInvalid | 400 | The used combination of referenced objects is not supported in the ASPSPs signing basket function. |
| 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. |
| ReferenceStatusInvalid | 409 | At least one of the references is already fully authorised. |
×
![]()
Authorisation
This method returns the SCA status of a signing basket 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/signing-baskets/:basket_id/authorisations/:authorisation_id"
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/signing-baskets/:basket_id/authorisations/:authorisation_id"Example of response
{"scaStatus":"started"}
{"scaStatus":"started"}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
Request
GET
/:provider_code/api/berlingroup/v1/signing-baskets/:basket_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.
basket_id
(path)
string, required
Resource identification of the related signing basket resource.
Can raise:
ResourceUnknown
authorisation_id
(path)
string, required
Unique resource identification of the created authorization subresource.
Can raise:
ResourceUnknown
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
scaStatus
string, required
The link to retrieve the scaStatus of the corresponding authorization subresource. Here you can find definitions for all statuses.
Allowed values:
accepted, received, psuIdentified, psuAuthenticated, scaMethodSelected, started, finalised, failed, exempted, unconfirmed
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| ResourceUnknown | 404 | The addressed resource is unknown relative to the TPP. |
×
![]()
Show
Retrieve the signing basket content
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/signing-baskets/:basket_id"
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/signing-baskets/:basket_id"Example of response
{"payments":[213,214,215],"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/singing-baksets/105"},"status":{"href":"/demobank/v1/singing-baksets/105/status"},"scaStatus":{"href":"/demobank/v1/singing-baksets/105/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"payments":[213,214,215],"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/singing-baksets/105"},"status":{"href":"/demobank/v1/singing-baksets/105/status"},"scaStatus":{"href":"/demobank/v1/singing-baksets/105/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
Request
GET
/:provider_code/api/berlingroup/v1/signing-baskets/:basket_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.
basket_id
(path)
integer, required
Resource identification of the related signing basket resource.
Can raise:
ResourceUnknown
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
payments
array, required
Payment initiations which shall be authorised through this signing basket.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
RCVD, RJCT, CANC, ACTC, ACTC, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, required
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| ResourceUnknown | 404 | The addressed resource is unknown relative to the TPP. |
×
![]()
Status
Read the status of the signing basket.
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/signing-baskets/:basket_id/status"
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/signing-baskets/:basket_id/status"Example of response
{"transactionStatus":"ACTwC"}
{"transactionStatus":"ACTwC"}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
Request
GET
/:provider_code/api/berlingroup/v1/signing-baskets/:basket_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.
basket_id
(path)
integer, required
Resource identification of the related signing basket resource.
Can raise:
ResourceUnknown
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
RCVD, RJCT, CANC, ACTC, ACTC, PATC
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| ResourceUnknown | 404 | The addressed resource is unknown relative to the TPP. |
×
![]()
Revoke
It initiates the cancellation of a signing_basket.
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/signing-baskets/:basket_id"
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/signing-baskets/:basket_id"Example of response
{"transactionStatus":"RCVD","_links":{"status":{"href":"/demobank/v1/signing-baskets/186/status"},"self":{"href":"/demobank/v1/signing-baskets/186"},"scaStatus":{"href":"/demobank/v1/signing-baskets/186/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"transactionStatus":"RCVD","_links":{"status":{"href":"/demobank/v1/signing-baskets/186/status"},"self":{"href":"/demobank/v1/signing-baskets/186"},"scaStatus":{"href":"/demobank/v1/signing-baskets/186/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
Request
DELETE
/:provider_code/api/berlingroup/v1/signing-baskets/:basket_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 |
TPP-Redirect-Preferred
|
boolean, optional | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. Default value: true |
TPP-Redirect-URI
|
url, required | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. |
Request parameters
provider_code
(path)
string, required
Human readable Provider identifier.
basket_id
(path)
integer, required
Resource identification of the related signing basket resource.
Can raise:
ResourceUnknown, CancellationInvalid
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| 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
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/signing-baskets/:basket_id/cancellation-authorisations"
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/signing-baskets/:basket_id/cancellation-authorisations"Example of response
{"authorisationIds":["123auth456"]}
{"authorisationIds":["123auth456"]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
Request
GET
/:provider_code/api/berlingroup/v1/signing-baskets/:basket_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, 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.
basket_id
(path)
integer, required
Resource identification of the related signing basket resource.
Can raise:
ResourceUnknown, CancellationInvalid
Response
Will deliver an array of resource identifications to all generated cancellation authorisation subresources.
authorisationIds
array, required
An array of all authorisationIds connected to this signing basket.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| 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 Authorisation
This method returns the SCA status of a signing basket 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/signing-baskets/:basket_id/cancellation-authorisations/:authorisation_id"
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/signing-baskets/:basket_id/cancellation-authorisations/:authorisation_id"Example of response
{"scaStatus":"psuAuthenticated"}
{"scaStatus":"psuAuthenticated"}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
Request
GET
/:provider_code/api/berlingroup/v1/signing-baskets/:basket_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, 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.
basket_id
(path)
integer, required
Resource identification of the related signing basket resource.
Can raise:
ResourceUnknown, CancellationInvalid
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 signing basket cancellation's authorisation subresource.
scaStatus
string, required
The link to retrieve the scaStatus of the corresponding authorization subresource. Here you can find definitions for all statuses.
Allowed values:
accepted, received, psuIdentified, psuAuthenticated, scaMethodSelected, started, finalised, failed, exempted, unconfirmed
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| 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. |
×
![]()
Payments
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 '{ "instructedAmount": { "amount": "145.3", "currency": "EUR" }, "creditorName": "John Smith", "creditorAccount": { "bban": "450746508" }, "remittanceInformationUnstructured": "Payment description", "debtorAccount": { "bban": "836076798" }, "creditorAddress": { "streetName": "str. First of May", "buildingNumber": "43c", "townName": "Budapest", "postCode": "445511", "country": "HU" }, "creditorAgentName": "Smith John" }' \ -X POST "/:provider_code/api/berlingroup/v1/payments/:payment_product"
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 '{
"instructedAmount": {
"amount": "145.3",
"currency": "EUR"
},
"creditorName": "John Smith",
"creditorAccount": {
"bban": "450746508"
},
"remittanceInformationUnstructured": "Payment description",
"debtorAccount": {
"bban": "836076798"
},
"creditorAddress": {
"streetName": "str. First of May",
"buildingNumber": "43c",
"townName": "Budapest",
"postCode": "445511",
"country": "HU"
},
"creditorAgentName": "Smith John"
}' \
-X POST "/:provider_code/api/berlingroup/v1/payments/:payment_product"Example of parameters
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2029-06-11","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2029-06-11","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description","debtorAccount":{"bban":"836076798"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description","debtorAccount":{"bban":"836076798"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2029-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","iban":"FK54RAND61068421435452","sortCode":"22-33-44","swiftCode":"HDSSGBKC131"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2029-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","iban":"FK54RAND61068421435452","sortCode":"22-33-44","swiftCode":"HDSSGBKC131"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","purposeCode":"OPTN","creditorName":"Firstname Lastname","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX","accountNumber":"123445665","sortCode":"00-00-00"},"debtorAccount":{"bankAccountIdentifier":"CRNXXX"},"instructedAmount":{"amount":"96","currency":"USD"},"requestedExecutionDate":"2029-06-11"}
{"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","purposeCode":"OPTN","creditorName":"Firstname Lastname","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX","accountNumber":"123445665","sortCode":"00-00-00"},"debtorAccount":{"bankAccountIdentifier":"CRNXXX"},"instructedAmount":{"amount":"96","currency":"USD"},"requestedExecutionDate":"2029-06-11"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"beneficiaryAlias":"Some value","remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","transferReason":"Tax bills","creditorAddress":{"buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"CN","streetName":"Some Street Name"},"creditorAgentName":"Smith John","creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"debtorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"}}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"beneficiaryAlias":"Some value","remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","transferReason":"Tax bills","creditorAddress":{"buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"CN","streetName":"Some Street Name"},"creditorAgentName":"Smith John","creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"debtorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"}}
{"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"}
{"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"}
{"remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2029-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","debtorAccount":{"iban":"FK54RAND61068421435452"},"creditorAccount":{"iban":"FK54RAND61068421435451"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1"}
{"remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2029-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","debtorAccount":{"iban":"FK54RAND61068421435452"},"creditorAccount":{"iban":"FK54RAND61068421435451"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"debtorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"}}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"debtorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"}}
Example of response
{"paymentId":911,"_links":{"scaStatus":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"self":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/status"}},"transactionStatus":"PDNG"}
{"paymentId":911,"_links":{"scaStatus":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"self":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/status"}},"transactionStatus":"PDNG"}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
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 recommended to always use this header field. |
Psu-IP-Address
|
string, required | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request. |
TPP-Explicit-Authorisation-Preferred
|
boolean, optional | If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket. Default value: false |
Request parameters
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
sortCode
string, required
Number code, which is used by British and Irish banks.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
sortCode
string, optional
Number code, which is used by British and Irish banks.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, optional
Bank codes used in British and Irish banking systems.
iban
string, required
International Bank Account Number
bban
string, optional
Basic Bank Account Number
swiftCode
string, optional
Business Identifier Code.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, required
Wrapper for creditor address details
streetName
string, required
Residence street address
buildingNumber
string, required
Building number
townName
string, required
Town of residence
postCode
string, optional
Address post code
country
string, required
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
stateOrProvince
string, optional
State or province
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
creditor_account_number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, required
debtor_account_number
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, required
Wrapper for creditor address details
streetName
string, required
Residence street address
buildingNumber
string, required
Building number
townName
string, required
Town of residence
postCode
string, required
Address post code
country
string, required
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
stateOrProvince
string, required
State or province
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentAddress
hash, required
Wrapper for creditor agent address details.
streetName
string, optional
Residence street address.
buildingNumber
string, optional
Building number.
townName
string, optional
Town of residence.
postCode
string, optional
Address post code.
country
string, required
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
routingCode
string, required
FRB routing number
accountNumber
string, required
Account number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
purposeCode
string, required
Specifies the external purpose code in the format of character string with a maximum length of 4 characters as per ISO20022.
Allowed values:
OPTN, BEXP, GDSV, CHAR, LOAR, FORW, GIFT, IVPT, OTHR, DIVD, FREX, INVS, SAVG, TREA, PAYR
purposeDescription
string, optional
Is required if the external purpose code is defined as 'OTHR'. Indicates the specific description for purpose of the payment.
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
sortCode
string, optional
Sort code
accountNumber
string, optional
Bank account number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bankAccountIdentifier
string, optional
Internal bank account identifier
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, required
Credit sortCode
bban
string, required
Creditor BBAN
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
sortCode
string, required
Debtor sortCode
bban
string, required
Debtor BBAN
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
pan
string, required
Permanent Account Number.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
pan
string, required
Permanent Account Number.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
aba
string, required
ABA Routing Number as identifier for USD payments.
iban
string, optional
International Bank Account Number. Please note that at least one of these codes (IBAN or BBAN) must be provided.
bban
string, optional
Basic Bank Account Number. Please note that at least one of these codes (BBAN or IBAN) must be provided.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
msisdn
string, required
A number uniquely identifying a subscription in a Global System for Mobile communications or a Universal Mobile Telecommunications System mobile network.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
Response headers
| Header | Type | Description |
|---|---|---|
ASPSP-SCA-Approach
|
string, optional | Selected by ASPSP SCA Approach Allowed values: REDIRECT, EMBEDDED, DECOUPLED |
Response
This method is used to instruct Salt Edge PSD2 Compliance Solution to initialize the payment creation.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG
paymentId
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CountryNameInvalid | 400 | Country doesn't exist or is invalid. Expected alpha 2 ISO3166 format. |
| BadRequest | 400 | Given value is invalid. |
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| ProductInvalid | 403 | The payment product is not supported by the addressed service/resource. |
| ProductUnknown | 404 | The payment product wasn't found. |
| ResourceUnknown | 404 | The addressed resource is unknown relative to the TPP. |
×
![]()
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"
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
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/target-2-payments/911"},"status":{"href":"/demobank/v1/payments/target-2-payments/911/status"},"scaStatus":{"href":"/demobank/v1/payments/target-2-payments/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/target-2-payments/911"},"status":{"href":"/demobank/v1/payments/target-2-payments/911/status"},"scaStatus":{"href":"/demobank/v1/payments/target-2-payments/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/faster-payment-service/911"},"status":{"href":"/demobank/v1/payments/faster-payment-service/911/status"},"scaStatus":{"href":"/demobank/v1/payments/faster-payment-service/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/faster-payment-service/911"},"status":{"href":"/demobank/v1/payments/faster-payment-service/911/status"},"scaStatus":{"href":"/demobank/v1/payments/faster-payment-service/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description","debtorAccount":{"bban":"836076798"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/internal-transfer/911"},"status":{"href":"/demobank/v1/payments/internal-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/payments/internal-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description","debtorAccount":{"bban":"836076798"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/internal-transfer/911"},"status":{"href":"/demobank/v1/payments/internal-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/payments/internal-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","iban":"FK54RAND61068421435452","sortCode":"22-33-44","swiftCode":"HDSSGBKC131"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/ipayliknks-payment/911"},"status":{"href":"/demobank/v1/payments/ipayliknks-payment/911/status"},"scaStatus":{"href":"/demobank/v1/payments/ipayliknks-payment/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","iban":"FK54RAND61068421435452","sortCode":"22-33-44","swiftCode":"HDSSGBKC131"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/ipayliknks-payment/911"},"status":{"href":"/demobank/v1/payments/ipayliknks-payment/911/status"},"scaStatus":{"href":"/demobank/v1/payments/ipayliknks-payment/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","debtorAccount":{"iban":"FK54RAND61068421435452"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/wu-money-transfer/911"},"status":{"href":"/demobank/v1/payments/wu-money-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/payments/wu-money-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","debtorAccount":{"iban":"FK54RAND61068421435452"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/payments/wu-money-transfer/911"},"status":{"href":"/demobank/v1/payments/wu-money-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/payments/wu-money-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","debtorAccount":{"iban":"FK54RAND61068421435452"},"creditorAccount":{"iban":"FK54RAND61068421435451"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1","_links":{"self":{"href":"/demobank/v1/payments/credit-transfers/911"},"status":{"href":"/demobank/v1/payments/credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"requestedExecutionDate":"2019-06-11","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","debtorAccount":{"iban":"FK54RAND61068421435452"},"creditorAccount":{"iban":"FK54RAND61068421435451"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1","_links":{"self":{"href":"/demobank/v1/payments/credit-transfers/911"},"status":{"href":"/demobank/v1/payments/credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","debtorId":"0101303019","centralBankPurposeCode":"TBD","chargesAccount":"string","serviceLevel":"string","chargeBearer":"string","creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"debtorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"_links":{"self":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"transactionStatus":"PDNG","creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","debtorId":"0101303019","centralBankPurposeCode":"TBD","chargesAccount":"string","serviceLevel":"string","chargeBearer":"string","creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"debtorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708","bic":"NBIIISRE"},"_links":{"self":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911"},"status":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/payments/cross-border-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"fundsAvailable":true}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payment_id
(path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
Response
This method returns payment data.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
sortCode
string, required
Number code, which is used by British and Irish banks.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
sortCode
string, optional
Number code, which is used by British and Irish banks.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, optional
Bank codes used in British and Irish banking systems.
iban
string, required
International Bank Account Number
bban
string, optional
Basic Bank Account Number
swiftCode
string, optional
Business Identifier Code.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, required
Wrapper for creditor address details
streetName
string, required
Residence street address
buildingNumber
string, required
Building number
townName
string, required
Town of residence
postCode
string, optional
Address post code
country
string, required
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
stateOrProvince
string, optional
State or province
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
creditor_account_number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, required
debtor_account_number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, required
Wrapper for creditor address details
streetName
string, required
Residence street address
buildingNumber
string, required
Building number
townName
string, required
Town of residence
postCode
string, required
Address post code
country
string, required
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
stateOrProvince
string, required
State or province
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentAddress
hash, required
Wrapper for creditor agent address details.
streetName
string, optional
Residence street address.
buildingNumber
string, optional
Building number.
townName
string, optional
Town of residence.
postCode
string, optional
Address post code.
country
string, required
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
routingCode
string, required
FRB routing number
accountNumber
string, required
Account number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
purposeCode
string, required
Specifies the external purpose code in the format of character string with a maximum length of 4 characters as per ISO20022.
Allowed values:
OPTN, BEXP, GDSV, CHAR, LOAR, FORW, GIFT, IVPT, OTHR, DIVD, FREX, INVS, SAVG, TREA, PAYR
purposeDescription
string, optional
Is required if the external purpose code is defined as 'OTHR'. Indicates the specific description for purpose of the payment.
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
sortCode
string, optional
Sort code
accountNumber
string, optional
Bank account number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bankAccountIdentifier
string, optional
Internal bank account identifier
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, required
Credit sortCode
bban
string, required
Creditor BBAN
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
sortCode
string, required
Debtor sortCode
bban
string, required
Debtor BBAN
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
pan
string, required
Permanent Account Number.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
pan
string, required
Permanent Account Number.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
aba
string, required
ABA Routing Number as identifier for USD payments.
iban
string, optional
International Bank Account Number. Please note that at least one of these codes (IBAN or BBAN) must be provided.
bban
string, optional
Basic Bank Account Number. Please note that at least one of these codes (BBAN or IBAN) must be provided.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
fundsAvailable
boolean, optional
Funds availability information from ASPSP.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
requestedExecutionDate
date, optional
If contained, the payment initiation request will be executed at the addressed date.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
msisdn
string, required
A number uniquely identifying a subscription in a Global System for Mobile communications or a Universal Mobile Telecommunications System mobile network.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| ProductInvalid | 403 | The payment product is not supported by the addressed service/resource. |
| ProductUnknown | 404 | The payment product wasn't found. |
| ResourceUnknown | 404 | The addressed resource is unknown relative to the TPP. |
×
![]()
Bulk Payments
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. |
| 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 '{ "payments": [ { "instructedAmount": { "amount": "145.3", "currency": "EUR" }, "creditorName": "John Smith", "creditorAccount": { "sortCode": "22-44-55", "swiftCode": "HDSSGBKC132", "iban": "FK53RAND61068421435422", "bban": "450746508" }, "remittanceInformationUnstructured": "Payment description" } ], "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"
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": {
"sortCode": "22-44-55",
"swiftCode": "HDSSGBKC132",
"iban": "FK53RAND61068421435422",
"bban": "450746508"
},
"remittanceInformationUnstructured": "Payment description"
}
],
"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
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"<a>Payment description</a>"}],"debtorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"<a>Payment description</a>"}],"debtorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"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"}
{"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"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"bban":"836076798"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"bban":"836076798"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"remittanceInformationUnstructured":"Payment description"}],"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"remittanceInformationUnstructured":"Payment description"}],"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK53RAND61068421435422"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK53RAND61068421435422"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2029-06-01","requestedExecutionTime":"2029-06-01T13:50:49+03:00"}
Example of response
{"bulkPaymentId":911,"_links":{"scaStatus":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"self":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911/status"}},"transactionStatus":"PDNG"}
{"bulkPaymentId":911,"_links":{"scaStatus":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"self":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911/status"}},"transactionStatus":"PDNG"}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
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, 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 recommended to always use this header field. |
Psu-IP-Address
|
string, required | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request. |
TPP-Explicit-Authorisation-Preferred
|
boolean, optional | If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket. Default value: false |
Request parameters
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
sortCode
string, required
Number code, which is used by British and Irish banks.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
sortCode
string, optional
Number code, which is used by British and Irish banks.
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, optional
Bank codes used in British and Irish banking systems.
iban
string, required
International Bank Account Number
bban
string, optional
Basic Bank Account Number
swiftCode
string, optional
Business Identifier Code.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorAddress
hash, required
Wrapper for creditor address details
streetName
string, required
Residence street address
buildingNumber
string, required
Building number
townName
string, required
Town of residence
postCode
string, optional
Address post code
country
string, required
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
stateOrProvince
string, optional
State or province
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
creditor_account_number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, required
debtor_account_number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
routingCode
string, required
FRB routing number
accountNumber
string, required
Account number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
purposeCode
string, required
Specifies the external purpose code in the format of character string with a maximum length of 4 characters as per ISO20022.
Allowed values:
OPTN, BEXP, GDSV, CHAR, LOAR, FORW, GIFT, IVPT, OTHR, DIVD, FREX, INVS, SAVG, TREA, PAYR
purposeDescription
string, optional
Is required if the external purpose code is defined as 'OTHR'. Indicates the specific description for purpose of the payment.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
sortCode
string, optional
Sort code
accountNumber
string, optional
Bank account number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bankAccountIdentifier
string, optional
Internal bank account identifier
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, required
Credit sortCode
bban
string, required
Creditor BBAN
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
sortCode
string, required
Debtor sortCode
bban
string, required
Debtor BBAN
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
pan
string, required
Permanent Account Number.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
pan
string, required
Permanent Account Number.
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
aba
string, required
ABA Routing Number as identifier for USD payments.
iban
string, optional
International Bank Account Number. Please note that at least one of these codes (IBAN or BBAN) must be provided.
bban
string, optional
Basic Bank Account Number. Please note that at least one of these codes (BBAN or IBAN) must be provided.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
payments
array, required
A list which follows the JSON formats for the supported products for single payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
msisdn
string, required
A number uniquely identifying a subscription in a Global System for Mobile communications or a Universal Mobile Telecommunications System mobile network.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on TPP side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
Response headers
| Header | Type | Description |
|---|---|---|
ASPSP-SCA-Approach
|
string, optional | Selected by ASPSP SCA Approach Allowed values: REDIRECT, EMBEDDED, DECOUPLED |
Response
This method is used to instruct Salt Edge PSD2 Compliance Solution to initialize the payment creation.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
bulkPaymentId
string, required
Payment identifier on Salt Edge PSD2 Compliance side.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CountryNameInvalid | 400 | Country doesn't exist or is invalid. Expected alpha 2 ISO3166 format. |
| BadRequest | 400 | Given value is invalid. |
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| ProductInvalid | 403 | The payment product is not supported by the addressed service/resource. |
| 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"
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
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/bulk-payments/instant-sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/bulk-payments/instant-sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"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":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/target-2-payments/911"},"status":{"href":"/demobank/v1/bulk-payments/target-2-payments/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/target-2-payments/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"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":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/target-2-payments/911"},"status":{"href":"/demobank/v1/bulk-payments/target-2-payments/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/target-2-payments/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/faster-payment-service/911"},"status":{"href":"/demobank/v1/bulk-payments/faster-payment-service/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/faster-payment-service/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/faster-payment-service/911"},"status":{"href":"/demobank/v1/bulk-payments/faster-payment-service/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/faster-payment-service/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"bban":"836076798"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/internal-transfer/911"},"status":{"href":"/demobank/v1/bulk-payments/internal-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/internal-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"bban":"450746508"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"bban":"836076798"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/internal-transfer/911"},"status":{"href":"/demobank/v1/bulk-payments/internal-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/internal-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"remittanceInformationUnstructured":"Payment description"}],"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/ipaylinks-payment/911"},"status":{"href":"/demobank/v1/bulk-payments/ipaylinks-payment/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/ipaylinks-payment/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"remittanceInformationUnstructured":"Payment description"}],"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/ipaylinks-payment/911"},"status":{"href":"/demobank/v1/bulk-payments/ipaylinks-payment/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/ipaylinks-payment/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/cross-border-credit-transfers/911"},"status":{"href":"/demobank/v1/bulk-payments/cross-border-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/cross-border-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/cross-border-credit-transfers/911"},"status":{"href":"/demobank/v1/bulk-payments/cross-border-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/cross-border-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK53RAND61068421435422"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/wu-money-transfer/911"},"status":{"href":"/demobank/v1/bulk-payments/wu-money-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/wu-money-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"paymentsData":{"payments":[{"instructedAmount":{"amount":"145.3","currency":"EUR"},"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description"}],"debtorAccount":{"iban":"FK53RAND61068421435422"},"paymentInformationId":"cc5a8022-5e71-460e-82fa-ab0be1997a54","batchBookingPreferred":false,"requestedExecutionDate":"2019-06-01","requestedExecutionTime":"2019-06-01T13:50:49+03:00"},"transactionStatus":"ACTC","_links":{"self":{"href":"/demobank/v1/bulk-payments/wu-money-transfer/911"},"status":{"href":"/demobank/v1/bulk-payments/wu-money-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/bulk-payments/wu-money-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}}}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
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, 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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-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.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
sortCode
string, required
Number code, which is used by British and Irish banks.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
sortCode
string, optional
Number code, which is used by British and Irish banks.
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, optional
Bank codes used in British and Irish banking systems.
iban
string, required
International Bank Account Number
bban
string, optional
Basic Bank Account Number
swiftCode
string, optional
Business Identifier Code.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorAddress
hash, required
Wrapper for creditor address details
streetName
string, required
Residence street address
buildingNumber
string, required
Building number
townName
string, required
Town of residence
postCode
string, optional
Address post code
country
string, required
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
stateOrProvince
string, optional
State or province
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
creditor_account_number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, required
debtor_account_number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
routingCode
string, required
FRB routing number
accountNumber
string, required
Account number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
purposeCode
string, required
Specifies the external purpose code in the format of character string with a maximum length of 4 characters as per ISO20022.
Allowed values:
OPTN, BEXP, GDSV, CHAR, LOAR, FORW, GIFT, IVPT, OTHR, DIVD, FREX, INVS, SAVG, TREA, PAYR
purposeDescription
string, optional
Is required if the external purpose code is defined as 'OTHR'. Indicates the specific description for purpose of the payment.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
sortCode
string, optional
Sort code
accountNumber
string, optional
Bank account number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bankAccountIdentifier
string, optional
Internal bank account identifier
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, required
Credit sortCode
bban
string, required
Creditor BBAN
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
sortCode
string, required
Debtor sortCode
bban
string, required
Debtor BBAN
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
pan
string, required
Permanent Account Number.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
pan
string, required
Permanent Account Number.
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
aba
string, required
ABA Routing Number as identifier for USD payments.
iban
string, optional
International Bank Account Number. Please note that at least one of these codes (IBAN or BBAN) must be provided.
bban
string, optional
Basic Bank Account Number. Please note that at least one of these codes (BBAN or IBAN) must be provided.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
paymentsData
hash, required
Wrapper for payment data.
payments
array, required
Array of payment order attributes.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
msisdn
string, required
A number uniquely identifying a subscription in a Global System for Mobile communications or a Universal Mobile Telecommunications System mobile network.
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
paymentInformationId
string, optional
Unique identifier of bulk payment order generated on your side.
batchBookingPreferred
boolean, optional
If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. Default: false.
Default value:
false
requestedExecutionDate
date, optional
If contained, the payments contained in this bulk will be executed at the addressed date. This field may not be used together with the field requestedExecutionTime.
requestedExecutionTime
datetime, optional
If contained, the payments contained in this bulk will be executed at the addressed Date/Time. This field may not be used together with the field requestedExecutionDate.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| ProductInvalid | 403 | The payment product is not supported by the addressed service/resource. |
| ProductUnknown | 404 | The payment product wasn't found. |
| ResourceUnknown | 404 | The addressed resource is unknown relative to the TPP. |
×
![]()
Periodic Payments
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 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", "debtorAccount": { "iban": "FK53RAND61068421435422" }, "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"
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",
"debtorAccount": {
"iban": "FK53RAND61068421435422"
},
"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
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"bban":"450746508"},"debtorAccount":{"bban":"450746510"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"bban":"450746508"},"debtorAccount":{"bban":"450746510"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","debtorAccount":{"iban":"FK53RAND61068421435422"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","debtorAccount":{"iban":"FK53RAND61068421435422"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John"}
{"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","debtorAccount":{"iban":"IS790123260107070101302980","bban":"012326010707"},"creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1"}
{"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","startDate":"2029-06-01","endDate":"2030-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"5","debtorAccount":{"iban":"IS790123260107070101302980","bban":"012326010707"},"creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1"}
Example of response
{"periodicPaymentId":911,"_links":{"scaStatus":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"self":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/status"}},"transactionStatus":"PDNG"}
{"periodicPaymentId":911,"_links":{"scaStatus":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"self":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/status"}},"transactionStatus":"PDNG"}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
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, 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 recommended to always use this header field. |
Psu-IP-Address
|
string, required | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request. |
TPP-Explicit-Authorisation-Preferred
|
boolean, optional | If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket. Default value: false |
Request parameters
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
sortCode
string, required
Number code, which is used by British and Irish banks.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
sortCode
string, optional
Number code, which is used by British and Irish banks.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, optional
Bank codes used in British and Irish banking systems.
iban
string, required
International Bank Account Number
bban
string, optional
Basic Bank Account Number
swiftCode
string, optional
Business Identifier Code.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, required
Wrapper for creditor address details
streetName
string, required
Residence street address
buildingNumber
string, required
Building number
townName
string, required
Town of residence
postCode
string, optional
Address post code
country
string, required
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
stateOrProvince
string, optional
State or province
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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
creditor_account_number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, required
debtor_account_number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
routingCode
string, required
FRB routing number
accountNumber
string, required
Account number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
purposeCode
string, required
Specifies the external purpose code in the format of character string with a maximum length of 4 characters as per ISO20022.
Allowed values:
OPTN, BEXP, GDSV, CHAR, LOAR, FORW, GIFT, IVPT, OTHR, DIVD, FREX, INVS, SAVG, TREA, PAYR
purposeDescription
string, optional
Is required if the external purpose code is defined as 'OTHR'. Indicates the specific description for purpose of the payment.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
sortCode
string, optional
Sort code
accountNumber
string, optional
Bank account number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bankAccountIdentifier
string, optional
Internal bank account identifier
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, required
Credit sortCode
bban
string, required
Creditor BBAN
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
sortCode
string, required
Debtor sortCode
bban
string, required
Debtor BBAN
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
pan
string, required
Permanent Account Number.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
pan
string, required
Permanent Account Number.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
aba
string, required
ABA Routing Number as identifier for USD payments.
iban
string, optional
International Bank Account Number. Please note that at least one of these codes (IBAN or BBAN) must be provided.
bban
string, optional
Basic Bank Account Number. Please note that at least one of these codes (BBAN or IBAN) must be provided.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
provider_code
(path)
string, required
Human readable Provider identifier.
payment_product
(path)
string, required
The addressed payment product.
Allowed values:
sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Payment amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
msisdn
string, required
A number uniquely identifying a subscription in a Global System for Mobile communications or a Universal Mobile Telecommunications System mobile network.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
Response headers
| Header | Type | Description |
|---|---|---|
ASPSP-SCA-Approach
|
string, optional | Selected by ASPSP SCA Approach Allowed values: REDIRECT, EMBEDDED, DECOUPLED |
Response
This method is used to instruct Salt Edge PSD2 Compliance Solution to initialize the payment creation.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG
periodicPaymentId
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CountryNameInvalid | 400 | Country doesn't exist or is invalid. Expected alpha 2 ISO3166 format. |
| BadRequest | 400 | Given value is invalid. |
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| ProductInvalid | 403 | The payment product is not supported by the addressed service/resource. |
| ProductUnknown | 404 | The payment product wasn't found. |
| ResourceUnknown | 404 | The addressed resource is unknown relative to the TPP. |
×
![]()
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"
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
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK54RAND61068421435452","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/instant-sepa-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/target-2-payments/911"},"status":{"href":"/demobank/v1/periodic-payments/target-2-payments/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/target-2-payments/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"iban":"FK54RAND61068421435452"},"debtorAccount":{"iban":"FK53RAND61068421435422"},"instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/target-2-payments/911"},"status":{"href":"/demobank/v1/periodic-payments/target-2-payments/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/target-2-payments/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911"},"status":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAccount":{"bban":"450746508","sortCode":"12-34-56"},"debtorAccount":{"bban":"836076798","sortCode":"22-33-44"},"instructedAmount":{"currency":"EUR","amount":"145.3"},"remittanceInformationUnstructured":"Payment description","creditorName":"John Smith","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911"},"status":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/faster-payment-service/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"bban":"450746508"},"debtorAccount":{"bban":"450746510"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/internal-transfer/911"},"status":{"href":"/demobank/v1/periodic-payments/internal-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/internal-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"bban":"450746508"},"debtorAccount":{"bban":"450746510"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/internal-transfer/911"},"status":{"href":"/demobank/v1/periodic-payments/internal-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/internal-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911"},"status":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"sortCode":"22-44-55","swiftCode":"HDSSGBKC132","iban":"FK53RAND61068421435422","bban":"450746508"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911"},"status":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/ipaylinks-payment/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","creditorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"debtorAccount":{"iban":"FK53RAND61068421435422","bban":"450746508","bic":"BARCGB22XXX"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/cross-border-credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","debtorAccount":{"iban":"FK53RAND61068421435422"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911"},"status":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","instructedAmount":{"amount":"145.3","currency":"EUR"},"remittanceInformationUnstructured":"Payment description","endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","debtorAccount":{"iban":"FK53RAND61068421435422"},"creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","_links":{"self":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911"},"status":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/wu-money-transfer/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","debtorAccount":{"iban":"IS790123260107070101302980","bban":"012326010707"},"creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1","_links":{"self":{"href":"/demobank/v1/periodic-payments/credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"creditorName":"John Smith","remittanceInformationUnstructured":"Payment description","instructedAmount":{"currency":"EUR","amount":"145.3"},"endToEndIdentification":"cc5a8022-5e71-460e-82fa-ab0be1997a5","creditorAddress":{"streetName":"str. First of May","buildingNumber":"43c","townName":"Budapest","postCode":"445511","country":"HU"},"creditorAgentName":"Smith John","startDate":"2019-06-01","endDate":"2020-06-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"05","debtorAccount":{"iban":"IS790123260107070101302980","bban":"012326010707"},"creditorAccount":{"iban":"IS790123260107070101302989","bban":"012326010708"},"ultimateDebtor":"Alex Smith","debtorId":"0101303019","ultimateDebtorId":"0101303019","creditorId":"4703013920","ultimateCreditor":"John Smith","ultimateCreditorId":"4703013920","icelandicPurposeCode":"R1","_links":{"self":{"href":"/demobank/v1/periodic-payments/credit-transfers/911"},"status":{"href":"/demobank/v1/periodic-payments/credit-transfers/911/status"},"scaStatus":{"href":"/demobank/v1/periodic-payments/credit-transfers/911/authorisations/br5a9032-6e21-6f9e-1efa-df0gt1887i78"},"scaRedirect":{"href":"https://user.will.be/redirected/here"}},"transactionStatus":"PDNG"}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
{"tppMessages":[{"category":"ResourceUnknown","code":404,"text":"The addressed resource is unknown relative to the TPP."}]}
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, 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, target-2-payments, faster-payment-service, ipaylinks-payment, cross-border-credit-transfers, credit-transfers, combined-payment, internal-transfer, automated-clearing-house-service, claim-payments, argentex-payment, outbound-sepa-transfer, chaps-transfer, instant-credit-transfers, p2p-card-transfer, fedwire-credit-transfers, masav, zahav, fp, mia-instant-credit-transfers
Can raise:
ProductUnknown, ProductInvalid
periodic_payment_id
(path)
integer, required
Payment identifier on Salt Edge PSD2 Compliance side.
Can raise:
ResourceUnknown
Response
This method returns payment data.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
bic
string, optional
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
bic
string, optional
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
sortCode
string, required
Number code, which is used by British and Irish banks.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
sortCode
string, optional
Number code, which is used by British and Irish banks.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, optional
Bank codes used in British and Irish banking systems.
iban
string, required
International Bank Account Number
bban
string, optional
Basic Bank Account Number
swiftCode
string, optional
Business Identifier Code.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, required
Wrapper for creditor address details
streetName
string, required
Residence street address
buildingNumber
string, required
Building number
townName
string, required
Town of residence
postCode
string, optional
Address post code
country
string, required
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
stateOrProvince
string, optional
State or province
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, required
Bank Identifier Code
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
iban
string, optional
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bic
string, optional
Bank Identifier Code
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
creditor_account_number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, required
debtor_account_number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
routingCode
string, required
FRB routing number
accountNumber
string, required
Account number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
bban
string, required
Basic Bank Account Number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bban
string, optional
Basic Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
purposeCode
string, required
Specifies the external purpose code in the format of character string with a maximum length of 4 characters as per ISO20022.
Allowed values:
OPTN, BEXP, GDSV, CHAR, LOAR, FORW, GIFT, IVPT, OTHR, DIVD, FREX, INVS, SAVG, TREA, PAYR
purposeDescription
string, optional
Is required if the external purpose code is defined as 'OTHR'. Indicates the specific description for purpose of the payment.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, optional
International Bank Account Number
bic
string, optional
Bank Identifier Code
sortCode
string, optional
Sort code
accountNumber
string, optional
Bank account number
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
bankAccountIdentifier
string, optional
Internal bank account identifier
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
sortCode
string, required
Credit sortCode
bban
string, required
Creditor BBAN
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
sortCode
string, required
Debtor sortCode
bban
string, required
Debtor BBAN
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
pan
string, required
Permanent Account Number.
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
pan
string, required
Permanent Account Number.
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
aba
string, required
ABA Routing Number as identifier for USD payments.
iban
string, optional
International Bank Account Number. Please note that at least one of these codes (IBAN or BBAN) must be provided.
bban
string, optional
Basic Bank Account Number. Please note that at least one of these codes (BBAN or IBAN) must be provided.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
bban
string, optional
Basic Bank Account Number
bic
string, optional
Bank Identifier Code
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
iban
string, required
International Bank Account Number
debtorAccount
hash, required
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, required
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
transactionStatus
string, required
The transaction status is filled with codes of the ISO 20022 data table. Here you can find definitions for all statuses.
Allowed values:
PDNG, RCVD, RJCT, CANC, ACCC, ACCP, ACFC, ACSC, ACSP, ACTC, ACWC, ACWP, PATC
instructedAmount
hash, required
Wrapper for payment amount and currency.
amount
string, required
Instructed amount.
currency
string, required
Account currency code from ISO 4217.
Can raise:
ResourceUnknown
endToEndIdentification
string, required
Unique identifier generated on TPP side.
Allowed length:
max: 35 characters
endDate
date, optional
The last applicable day of execution. If not given, it is an infinite standing order.
executionRule
string, optional
This data attribute defines the behavior when recurring payment dates occurs on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day.
Allowed values:
following, preceding
dayOfExecution
string, optional
Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. (Ex. 5 will mean each 5th day of month.)
frequency
string, required
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
Allowed values:
Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
startDate
date, required
The first applicable day of execution starting from this date is the first payment.
remittanceInformationUnstructured
string, optional
Unstructured reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
creditorName
string, required
Name of the creditor for a "Debited" transaction.
creditorAgentName
string, optional
Agent name
creditorAddress
hash, optional
Wrapper for creditor address details
streetName
string, optional
Residence street address
buildingNumber
string, optional
Building number
townName
string, optional
Town of residence
postCode
string, optional
Address post code
country
string, optional
Alpha-2 ISO Code of country of creditor residence.
Can raise:
CountryNameInvalid
creditorAccount
hash, required
Creditor account identifier, can be IBAN, BBAN etc.
msisdn
string, required
A number uniquely identifying a subscription in a Global System for Mobile communications or a Universal Mobile Telecommunications System mobile network.
debtorAccount
hash, optional
Debtor account identifier, can be IBAN, BBAN etc. If optional, then debtor account will be picked by PSU on ASPSP side.
It is required for Signing Baskets payments.
It is required for Signing Baskets payments.
iban
string, optional
International Bank Account Number
_links
hash, required
A list of hyperlinks to be recognized by the TPP.
self
hash, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
href
string, required
The link to specified by wrapper resource.
status
hash, required
The link to retrieve the transaction status of the payment initiation.
href
string, required
The link to specified by wrapper resource.
scaStatus
hash, optional
The link to retrieve the scaStatus of the corresponding authorization subresource. This link is only contained if an authorization subresource has been already created.
href
string, required
The link to specified by wrapper resource.
startAuthorisation
hash, optional
In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
href
string, required
The link to specified by wrapper resource.
scaRedirect
hash, optional
In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
href
string, required
The link to specified by wrapper resource.
tppMessages
array, required
A list of parameters to help with identifying the error.
category
string, required
Error type with which the request failed. Check Related Errors -> Class for a list of values.
Allowed values:
ERROR
code
string, required
Error code with which the request failed. Check Related Errors -> Code for a list of values.
text
string, required
Error description.
Related Errors
| Class | Code | Description |
|---|---|---|
| CertificateMissing | 401 | This request cannot be performed without Certificate header. |
| CertificateInvalid | 401 | Given certificate is invalid. |
| SignatureInvalid | 401 | Given signature is invalid. |
| SignatureMissing | 401 | This request cannot be performed without Signature header. |
| SignatureMalformed | 401 | Given signature is malformed. |
| ProductInvalid | 403 | The payment product is not supported by the addressed service/resource. |
| ProductUnknown | 404 | The payment product wasn't found. |
| ResourceUnknown | 404 | The addressed resource is unknown relative to the TPP. |
×
![]()