Take a payment

zend.pay asks the current user to send money to a Zend user. Zend checks your limits, shows its confirm sheet, sends the money, and records the payment against your app.

const { paymentId, status } = await zend.pay({
  to: "@ada",
  price: { ngn: 2000 },
  note: "Article: How to win at Ludo",
  reference: "article_7",
});

Needs the pay permission.

Parameters

`@${string}`

required

The recipient’s username, with @.

number

US dollars, from 0.01. Give amount or price, not both.

{ ngn: number }

Price in Naira. Zend converts at its current rate and shows ₦ on its sheet.

string

Shown to both people.

string

Up to 64 characters. Comes back on the webhook.

string

The interaction this payment is part of. With a spend allowance, payments to other people in it can skip the confirm sheet.

object[]

Pay others from the same payment. See Split payments.

Returns

{ paymentId, status }. Use it to update your UI, not to grant anything.

Confirm on your server

payment.completed reaches your webhook even if the user closes your app right after paying.

{
  "type": "payment.completed",
  "data": {
    "payment_id": "…",
    "from": "zu_...",
    "to": "zu_...",
    "amount_usd": 1.32,
    "price_ngn": 2000,
    "ngn_per_usd": 1515.15,
    "rate_id": "…",
    "reference": "article_7"
  }
}

Before recording it, Zend checks the payer, recipient and amount against what your app asked for. See Verifying payments.

Errors

Code	Meaning
`USER_CANCELLED`	The user tapped Cancel
`BUSY`	Another money sheet is open
`PERMISSION_DENIED`	Your manifest lacks `pay`
`INVALID_AMOUNT`	Amount missing or out of range
`APP_LIMIT_AMOUNT`	Over your tier’s payment size
`APP_LIMIT_DAILY`	Over your tier’s daily spend for this user
`NOT_CONNECTED`	The user hasn’t continued to your app

Get started

Build a ZApp

Money

Fair results

Ship

Examples

Parameters

Returns

Confirm on your server

Errors

​Parameters

​Returns

​Confirm on your server

​Errors

Parameters

Returns

Confirm on your server

Errors