Webhooks

A webhook is an automatic notification that we can send directly to your system after an event takes place against your account. Rather than requiring you to pull information via our API, webhook notifications will push information directly to a URL that is specified by you via HTTPS POST.

The solution allows you, rather than sending API requests, to update your internal systems automatically, resulting in increased automation and enhanced efficiency.

For more more information on how to configure and use our webhook solution, please see here

Transaction Update Webhooks (Banking Services / Faster Payments)

Name Event Use Case
Transaction Outcome Response transaction_outcome Whenever a faster payments/banking transaction is processed using the Acquired.com platform we will send you a notification.
Transaction Update Alert transaction_update Whenever a faster payments/banking transaction is updated using the Acquired.com platform we will send you a notification.
FUnds Received Alert funds_received Whenever any funds are received by one of your Acquired.com bank accounts, we will send you a notification.
For the parameters and sample code for these webhooks, please see here.

Sample Webhooks

Please see webhook example parameters below and an exmaple of the webhook alongside.

Transaction Outcome Response

Parameter Format Length Description
id string 36 The unique reference for the webhook.
timestamp date 14 Date and time of transaction submission.
company_id int 1-11 API Company ID we issue to merchants.
hash string 64 Verification hash value.
event string 36 The event for which the webhook is being triggered.
response_code int 3 Code describing the transaction result.>
response_message string 1-100 Text describing the transaction response.
transaction_type string 1-12 Transaction type, repeated from the request message.
mid_id int 1-11 MID_ID the transaction was processed through.
transaction_id int 1-10 Unique ID we generate to identify the transaction.
Acceptable Characters: 0-9
{
"id": "1873E97B-460D-92F8-49F2-650B32C60E27",
"timestamp": "20200626044442",
"company_id": "111",
"hash": "072d418db4646d9d14a88eeac78377a59c23a3bc6e63d24db1e6a01bbaf53a2f",
"event": "transaction_outcome",
"response_code": 1,
"response_message": "Transaction Success",
"transaction_type": "pay_out",
"mid_id": "1111",
"transaction_id": "40621111"
}

Transaction Update Alert

Parameter Format Length Description
id string 36 The unique reference for the webhook.
timestamp date 14 Date and time of transaction submission.
company_id int 1-11 API Company ID we issue to merchants.
hash string 64 Verification hash value.
event string 36 The event for which the webhook is being triggered.
transaction_id int 1-10 Unique ID we generate to identify the transaction.
transaction_type string 1-12 Transaction type, repeated from the request message.
response_code int 1-3 Transaction result code.
rejection_reasons list
{
    "id":"fea514d1-272d-4fed-bad3-0f4e19e88918",
    "timestamp":"15012018180000",
    "company_id":"202",
    "hash":"A7C96262C21DB9A06FD49E307D694FD95F624569F9B35BB3FFACD880440F9787",
    "event":"transaction_update",
    "transaction_id":"28090303",
    "transaction_type":"pay_out",
    "response_code":"652",
    "response_message":"Rejected",
    "rejection_reasons":[
       "beneficiary-sort-code-and-account-number-unknown"
    ]
 }

Funds Recieved Alert

Parameter Format Length Description
id string 36 The unique reference for the webhook.
timestamp date 14 Date and time of transaction submission.
company_id int 1-11 API Company ID we issue to merchants.
hash string 64 Verification hash value.
event string 36 The event for which the webhook is being triggered.
response_code int 1-3 Transaction result code.
response_message string 1-100 Text describing the transaction response.
type string 1-100 Text describing the payment type.
amount string 1-11 Transaction amount.
currency string 3 Transaction currency, an ISO 4217 3-digit code.
ledger_details object
account_name string 1-50 The name on the account which is displayed within the Hub to differentiate accounts.
ledger_id string 36 The unique reference for the ledger which will be used for future requests, you should take note of it.
sort_code string 6 Returned for GBP accounts, value that you can share with your customers to recieve payments.
account_number string 8 Returned for GBP accounts, value that you can share with your customers to recieve payments.
iban string 16-34 Returned for EUR accounts, value that you can share with your customers to recieve payments.
bic_swift string 8-11 Returned for EUR accounts, value that you can share with your customers to recieve payments.
merchant_customer_id string 1-50 Your internal unique customer reference. You can use this field to link multiple transactions to a single customer.
merchant_custom_1 string0-50 You can send additional data relating to the customer or another internal reference - with more data, your internal teams will be able to identify the customer’s transactions.
Acceptable Characters: a-z A-Z 0-9 , . - _
merchant_custom_2 string0-50 You can send additional data relating to the customer or another internal reference - with more data, your internal teams will be able to identify the customer’s transactions.
Acceptable Characters: a-z A-Z 0-9 , . - _
merchant_custom_3 string0-50 You can send additional data relating to the customer or another internal reference - with more data, your internal teams will be able to identify the customer’s transactions.
Acceptable Characters: a-z A-Z 0-9 , . - _
balance int 1-11 The current balance on this ledger at the time of the request in the currency returned.
sender_details object
account_name string 1-50 The name on the persons account that has sent the funds.
account_number string 8 Returned for GBP payments, the account number on the persons account that has sent the funds.
sort_code string 6 Returned for GBP payments, the sort code on the persons account that has sent the funds.
iban string 16-34 Returned for EUR accounts, the iban on the persons account that has sent the funds.
bic_swift string 8-11 Returned for EUR accounts, the bic or swift code on the persons account that has sent the funds.
reference string 1-18 A description of the payment that will apear on the senders and recievers bank statements
{
    "id":"476A672D-21DF-2BC9-8EBB-5EDB7E65D132",
    "timestamp":"20200810030716",
    "company_id":"202",
    "hash":"0195813eaf8dc73e54f8463017df6243a8bd414dc92aef1583c2a1ce99f461c8",
    "event":"funds_received",
    "response_code":1,
    "response message":"Transaction Success",
    "type":"faster_payments",
    "amount":"130.52",
    "currency":"GBP",
    "ledger_details":{
       "account_name":"Account Name",
       "ledger_id":"55938286-283a-4594-b21c-afb1bd52d22c",
       "sort_code":"040052",
       "account_number":"00459615",
       "iban":"GB22PAYR04005200459615",
       "bic_swift":"PAYRGB20XXX",
       "merchant_customer_id":"a customer id",
       "merchant_custom_1":"some info",
       "merchant_custom_2":"some info",
       "merchant_custom_3":"some info",
       "balance":"130.52"
    },
    "sender_details":{
       "account_name":"Account Name",
       "account_number":"12345678",
       "sort_code":"123456",
       "iban":"GB29NWBK60161331926819",
       "bic":"REVOGB21",
       "reference":"#123456"
    }
 }