Accept Payments — Overview

Initialize a collection transaction to accept a customer payment.

See Authentication before making requests.

Endpoint

POST /transaction/initialize

Headers

Header	Value
Authorization	Bearer PUBLIC_KEY
Content-Type	application/json

Find your public key in Settings on the Startbutton dashboard.

Parameters

Parameter	Required	Description
email	Yes	Payer email address.
amount	Yes	Amount in fractional units.
currency	Yes	Collection currency.
partner	No	A configured partner value.
reference	No	Your unique collection identifier.
metadata	No	Your custom transaction data.
redirectUrl	No	URL for the customer after payment.

On success, the API returns an authorization URL for the customer.

Sample request

Find test numbers to aid your checkout test Test Numbers for Collections.

Required parameters

{
  "amount": 30000,
  "currency": "GHS",
  "email": "[e-mail]"
}

Use a supported collection currency.

Optional parameters

{
  "amount": 30000,
  "currency": "GHS",
  "email": "[e-mail]",
  "reference": "be6eaxxxxxxx"
}

The reference value returns as userTransactionRef in the webhook payload.

Metadata

{
  "amount": 30000,
  "currency": "KES",
  "email": "[e-mail]",
  "reference": "BUY781",
  "metadata": {
    "name": "ade",
    "location": "Nigeria"
  }
}

Sample response

{
  "success": true,
  "message": "Encrypted",
  "data": "pay.startbuton.tech/#/{paymentCode}"
}