charge

POST

Callout charge: asks your endpoint to charge a buyer for a purchase.

Parameters

Header Parameters

webhook-id

required

string

Unique id of this delivery. Deduplicate on it.

webhook-timestamp

required

string

Unix time in seconds when the delivery was signed.

webhook-signature

required

string

Standard Webhooks signature, v1,<base64 HMAC-SHA256> of id.timestamp.body.

webhook-type

required

string

Always charge.

Request Body^required

Media typeapplication/json

ChargeRequest

Callout charge: asks your endpoint to charge a buyer for a purchase.

object

buyer

required

Buyer

External id of the buyer.

string

currency

required

Currency

ISO 4217 currency.

string

item

required

PurchaseItem

What is being bought.

object

description

Any of:

string

string

<= 2000 characters

null

null

id

Any of:

string

string

null

null

kind

Any of:

string

string

null

null

title

required

Title

The item’s name.

string

>= 1 characters <= 200 characters

price_minor

required

Price Minor

Price in minor units of currency.

integer

purchase_id

required

Purchase Id

Id of the purchase; also the Idempotency-Key.

string format: uuid

seller

required

Seller

External id of the seller.

string

Responses

200

The answer we use

Media typeapplication/json

ChargeResponse

Your answer to the charge and charge_status callouts.

object

external_ref

Any of:

string

string

null

null

status

required

Status

insufficient sends the buyer to top up; pending is checked again later.

string

Allowed values: paid insufficient failed pending

topup_url

Any of:

string

string

null

null

Example

{
  "external_ref": null,
  "status": "paid",
  "topup_url": null
}