Skip to content

Events

This article lists the Webhooks you may receive when using the Acquiring feature.

For the legacy flow, the reception of any payin webhook meant that a payment had been accepted. This is no longer the case for the newest version. Please refer to the payinStatus attribute of the payin. The payment is accepted when valued to VALIDATED.

Webhooks flow chart

TopupCard

topupCard.validate

json
{
   "webhook":"topupCard.validate",
   "webhook_created_at":16867326126402,
   "object_id":"61e46d74-54db-4170-968f-28c307ba255c",
   "object":"topupCard",
   "object_payload":{
      "topupCards":[
         {
            "topupCardId":"61e46d74-54db-4170-968f-28c307ba255c",
            "userId":"1656177",
            "profile":"00001340585",
            "token":"4d2e3ce0aa972bb3726fa609b648535c803d725dccf3d8cbe738762f84281d3e",
            "brand":"MASTERCARD",
            "maskedPan":"545454xxxxxx5454",
            "cardHolder":"Tom Pes",
            "cardExpiryMonth":"12",
            "cardExpiryYear":"2025",
            "issuer":"CENTRAL TRUST BANK, THE",
            "country":"US",
            "domesticNetwork":null,
            "cardType":"CREDIT",
            "status":"VALIDATED",
            "createdDate":"2023-06-14 10:50:08",
            "updatedDate":"2023-06-14 10:50:08"
         }
      ]
   },
   "webhook_id":"185cf5c2-766d-4168-8848-6bd754083ef4",
   "object_payload_signature":"CktrgqtW2rknbedybQ3VIDTxygjZRE3zrY6dR\/g3YpE=",
   "auth_key":"true"
}

topupCard.cancel

json
{
   "webhook":"topupCard.cancel",
   "webhook_created_at":16867326507819,
   "object_id":"61e46d74-54db-4170-968f-28c307ba255c",
   "object":"topupCard",
   "object_payload":{
      "topupCards":[
         {
            "topupCardId":"61e46d74-54db-4170-968f-28c307ba255c",
            "userId":"1656177",
            "profile":"00001340585",
            "token":"4d2e3ce0aa972bb3726fa609b648535c803d725dccf3d8cbe738762f84281d3e",
            "brand":"MASTERCARD",
            "maskedPan":"545454xxxxxx5454",
            "cardHolder":"Tom Pes",
            "cardExpiryMonth":"12",
            "cardExpiryYear":"2025",
            "issuer":"CENTRAL TRUST BANK, THE",
            "country":"US",
            "domesticNetwork":null,
            "cardType":"CREDIT",
            "status":"CANCELED",
            "createdDate":"2023-06-14 10:50:08",
            "updatedDate":"2023-06-14 10:50:50"
         }
      ]
   },
   "webhook_id":"c69a1148-ea41-479c-a33d-af0df5e95f72",
   "object_payload_signature":"fn\/rOnp3\/YWJFodXHIRUzMmKmT82ohYIqapwcRG5VvI=",
   "auth_key":"true"
}

Authorization

authorization.create

json
{
	"webhook":"authorization.create",
	"webhook_created_at":16867327260694,
	"object_id":"7ec56e11-02fe-5f53-a7e9-d8403e95bbe5",
	"object":"authorization",
	"object_payload":{
		"authorizations":[
			{
				"authorizationId":"7ec56e11-02fe-5f53-a7e9-d8403e95bbe5",
				"walletId":"878744",
				"userId":"1656177",
				"authorizationStatus":"PENDING",
				"messageToUser":"The financial institution has approved the payment.",
				"amount":"100.00",
				"currency":"EUR",
				"createdDate":"2023-06-14 10:51:56",
				"walletEventName":"Hondwallet",
				"walletAlias":"Hondwallet-620e13cb0760f",
				"userFirstname":"John",
				"userLastname":"Doe",
				"codeStatus":"150116",
				"informationStatus":"Authorized",
				"payinDate":"0000-00-00 00:00:00",
				"additionalData":"{\"card\":{\"externalProvider\":{\"transactionReference\":\"800240081686\"}}}"
			}
		]
	},
	"webhook_id":"65ad7aad-2c72-4abd-920d-e73107afcf78",
	"object_payload_signature":"d6u1VgSn+hWZHpb4Z2nfbwm3\/RtyAVdsyS3CTD0+Qc8=",
	"auth_key":"true"
}

authorization.update

