Body
application/json
Data of the webhook event
Response
200
OK
curl --request POST \
--url https://{yourDomain}/api/service/webhook-event/deposit.received \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"type": "deposit.received",
"date": "<string>",
"payload": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "received",
"amount": 123,
"transactionId": "<string>",
"currency": "EUR",
"receivedAt": "<any>",
"payer": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
}
},
"payee": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
}
},
"bankStatementReference": "<string>",
"rail": "sepa_instant",
"txHash": "<string>",
"returns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"depositId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "initiated",
"amount": 123,
"currency": "EUR",
"createdAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"succeededAt": "2023-11-07T05:31:56Z"
}
],
"depositId": "<string>",
"value": {
"currency": "<string>",
"amount": "<string>"
}
}
}'A deposit has been received
curl --request POST \
--url https://{yourDomain}/api/service/webhook-event/deposit.received \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"type": "deposit.received",
"date": "<string>",
"payload": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "received",
"amount": 123,
"transactionId": "<string>",
"currency": "EUR",
"receivedAt": "<any>",
"payer": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
}
},
"payee": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
}
},
"bankStatementReference": "<string>",
"rail": "sepa_instant",
"txHash": "<string>",
"returns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"depositId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "initiated",
"amount": 123,
"currency": "EUR",
"createdAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"succeededAt": "2023-11-07T05:31:56Z"
}
],
"depositId": "<string>",
"value": {
"currency": "<string>",
"amount": "<string>"
}
}
}'Data of the webhook event
OK
Was this page helpful?