transfer.received

Sent to the receiving business when another business’s transfer completes and the money is in its wallet. Sent once per transfer. Answer with any 2xx within 10 seconds. Anything else, a timeout or a redirect is retried up to 6 times over about a day.

POSTtransfer.receivedWebhook

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.

dataTransferReceivedrequired

The transfer that reached your wallet.

Show properties

referencestringrequired

The reference the sending business chose.

amountstringrequired

What reached your wallet. A decimal string in major units.

currencystringrequired

senderNamestring

The sending business's trading name, else registered name, when known.

completedAtstring<date-time>

Responses

2XX

Received. Any 2xx stops retries.

Payload

{
  "id": "string",
  "type": "transfer.received",
  "createdAt": "2019-08-24T14:15:22Z",
  "data": {
    "reference": "string",
    "amount": "25.00",
    "currency": "GHS",
    "senderName": "string",
    "completedAt": "2019-08-24T14:15:22Z"
  }
}

Response

Received. Any 2xx stops retries.