json
{
	"webhook":"authorization.update",
	"webhook_created_at":16867328446792,
	"object_id":"7ec56e11-02fe-5f53-a7e9-d8403e95bbe5",
	"object":"authorization",
	"object_payload":{
		"authorizations":[
			{
				"authorizationId":"7ec56e11-02fe-5f53-a7e9-d8403e95bbe5",
				"walletId":"878744",
				"userId":"1656177",
				"authorizationStatus":"PENDING",
				"messageToUser":"Authorization cancellation requested.",
				"amount":"100.00",
				"currency":"EUR",
				"createdDate":"2023-06-14 10:51:56",
				"walletEventName":"Hondwallet",
				"walletAlias":"Hondwallet-620e13cb0760f",
				"userFirstname":"John",
				"userLastname":"Doe",
				"codeStatus":"150175",
				"informationStatus":"Authorization Cancellation Requested",
				"payinDate":"0000-00-00 00:00:00",
				"additionalData":"{\"card\":{\"externalProvider\":{\"transactionReference\":\"800240081686\"}}}"
			}
		]
	},
	"webhook_id":"c9e92612-6780-4fb0-871e-137158a870a3",
	"object_payload_signature":"wa9DCqC1wj0XKBmexQSmwlu1lZbi8Vvl+t277sxDTGs=",
	"auth_key":"true"
}

authorization.cancel

json
{
	"webhook":"authorization.cancel",
	"webhook_created_at":16867328881913,
	"object_id":"7ec56e11-02fe-5f53-a7e9-d8403e95bbe5",
	"object":"authorization",
	"object_payload":{
		"authorizations":[
			{
				"authorizationId":"7ec56e11-02fe-5f53-a7e9-d8403e95bbe5",
				"walletId":"878744",
				"userId":"1656177",
				"authorizationStatus":"CANCELED",
				"messageToUser":"Merchant cancelled the payment attempt.",
				"amount":"100.00",
				"currency":"EUR",
				"createdDate":"2023-06-14 10:51:56",
				"walletEventName":"Hondwallet",
				"walletAlias":"Hondwallet-620e13cb0760f",
				"userFirstname":"John",
				"userLastname":"Doe",
				"codeStatus":"150115",
				"informationStatus":"Canceled",
				"payinDate":"0000-00-00 00:00:00",
				"additionalData":"{\"card\":{\"externalProvider\":{\"transactionReference\":\"800240081686\"}}}"
			}
		]
	},
	"webhook_id":"40ca0506-00c8-469f-b5c1-d0016bcc277f",
	"object_payload_signature":"\/h8+\/ekdSsDHYSsmyJaQmP75XJT8Il7wOJ5PutVqmeY=",
	"auth_key":"true"
}

Payin

payin.create

json
{
	"webhook": "payin.create",
	"webhook_id": "20830333",
	"object": "payin",
	"object_id": "707206",
	"object_payload": {
	"payins": [
		{
		"payinId": "707206",
		"payinTag": "",
		"walletId": "821042",
		"userId": "1534949",
		"payinStatus": "PENDING",
		"paymentMethodId": "25",
		"messageToUser": "",
		"subtotalItems": "0.00",
		"subtotalServices": "0.00",
		"subtotalTax": "0.00",
		"amount": "11.26",
		"currency": "EUR",
		"createdDate": "2021-04-12 16:10:04",
		"walletEventName": "testwallet",
		"walletAlias": "testwallet-603d03f45b0d0",
		"userFirstname": "",
		"userLastname": "v.11test",
		"codeStatus": "140001",
		"informationStatus": "",
		"refundAmount": null,
		"DbtrIBAN": null,
		"forwardUrl": null,
		"paymentAcceptedUrl": null,
		"paymentRefusedUrl": null,
		"paymentWaitingUrl": null,
		"paymentExceptionUrl": null,
		"paymentCanceledUrl": null,
		"payinDate": "0000-00-00",
		"mandateId": "0",
		"creditorName": null,
		"creditorAddressLine": null,
		"creditorCountry": null,
		"creditorIban": null,
		"creditorBIC": null,
		"virtualIbanId": null,
		"virtualIbanReference": null,
		"additionalData": "{\"card\":{\"externalProvider\":{\"transactionReference\":\"800098404275\"}}}",
		"paymentHtml": null
		}
	]
	},
	"object_payload_signature": "EKKzlaFHfnZWiGLDn1ZY90fVAGCqLHmlY9uH5Tmwx6s="
}

