Appearance
Events
This article lists the Webhooks you may receive when regarding Wallets.
API – See the Wallets API Reference for attributes description
The detailed information of the Wallet attributes are available in the of the Wallets API Reference. Webhooks object_payload is identical to the API object.
Wallet events
wallet.create
Notifies the creation of a Wallet, usually triggered by the /v1/wallets endpoint.
json
{
"webhook": "wallet.create",
"webhook_id": "648614636",
"object": "wallet",
"object_id": "4330619",
"object_payload": {
"wallets": [
{
"walletId": "4330619",
"walletTypeId": "9",
"walletStatus": "VALIDATED",
"userId": "3691057",
"jointUserId": "0",
"walletTag": "62090",
"currency": "EUR",
"eventDate": "2021-04-29",
"eventMessage": "",
"eventAlias": "XXXX",
"eventPayinStartDate": "2021-04-22",
"eventPayinEndDate": "0000-00-00",
"contractSigned": "0",
"urlImage": "",
"createdDate": "2021-04-22 14:54:14",
"modifiedDate": "0000-00-00 00:00:00",
"tariffId": "59",
"eventName": "XXXX",
"userFirstname": "XXXX",
"userLastname": "XXXX",
"codeStatus": "120005",
"informationStatus": "",
"payinCount": "0",
"payoutCount": "0",
"transferCount": "0",
"solde": null,
"authorizedBalance": null,
"bic": "TRZOFR21XXX",
"iban": "XXXX",
"totalRows": 1
}
]
},
"object_payload_signature": "eYIDFtDa3Ai9T+0vRgIFwU0oDYZ2WkcILLRDOBWLAY8="
}wallet.update
Notifies the modification of a Wallet, usually triggered by the /v1/wallets/{walletId} endpoint.
json
{
"webhook": "wallet.update",
"webhook_id": "644808221",
"object": "wallet",
"object_id": "3858134",
"object_payload": {
"wallets": [
{
"walletId": "3858134",
"walletTypeId": "9",
"walletStatus": "VALIDATED",
"userId": "3384099",
"jointUserId": "0",
"walletTag": "",
"currency": "EUR",
"eventDate": "2021-03-02",
"eventMessage": "",
"eventAlias": "XXXX",
"eventPayinStartDate": "2021-02-23",
"eventPayinEndDate": "0000-00-00",
"contractSigned": "0",
"urlImage": "",
"createdDate": "2021-02-23 02:05:24",
"modifiedDate": "2021-04-19 19:16:46",
"tariffId": "25",
"eventName": "XXXX",
"userFirstname": "XXXX",
"userLastname": "SAS",
"codeStatus": "120005",
"informationStatus": "",
"payinCount": "0",
"payoutCount": "0",
"transferCount": "0",
"solde": "0.00",
"authorizedBalance": "0.00",
"bic": "TRZOFR21XXX",
"iban": "XXXX"
}
]
},
"object_payload_signature": "h+0FXlKloXIrFHpY\/PMMIoIQbUBTp5W1HlXZnqCNHx4="
}wallet.cancel
Notifies the deletion of a Wallet, usually triggered by the /v1/wallets/{walletId} endpoint.
json
{
"webhook": "wallet.cancel",
"webhook_id": "21419123",
"object": "wallet",
"object_id": "860377",
"object_payload": {
"wallets": [
{
"walletId": "860377",
"walletTypeId": "10",
"walletStatus": "CANCELED",
"userId": "1622006",
"jointUserId": "0",
"walletTag": "",
"currency": "EUR",
"eventDate": "2021-04-29",
"eventMessage": "",
"eventAlias": "XXXX",
"eventPayinStartDate": "2021-04-22",
"eventPayinEndDate": "0000-00-00",
"contractSigned": "0",
"urlImage": "",
"createdDate": "2021-04-22 14:55:33",
"modifiedDate": "2021-04-22 14:55:33",
"tariffId": "83",
"eventName": "XXXX",
"userFirstname": "",
"userLastname": "",
"codeStatus": "120003",
"informationStatus": "",
"payinCount": "0",
"payoutCount": "0",
"transferCount": "0",
"solde": "0.00",
"authorizedBalance": "0.00",
"bic": "TRZOFR21XXX",
"iban": "XXXX"
}
]
},
"object_payload_signature": "UhRUkiWyKTptpF\/mbeiN20+XRBM2igEXM8JoUSrQZMs="
}Balance events
balance.updateis sent to you any time the balance of a Wallet changes
balance.update
json
{
"webhook": "balance.update",
"webhook_id": "382069610",
"object": "balance",
"object_id": "2xxxxx7",
"object_payload": {
"balances": [
{
"walletId": "2xxxxx7",
"currentBalance": "4819188.18", // updated Current Balance
"authorizations": "407973.44",
"authorizedBalance": "4411214.74", // updated Authorized Balance
"currency": "EUR",
"calculationDate": "2020-07-03 11:14:38"
}
]
},
"object_payload_signature": "Rd8sLKMet9oPVYiEMLR5p5idGcOTBLhbZ7xnKvTOr3o="
}Transaction events
The Transaction object can be created by the initiation of all type of payments. More examples are available in the Transfer events article.
transaction.create
json
{
"messageId": "3aab4601-xxxx-xxxx-xxxx-199f0d1379e0",
"webhookId": "aace45a4-xxxx-xxxx-xxxx-6c00c3213e2d",
"webhook": {
"webhook": "transaction.create",
"object": "transaction",
"object_id": "858804036",
"object_payload": {
"transactions": [
{
"transactionId": "12345",
"walletDebitId": "654321",
"walletCreditId": "9",
"transactionType": "Payout",
"foreignId": "098765",
"name": "name",
"description": "Virement 19673327",
"valueDate": "2024-11-01",
"executionDate": "2024-11-01",
"amount": "10.69",
"walletDebitBalance": "0.00",
"walletCreditBalance": "0.00",
"currency": "EUR",
"createdDate": "2024-11-01 12:29:31"
}
]
},
"webhook_created_at": 17304605712375,
"webhook_id": "aace45a4-xxxx-xxxx-xxxx-6c00c3213e2d",
"object_payload_signature": "IV15tQ5GG6FyMRF5tgNbt0Lsssss0eV+1YCu+u3TZv08="
},
"clientId": "12345"
}