Webhook Notifications
Account notifications
Subscribe to the eWallet/create
webhook to get notifications when an account was created or disabled for one of your vendors. An account will be created via an API call, or automatically, when your vendor receives a payment for the first time.
The body will include the following object:
Parameter | Always Available | Type | Description |
---|---|---|---|
id | Yes | String | Your account ID |
merchantId | Yes | String | Your Merchant ID |
vendorId | No | String | Your Vendor ID |
currency | Yes | Enum | 'GBP', 'USD', 'EUR' |
status | Yes | Enum | 'created' |
Account transactions notifications
Subscribe to the eWalletTransaction/create
webhook to get notifications when an account transaction associated with one of your vendors is created.
The body will include the following object:
Paramater | Always Available | Type | Description |
---|---|---|---|
id | Yes | String | Your account transaction ID |
merchantId | Yes | String | Your Merchant ID |
vendorId | Yes | String | Your Vendor ID |
fees | Yes | Number | The fees taken in this transaction |
amount | Yes | Number | The transaction's total amount |
netAmount | Yes | Number | The transaction's net amount |
pendingAmount | Yes | Number | The amount that was not yet reconciled |
payableAmount | Yes | Number | The amount that is ready to be paid out |
reservedAmount | Yes | Number | The amount that was reserved by UNIPaaS |
payableBalance | Yes | Number | The payable balance at the time of the transaction |
brand | No | String | Name of bank, APM or credit card company. |
currency | Yes | Enum | 'GBP', 'USD', 'EUR' |
reference | Yes | String | The transaction's reference number. This can be used to store order ID |
paymentMethod | Yes | Enum | 'bankTransfer', 'card', 'alternative' |
payoutId | No | String | If the transaction is a payout, it's ID will be here |
ewalletId | Yes | String | The transaction's account ID |
createdAt | Yes | Date | When the transaction occured |
Account transactions - indicate paid out transactions
Use Payout Drill Through to indicate if a specific transaction was paid out to the vendor's bank account.
Updated over 1 year ago