payin.update

json
{
	"webhook": "payin.update",
	"webhook_id": "20830341",
	"object": "payin",
	"object_id": "707206",
	"object_payload": {
	"payins": [
		{
		"payinId": "707206",
		"payinTag": "",
		"walletId": "821042",
		"userId": "1534949",
		"payinStatus": "PENDING",
		"paymentMethodId": "25",
		"messageToUser": "",
		"subtotalItems": "0.00",
		"subtotalServices": "0.00",
		"subtotalTax": "0.00",
		"amount": "11.26",
		"currency": "EUR",
		"createdDate": "2021-04-12 16:10:04",
		"walletEventName": "testwallet",
		"walletAlias": "testwallet-603d03f45b0d0",
		"userFirstname": "",
		"userLastname": "v.11test",
		"codeStatus": "150116",
		"informationStatus": "The financial institution has approved the payment.In the case of a credit card payment, funds are “held” and deducted from the customer’s credit limit (or bank balance, in the case of a debit card), but are not yet transferred to the merchant. In the cas",
		"refundAmount": null,
		"DbtrIBAN": null,
		"forwardUrl": null,
		"paymentAcceptedUrl": null,
		"paymentRefusedUrl": null,
		"paymentWaitingUrl": null,
		"paymentExceptionUrl": null,
		"paymentCanceledUrl": null,
		"payinDate": "0000-00-00",
		"mandateId": "0",
		"creditorName": null,
		"creditorAddressLine": null,
		"creditorCountry": null,
		"creditorIban": null,
		"creditorBIC": null,
		"virtualIbanId": null,
		"virtualIbanReference": null,
		"additionalData": "{\"card\":{\"externalProvider\":{\"transactionReference\":\"800098404275\"}}}"
		}
	]
	},
	"object_payload_signature": "KB9SRCCQssEtSgphZWk3ozY89Qo1jlr1ayOMp+GMKf8="
}

payin.cancel

json
{
	"webhook":"payin.cancel",
	"object_id":"248c79b7-fc5e-5c32-96b3-c434fd0d2639",
	"object":"payin",
	"object_payload":
	{"payins":
		[{"payinId":"248c79b7-fc5e-5c32-96b3-c434fd0d2639",
		"payinTag":"",
		"walletId":"878744",
		"userId":"1656177",
		"payinStatus":"CANCELED",
		"paymentMethodId":25,
		"messageToUser":"",
		"subtotalItems":"0.00",
		"subtotalServices":"0.00",
		"subtotalTax":"0.00",
		"amount":"20",
		"currency":"EUR",
		"createdDate":"2021-09-17T09:32:49+00:00",
		"walletEventName":"Wallet",
		"walletAlias":"alias",
		"userFirstname":"Louis",
		"userLastname":"Pinsard",
		"codeStatus":"150113",
		"informationStatus":"The financial institution refused to authorize the payment.",
		"refundAmount":null,
		"ibanId":null,
		"ibanFullname":null,
		"DbtrIBAN":null,
		"ibanBic":null,
		"ibanTxEndToEndId":null,
		"ibanTxId":null,
		"forwardUrl":null,
		"paymentAcceptedUrl":null,
		"paymentRefusedUrl":null,
		"paymentWaitingUrl":null,
		"paymentExceptionUrl":null,
		"paymentCanceledUrl":null,
		"payinDate":"2021-09-17T11:32:49+02:00",
		"mandateId":"0","creditorName":null,
		"creditorAddressLine":null,
		"creditorCountry":null,
		"creditorIban":null,
		"creditorBIC":null,
		"virtualIbanId":null,
		"virtualIbanReference":null,
		"additionalData":
		{"card":
			{"externalProvider":
				{"transaction_reference":"mock_385371f00f004d42"}}}}]},
	"webhook_id":"d6d58cd7-46d6-4159-bab6-48cae27a1a6a",
	"object_payload_signature":"Ze1KRBH5EzV+56h9LCq048ECU3WiXiIPxrFJDgPBWA0=",
	"auth_key":"true"
}

PayinRefund

payinrefund.create

