Webhooks

Webhooks notify your platform when customer, rail, and transfer states change asynchronously. Use them to update internal state without polling every object. Use the API reference for configuration details.

Verified Event Families

Event	When it fires
`customer.verification_changed`	KYC or KYB moves to an approved or rejected state.
`customer.rail.status_changed`	A customer rail changes status.
`customer.rail.documents_requested`	Compliance requests more documents for a rail.
`transfer.created`	A transfer is created by a pay-in, payout, or transfer flow.
`transfer.updated`	A transfer changes to a non-terminal state.
`transfer.completed`	A transfer reaches completed.
`transfer.failed`	A transfer reaches failed.
`transfer.amount_adjusted`	The booked amount differs from the expected amount.

Swipelux does not emit transfer.funded_partial, transfer.offramp.requested, or account.deleted today. Treat any visibility in metadata or provider tooling as non-contractual unless Swipelux adds the event to this public event list.

Delivery Shape

{
  "type": "transfer.completed",
  "data": {
    "id": "tr_xxx",
    "onBehalfOf": "cus_xxx",
    "state": "completed"
  },
  "createdAt": 1704067200000
}

createdAt is a Unix timestamp in milliseconds.

API Reference

Operation	Use it for
`GET /v1/webhooks`	Retrieve webhook configuration.
`PATCH /v1/webhooks`	Configure webhook delivery.

Verified Event Families

Delivery Shape

API Reference

On this page