Skip to main content

Webhooks

Once every payout's tranfer has started/has been completed, the getpaid payouts engine emits a webhook event in order to notify about the state, sending all the relevant data related to the transfer (amount, currency, reference, etc.).

Setting the webhook URL

You specify the payout related webhook URL when initiating a payment, by setting the urls.webhook field:

{
"amount_minor": 1000,
"currency": "EUR",
"reference": "ORD-123456",
"description": "Your Haircutz appointment at Emma Stone Hair Salon",
"payment_method": {...},
"integration": {...},
"routing": {...},
"urls": {
"redirect": "https://haircutz.co/checkout/complete?order_id=ORD-123456",
"webhook": "https://webhooks.haircutz.co/getpaid"
}
}

For more details on the Initiate Payment API call, see Accept Payments.

Webhook Events

tip

For a comprehensive reference on the schema of the payout webhooks, please see our API Reference.

Getpaid payouts engine sends the following webhooks:

Transfer Started

The transfer_started event occurs when the transfer of the funds to entities bank account is initiated.

Example Webhook

{
"id": "evt_4y7rv0p7zqv0f9arfsyr50864t",
"type": "transfer_started",
"occurred_at": "2019-08-24T14:15:22Z",
"data": {
"transfer_id": "tra_1a6po0p7zqv1q2arfsyr9548q",
"payment_id": "pay_473cr1y0ghbyc3m1yfbwvn3nxx",
"account_id": "acc_985qw1q0oiuyh4m1lkoima9lqz",
"transfer_id": "tra_1a6po0p7zqv1q2arfsyr9548q",
"amount_minor": 1000,
"currency": "EUR",
"reference": "ORD-123456"
}
}

Transfer Completed

The transfer_completed event occurs when the transfer of the funds to the creditor's bank account has been completed.

Example Webhook

{
"id": "evt_4y7rv0p7zqv0f9arfsyr50864t",
"type": "transfer_completed",
"occurred_at": "2019-08-24T14:15:22Z",
"data": {
"transfer_id": "tra_1a6po0p7zqv1q2arfsyr9548q",
"payment_id": "pay_473cr1y0ghbyc3m1yfbwvn3nxx",
"account_id": "acc_985qw1q0oiuyh4m1lkoima9lqz",
"transfer_id": "tra_1a6po0p7zqv1q2arfsyr9548q",
"amount_minor": 1000,
"currency": "EUR",
"reference": "ORD-123456"
}
}