payout.accepted

Sent when a payout is accepted and is being sent. Answer with any 2xx within 10 seconds. Anything else, a timeout or a redirect is retried up to 6 times over about a day. Events can arrive out of order, so compare statuses rather than trusting arrival order.

POSTpayout.acceptedWebhook

Header parameters

Webhook-Idstringrequired

The event id. The same event can arrive more than once; use this to ignore repeats.

Webhook-Timestampstringrequired

Unix seconds when this attempt was signed. Reject a delivery older than 5 minutes.

Webhook-Signaturestringrequired

v1, then a comma, then the base64 HMAC-SHA256 of "{Webhook-Id}.{Webhook-Timestamp}.{raw body}" keyed with your endpoint's signing secret. Compare in constant time.

Request body

requiredapplication/json

idstringrequired

The event id, the same as the Webhook-Id header.

typestringrequired

createdAtstring<date-time>required

When the change happened.

dataPayoutrequired

The payout as it stood when the event was sent. Fields the event did not carry are left out, so fetch the payout by reference when you need the full record.

Show properties

referencestringrequired

The reference you chose.

amountstring

The requested amount. A decimal string in major units.

currencystring

Three-letter currency code.

matches ^[A-Z]{3}$

statusstringrequired

Where the request stands, reported as it is: accepted, dispatching, in_review, held, delivered, failed or refunded. Others can appear, so do not treat this list as closed.

providerstring

The provider used.

feestring

The fee charged. Left out when none was recorded. A decimal string in major units.

feeBearerstring

Who pays the fee. initiator: the party who starts the request pays the amount plus the fee, and the recipient gets the full amount. non_initiator: the fee comes out of what the recipient gets.

Allowed:initiatornon_initiator

payerAmountstring

What the payer is charged. Left out when the fee bearer is not known. A decimal string in major units.

recipientAmountstring

What the recipient receives. Left out when the fee bearer is not known. A decimal string in major units.

notestring

The note you sent.

failureReasonstring

The provider's own reason when the request failed. Left out otherwise.

createdAtstring<date-time>

completedAtstring<date-time>

When it reached its final status. Left out while it is still moving, and on older movements where the time was not recorded.

channelstring

How it was started. api is the only value today.

Allowed:api

reconciliationReconciliation

What the platform's check against the provider concluded.

Show properties

statusstringrequired

unchecked (not checked yet), matched (the provider agrees) or mismatched (the provider disagrees; the platform is looking into it).

Allowed:uncheckedmatchedmismatched

checkedAtstring<date-time>

When it was last checked. Left out until it has been.

parentLineageLink

The movement this one undoes, when it is a reversal. Left out otherwise.

Show properties

typestringrequired

What kind of movement it is.

Allowed:collectionpayoutwallet_transfer

referencestringrequired

Its reference.

compensationLineageLink

The reversal recorded against this movement. Left out when there is none.

Show properties

typestringrequired

What kind of movement it is.

Allowed:collectionpayoutwallet_transfer

referencestringrequired

Its reference.

Responses

2XX

Received. Any 2xx stops retries.

Payload

{
  "id": "string",
  "type": "payout.accepted",
  "createdAt": "2019-08-24T14:15:22Z",
  "data": {
    "reference": "string",
    "amount": "120.00",
    "currency": "GHS",
    "status": "string",
    "provider": "string",
    "fee": "120.00",
    "feeBearer": "initiator",
    "payerAmount": "120.00",
    "recipientAmount": "120.00",
    "note": "string",
    "failureReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z",
    "channel": "api",
    "reconciliation": {
      "status": "unchecked",
      "checkedAt": "2019-08-24T14:15:22Z"
    },
    "parent": {
      "type": "collection",
      "reference": "string"
    },
    "compensation": {
      "type": "collection",
      "reference": "string"
    }
  }
}

Response

Received. Any 2xx stops retries.