Buyer Status Webhook

API Overview

Item	Value
API Status	Recommended
Current Version	v2.0
Backward Compatibility	Yes
Applicable Environment	Production
Applicable User Roles	PSP and Direct Client
Type	Webhook (Incoming)

Description
To update buyer status.

This is a webhook endpoint that must be implemented by the recipient to receive these notifications.
Important:

You do not need to call this API; instead, you need to expose a public endpoint matching this specification.

Refer to the Webhook section for details on signature verification, retry policy, and security best practices.

Responses

🟢200Success

application/json

Body

Example

{
    "eventType": "string",
    "notificationId": "string",
    "webhookData": {
        "applicationId": "string",
        "status": 1,
        "buyerData": {
            "buyerId": "string",
            "type": 1,
            "walletType": 1,
            "platformName": "string",
            "platformUsername": "string",
            "customerDetails": {
                "personalDetails": {
                    "firstName": "string",
                    "middleName": "string",
                    "lastName": "string",
                    "identityType": 1,
                    "identityNumber": "string",
                    "dateOfBirth": "2019-08-24",
                    "placeOfBirth": "string",
                    "residentialAddress": {
                        "country": "string",
                        "state": "string",
                        "city": "string",
                        "postcode": "string",
                        "addressLine1": "string",
                        "addressLine2": "string"
                    }
                }
            },
            "clientReference": "string",
            "participantCode": "string"
        },
        "updatedAt": 0
    }
}

Buyer Status Webhook

Request

Request Code Samples

Responses