This article describes how to integrate our payment platform into your website logic via webhooks.
All webhooks are called from the host webhooks.bytex.market. Any webhook call from a different host should be dismissed.
All webhook calls are POST requests.
All webhooks have a header set called EVENT. The value is specified by the individual webhooks.
| Description | Called when a purchase is completely done, meaning the payment has arrived and the license has been created. |
| EVENT header set to | ON_PURCHASE_COMPLETED |
| Sends payload as | JSON Body |
| Example body |
{
"order":{
"identifier":"B409908375",
"timeCreated":"2018-11-17T18:27:14.423335",
"totalPrice":10.000000000000000000000000000,
"payerIdentity":{
"identifier":"K396677386",
"firstName":"Erika",
"lastName":"Mustermann",
"email":"[email protected]",
"isEmailVerified":true,
"countryCode":"DEU"
},
"paymentProviderId":1,
"runtimeLength":-1,
"runtimeOptionCustomIdentifier":"7fbdc628-893c-4499-844c-7a8c7ecaf325",
"productSku":"nd79z8jinqmkmtewfrb5"
},
"license":{
"productSku":"nd79z8jinqmkmtewfrb5",
"issuedTo":"K396677386",
"validFrom":"2018-11-17T18:27:21.21126",
"validUntil":"9999-01-01T00:00:00",
"isPermanent":true,
"keyIdentifier":"6b3d646f-cb20-4fc5-b520-e53227379407",
"isActive":true
}
}
|
| Description | Called when a dispute is opened, a refund is issued, a dispute is closed and a refund is reversed. | ||||||||||
| EVENT header set to | ON_REFUND_UPDATE | ||||||||||
| Sends payload as | JSON Body | ||||||||||
| Example body |
{
"order":{
"identifier":"B966149669",
"timeCreated":"2018-11-17T18:42:27.83143",
"totalPrice":10.000000000000000000000000000,
"payerIdentity":{
"identifier":"K396677386",
"firstName":"Erika",
"lastName":"Mustermann",
"email":"[email protected]",
"isEmailVerified":true,
"countryCode":"DEU"
},
"paymentProviderId":1,
"runtimeLength":-1,
"runtimeOptionCustomIdentifier":"7fbdc628-893c-4499-844c-7a8c7ecaf325",
"productSku":"nd79z8jinqmkmtewfrb5"
},
"license":{
"productSku":"nd79z8jinqmkmtewfrb5",
"issuedTo":"K396677386",
"validFrom":"2018-11-17T18:42:31.806403",
"validUntil":"9999-01-01T00:00:00",
"isPermanent":true,
"keyIdentifier":"4bded513-6f64-418e-8139-f6ebeab825aa",
"isActive":true
},
"updateReasonId":0
}
|
||||||||||
| Additional notes |
The field updateReasonId has a value between 0-3.
|