Webhooks

Receiver Notifications

Receiver webhooks provide notifications for events related to receivers, after a receiver is created notifications relating to the receiver and their KYC progress will be sent to your nominated URL. These webhooks ensure that your system stays updated with any changes to receiver information.

Receiver Webhook Structure Data Type: JSON

The webhook payload is delivered in JSON format, a structured data format commonly used for APIs. Each payload includes:

Variable	Type	Description
event	String	The event will following current progress of this receiver.
receiver_id	String	Unique ID of the updated receiver.
subaccount_id	String	Unique ID of the updated receiver's subaccount.
kyc_status	String	Status of the current KYC progress.
timestamp	Integer	Unix timestamp of the event.

Account Notification Event

Event	Description
receiverKycUpdate	Indicates that the recipient's KYC (Know Your Customer) status has been updated.

Receiver Notification Status

Status	Description
pending	Customer has been sent the request to complete their KYC.
completed	Customer has successfully completed their KYC verification and can now receive payouts.
failed	Customer has failed their KYC verification. If you believe this to be an error please contact your Payswiftly Account Manager.

Example

{
    "event": "receiverKycUpdate",
    "receiver_id": "e4908c83-6656-408a-8ba2-61dae8f039a5",
    "subccount_id": "ccb93d70-00d0-4ec4-a454-32bfc8e8428f",
    "kyc_status": "completed",    
    "timestamp": 1710091428000
}