Skip to main content
POST
/
api
/
service
/
webhook-event
/
payout.paid
payout.paid
curl --request POST \
  --url https://{yourDomain}/api/service/webhook-event/payout.paid \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "date": "<string>",
  "payload": {
    "id": "<string>",
    "destination": {},
    "amount": 123,
    "createdAt": "<unknown>",
    "updatedAt": "<unknown>",
    "metadata": {},
    "paymentReference": "<string>",
    "transactionId": "<string>"
  }
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

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

Body

application/json

Data of the webhook event

​
id
string
required

The unique id for the webhook.

​
type
enum<string>
required
Available options:
payout.paid
​
date
string
required

The date of the webhook.

​
payload
object
required

The successfully paid user payout data.

Response

200

OK