Skip to main content
WEBHOOK
beneficiaryCreated
{
  "version": "V1.6.0",
  "event_name": "BENEFICIARY",
  "event_type": "beneficiary.successful",
  "event_id": "8f41b316-e3fc-44d8-8a42-6420cad2b7d3",
  "source_id": "a5d46cf1-f499-4ab0-a1e3-95c6dd27585b",
  "data": {
    "account_currency_code": "GBP",
    "account_id": "b1b89684-c2c4-4d54-b8a8-3572727fd120",
    "account_number": "GB29NWBK60161331926819",
    "bank_country_code": "GB",
    "beneficiary_address": "{\"country_code\":\"GB\",\"city\":\"London\",\"street_address\":\"10 Downing Street\",\"postal_code\":\"SW1A 2AA\",\"state\":\"England\"}",
    "beneficiary_bank_details": "{\"bank_name\":\"HSBC BANK PLC\",\"bank_address\":\"8 Canada Square, London E14 5HQ\",\"account_holder\":\"Webhook Test\",\"account_number\":\"GB29NWBK60161331926819\",\"account_currency_code\":\"GBP\",\"bank_country_code\":\"GB\",\"iban\":\"GB29NWBK60161331926819\",\"swift_code\":\"HSBCGB2L\",\"clearing_system\":\"SWIFT\",\"routing_code_type1\":\"\",\"routing_code_value1\":\"\",\"routing_code_type2\":\"\",\"routing_code_value2\":\"\"}",
    "beneficiary_company_name": "",
    "beneficiary_email": "webhook-test@example.com",
    "beneficiary_entity_type": "INDIVIDUAL",
    "beneficiary_first_name": "Webhook",
    "beneficiary_id": "a5d46cf1-f499-4ab0-a1e3-95c6dd27585b",
    "beneficiary_last_name": "Test",
    "beneficiary_nickname": "webhook-test-ben",
    "beneficiary_status": "ACTIVE",
    "direct_id": "0",
    "payment_type": "SWIFT",
    "short_reference_id": "BF260413-MKLK2WDS"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Event Types

Event TypeDescription
beneficiary.successfulThe beneficiary was created successfully.
beneficiary.failedThe beneficiary creation failed.

Body

application/json
​
event_id
string<uuid>
required

A unique identifier for this event.

​
event_name
enum<string>
required

Top-level event category.

Available options:
BENEFICIARY
​
event_type
enum<string>
required

The specific event type that occurred.

Available options:
beneficiary.successful,
beneficiary.failed
​
source_id
string
required

Beneficiary ID.

​
version
string
required

API version number.

Example:

"V1.6.0"

​
data
object

Beneficiary details associated with the event.

Response

200

Return 200 to acknowledge receipt.