json
{
   "webhook":"payinrefund.create",
   "webhook_created_at":16426047629673,
   "object_id":"b457966e-6cf9-5d1d-8483-45425cfc8101",
   "object":"payinrefund",
   "object_payload":{
      "payinrefunds":[
         {
            "payinrefundId":"b457966e-6cf9-5d1d-8483-45425cfc8101",
            "payinrefundTag":null,
            "payinrefundStatus":"PENDING",
            "payinrefundDate":"2022-01-19 16:06:01",
            "walletId":"971021",
            "payinId":"29b4e8a8-0abc-5a24-8405-808c5eb34835",
            "amount":"5",
            "currency":"EUR",
            "createdDate":"2022-01-19 16:04:11",
            "modifiedDate":"2022-01-19 16:06:00",
            "userId":"1778843",
            "codeStatus":"150124",
            "informationStatus":"A refund request has been sent to the financial institution.",
            "reasonTms":null
         }
      ]
   },
   "webhook_id":"935260ff-dd91-466c-9148-f27364db0857",
   "object_payload_signature":"oFj6BWt8N4dSU7j6lamfBJoxqS0l1AczQzbRvyBwTY4=",
   "auth_key":"true"
}

payinrefund.update

json
{
	"webhook":"payinrefund.update",
	"webhook_created_at":16426049523256,
	"object_id":"b457966e-6cf9-5d1d-8483-45425cfc8101",
	"object":"payinrefund",
	"object_payload":{
		"payinrefunds":[
			{
				"payinrefundId":"b457966e-6cf9-5d1d-8483-45425cfc8101",
				"payinrefundTag":null,
				"payinrefundStatus":"VALIDATED",
				"payinrefundDate":"2022-01-19 16:09:09",
				"walletId":"971021",
				"payinId":"29b4e8a8-0abc-5a24-8405-808c5eb34835",
				"amount":"5",
				"currency":"EUR",
				"createdDate":"2022-01-19 16:04:11",
				"modifiedDate":"2022-01-19 16:09:07",
				"userId":"1778843",
				"codeStatus":"150126",
				"informationStatus":"The payment was partially refunded.",
				"reasonTms":null
			}
		]
	},
	"webhook_id":"e81865f8-4258-488c-b960-28035fa5c665",
	"object_payload_signature":"76H1+eZsgCU\/2VrhUOES0CgFQARZPRCXX6b\/NCv2sAg=",
	"auth_key":"true"
}

payinrefund.cancel

json
{
   "webhook":"payinrefund.cancel",
   "webhook_id":"701629730",
   "object":"payinrefund",
   "object_id":"7dd5d61b-22db-404f-9899-d473109a6aad",
   "object_payload":{
      "payinrefunds":[
         {
            "payinrefundId":"7dd5d61b-22db-404f-9899-d473109a6aad",
            "payinrefundTag":null,
            "payinrefundStatus":"CANCELED",
            "walletId":"366026",
            "payinId":"6455658",
            "payinrefundDate":"0000-00-00",
            "amount":"921.00",
            "currency":"EUR",
            "createdDate":"2021-05-10 09:20:07",
            "modifiedDate":"2021-06-01 11:30:11",
            "codeStatus":"170003",
            "informationStatus":"",
            "reasonTms":null
         }
      ]
   },
   "object_payload_signature":"pdbm9lmV2Q5ggl4EAugoT4\/HWGScmS6umv251CsBn0A="
}

Chargeback

card.acquiring.chargeback.create

json
{
	"webhook":"card.acquiring.chargeback.create",
	"object_id":"0b1787dc-02f6-5c6f-a559-cb033d6890a0",
	"object":"card.acquiring",
	"object_payload":{
		"chargebacks":[
			{
			"userId":"1656177",
			"walletId":"878744",
			"payinId":"be17c043-9287-50b2-8fb2-188546dfc72a",
			"transactionReference":"10",
			"payinrefundId":"0b1787dc-02f6-5c6f-a559-cb033d6890a0",
			"payinMethodId":25,
			"paymentBrand":"mastercard",
			"currency":"EUR",
			"amount":"20",
			"country":"CA",
			"isRefunded":false,
			"chargebackReason":"",
			"payinCreatedDate":"2021-08-10 15:33:50",
			"chargebackCreatedDate":"2021-08-16 11:38:45",
			"payinRefundCreatedDate":null
			}
		]
	},
	"webhook_id":"48902d9b-bb04-4698-ae26-46ba6fb6233c",
	"object_payload_signature":"HDkynjtisOCPOcHeD8t7Kz6Le+UBBEvjmrBJTBGPESU=",
	"auth_key":"true"
}