Webhhoks

Introduction

Once the status of the transaction you created has been changed to one of the final statuses, xBillion can send you a webhook notification that you can use to build business logic on the merchant side.

Activating the sending of webhook notifications is very simple, just specify the webhook URL to which the notifications will be sent in your merchant settings in the xBillion dashboard.

To specify the webhook URL, go to "Merchant Settings" under the "General" tab and specify the webhook URL here.
Note that you can configure different webhook URLs for different transaction types.

Important:

If no webhook url is specified, no notifications will be sent for this transaction type.

If the merchant's system failed to process the request from the service when sending the webhook notification, i.e. returned an HTTP status other than 200, then the system will repeat the request again at intervals of every 3 minutes for 10 hours.

To authenticate webhook requests, basic authorization is used similar to the one described in section "Authentication".

Webhook request

Fields description

Field name	Description
id	Transaction ID on the billing side
external_id	Transaction ID on the merchant side, if passed when creating the transaction
type	Transaction type, the following values are possible: payin
in_amount	Contains the amount and currency of the transaction when the transaction is created. A description of the object is given below, see "Amount object fields description"
out_amount	Contains the amount and currency of the transaction when paying on the side of the payment system. A description of the object is given below, see "Amount object fields description"
settlement_amount	Contains the amount and currency of the transaction in the currency of the settlement with the merchant. A description of the object is given below, see "Amount object fields description"
fee	Contains information about the transaction fee. A description of the object is given below, see "Fees object fields description"
service	ID of the service through which the transaction was performed
status	Transaction status, possible values: completed, rejected
reject_reason	Description of the reason for rejecting the transaction, it is transmitted only in case of rejected status transmission
created_at	Date of transaction creation in RFC 3339 format
updated_at	Date of last transaction update in RFC 3339 format

Amount object fields description

Field name	Description
amount	Transaction amount
currency	Transaction currency

Fees object fields description

Field name	Description
fee	Amount of charged fees
currency	Currency of charged fees
fee_payer	From whom the fees are charged. Possible values: merchant, customer

Introduction#

Webhook request#

Fields description#

Amount object fields description#

Fees object fields description#

Webhook request example:#

Introduction

Webhook request

Fields description

Amount object fields description

Fees object fields description

Webhook request example: