Skip to content
iSmartPayDevelopers
Esc
↑↓navigate↵open⌘Jpreview

payment_request.received

Sent to a business when another iSmartPay account asks it for money. The payer answers the request in iSmartPay, or the requester cancels it, or it expires. A developer console business cannot approve or decline yet, so for it this event is notice only. An API key cannot approve. Sent once per request. An endpoint created before this event existed only receives it, and it only appears in GET /v1/events, after the endpoint is created or edited in the console. Answer with any 2xx within 10 seconds. Anything else, a timeout or a redirect is retried up to 6 times over about a day.

POSTpayment_request.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.

dataPaymentRequestReceivedrequired

The request that was sent to you.

Show properties
requestIdstringrequired

iSmartPay's id for the request.

referencestringrequired

The reference the requester chose.

requesterNamestringrequired

Who is asking: a person's full name, or for a business its display name, which is its @handle when it set none.

requesterKindstringrequired

Whether the requester is a customer or a business.

Allowed:consumerbusiness
amountstringrequired

What is being asked for. A decimal string in major units.

currencystringrequired
notestring

The requester's note, when they sent one.

expiresAtstring<date-time>required

When the request expires if nobody answers.

Responses
2XX

Received. Any 2xx stops retries.

Payload
{
  "id": "string",
  "type": "payment_request.received",
  "createdAt": "2019-08-24T14:15:22Z",
  "data": {
    "requestId": "string",
    "reference": "string",
    "requesterName": "string",
    "requesterKind": "consumer",
    "amount": "25.00",
    "currency": "GHS",
    "note": "string",
    "expiresAt": "2019-08-24T14:15:22Z"
  }
}
Response
Received. Any 2xx stops retries.