Skip to main content
POST
https://your.endpoint.to.notify
Callback Payment
curl --request POST \
  --url https://your.endpoint.to.notify/ \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "invoice": "<string>",
  "status": {
    "id": 123,
    "name": "<string>"
  },
  "updated_at": "<string>",
  "status_detail": {
    "code": "<string>",
    "detail": "<string>"
  }
}

​
Callbacks

Receive updates about your payout.

​
Cash-out

Endpoint: POST https://your.endpoint.to.notifyThis is your endpoint where WEpayments will send notifications about payout status changes.

​
Response

You should respond with 200 OK to acknowledge receipt of the webhook.

​
Body

The webhook payload contains the following fields:
​
id
integer
Cash-out IDExample: 2322977
​
invoice
string
Cash-out invoiceExample: 575e8327-f145-48ff-b207-737eef2d6f3f
​
status
object
Object that contains the current status of your payout.
​
updated_at
string
Last update of your payout.Format: <date-time>Example: 2024-09-25 15:55:18
​
status_detail
object
This object will only be returned if the payout is canceled and the merchant is using the “Account Mismatch” functionality. It provides more details on the reason for the cancellation.

​
Webhook Payload Example

{
  "id": 2322977,
  "invoice": "575e8327-f145-48ff-b207-737eef2d6f3f",
  "status": {
    "id": 6,
    "name": "Cancelled"
  },
  "updated_at": "2024-09-25 15:55:18",
  "status_detail": {
    "code": "WE0001",
    "detail": "The payment was made to an unregistered account"
  }
}

​
Status Codes

Common payout status codes:
Status IDStatus NameDescription
1CreatedCash-out has been created
2ProcessingCash-out is being processed
3PaidCash-out has been paid successfully
4FailedCash-out failed
5RejectedCash-out rejected by compliance
6CancelledCash-out was cancelled

​
Best Practices

Always Respond 200 OK: Your endpoint must respond with HTTP 200 to acknowledge receipt. Otherwise, WEpayments will retry sending the webhook.
Validate Webhook Signature: In production, always validate the webhook signature to ensure it’s from WEpayments. See Webhook Signature Documentation for details.
Process Asynchronously: Handle webhook processing asynchronously to respond quickly and avoid timeouts.

Create Payment

Create a payout payment

Webhook Signature

Validate webhook signatures