Skip to main content
There are three ways to retrieve payment data:
  1. returnUrl. Once the payment is completed, the customer is redirected to the returnUrl you specified in the request, passing key details such as the payment status and ID.
  2. Check payment status. You can request data about the payment using its PaymentId. For more details, see Check payment status.
  3. webhookUrl. If you provided a webhookUrl, you can listen for events and receive notifications when the payment’s status changes.
Sample webhook URL: https://test.example.com/api/notification/valuehere?key=your-key-value-here

​
Sample webhook body (successful payment)


{
 "PaymentId":"bc973098-3dfb-4700-af20-28ca4fdb583a",
 "Status":"Done",
 "Signature":"b2e286bfc7b94ab2342342341881c85b50f286b23462436432d7dfc5fcd05ca2r234r231",
 "MerchantPaymentId":"12345678-1234-1234-1234-12345678910",
 "Reference":"12345678 PAYMENT",
 "Amount":50.0,
 "Currency":"EUR",
 "CardId":null,
 "Remitter":{
    "Name":"User Testing",
    "Iban":"TT123456789HFE112345",
    "SortCode":null,
    "AccountNumber":null
 },
 "AdditionalData":null,
 "DetailedInfo":null,
 "Method":"open-banking",
 "BankId":"sparkasse_de",
 "IsSenderBank":false,
 "BankTransactionId":"BANKTRANSACTIONID",
 "Settled":"Yes",
 "SettlementDate":"2024-10-01T07:18:56.316302Z"
}

​
Sample webhook body (failed payment)


{
 "PaymentId":"fa315e4d-bc55-4671-88ff-ece52a801690",
 "Status":"Failed",
 "Signature":"b2e286bfc7b94ab2342342341881c85b50f286b23462436432d7dfc5fcd05ca2r234r231",
 "MerchantPaymentId":"12345678-1234-1234-1234-12345678910",
 "Reference":"12345678 PAYMENT",
 "Amount":50.0,
 "Currency":"EUR",
 "CardId":null,
 "Remitter":{
    "Name":"User Testing",
    "Iban":"TT123456789HFE112345",
    "SortCode":null,
    "AccountNumber":null
 },
 "AdditionalData":null,
 "DetailedInfo":null,
 "Method":"open-banking",
 "BankId":"sparkasse_de",
 "IsSenderBank":false,
 "BankTransactionId":null,
 "Settled":"No",
 "SettlementDate":null
}

​
Extended webhook features

If you enabled extended webhook features, you’ll receive additional data in the webhook body, including the rejectReason and processingStatus from the sender’s bank. You can activate this in your Rocka Hub account settings.

​
Sample extended webhook body (successful payment)

 {
 "PaymentId":"bc973098-3dfb-4700-af20-28ca4fdb583a",
 "Status":"Done",
 "Signature":"b2e286bfc7b94ab2342342341881c85b50f286b23462436432d7dfc5fcd05ca2r234r231",
 "MerchantPaymentId":"12345678-1234-1234-1234-12345678910",
 "Reference":"12345678 PAYMENT",
 "Amount":50.0,
 "Currency":"EUR",
 "CardId":null,
 "Remitter":{
    "Name":"User Testing",
    "Iban":"TT123456789HFE112345",
    "SortCode":null,
    "AccountNumber":null
 },
 "AdditionalData":null,
 "DetailedInfo":{
    "RejectReason":null,
    "ProcessingStatus":"Settled"
 },
 "Method":"open-banking",
 "BankId":"sparkasse_de",
 "IsSenderBank":false,
 "BankTransactionId":"BANKTRANSACTIONID",
 "Settled":"Yes",
 "SettlementDate":"2024-10-01T07:18:56.316302Z"
}

​
Sample extended webhook body (failed payment)

{
 "PaymentId":"49798514-dc44-4c7e-bce3-47778a3a91da",
 "Status":"Failed",
 "Signature":"b2e286bfc7b94ab2342342341881c85b50f286b23462436432d7dfc5fcd05ca2r234r231",
 "MerchantPaymentId":"12345678-1234-1234-1234-12345678910",
 "Reference":"12345678 PAYMENT",
 "Amount":50.0,
 "Currency":"EUR",
 "CardId":null,
 "Remitter":{
    "Name":"User Testing",
    "Iban":"TT123456789HFE112345",
    "SortCode":null,
    "AccountNumber":null
 },
 "AdditionalData":null,
 "DetailedInfo":{
    "RejectReason":"FINANCIAL INSTITUTION: INITIATION ABANDONED",
    "ProcessingStatus":null
 },
 "Method":"open-banking",
 "BankId":"sparkasse_de",
 "IsSenderBank":false,
 "BankTransactionId":"BANKTRANSACTIONID",
 "Settled":"No",
 "SettlementDate":"2024-10-01T07:18:56.316302Z"
}
Last modified on April 27, 2026