v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Apple Pay and Google Pay

Initiate Payment

This endpoint is used to initiate an Apple Pay or Google Pay collection.

Notes:

Please be advised that access to this API is available upon request. To initiate this process, kindly send an email to support@payaza.africa. You will be granted access once our team reviews and approves your request.
Ensure that the Check Transaction Status API using the merchant reference is used for your transaction status checks which can be found here.

post/merchant-collection/mobile_payment/initiate

Request body

amountnumber required

The amount to be charged.

first_namestring required

The customer's first name.

last_namestring required

The customer's last name..

email_addressstring required

The customer's email address.

payment_optionstring required

APPLEPAY or GOOGLEPAY.

descriptionstring required

The description of this transaction.

transaction_referencestring required

The unique identifier of this transaction.

redirect_urlstring uri required

URL to redirect on successsful.

cancel_urlstring uri required

URL to redirect when user cancels.

error_urlstring uri required

URL to redirect on failed payment.

country_codestring required

The country code. (ISO 3166-1 alpha-3).

currency_codestring required

GBP, EUR and USD.

Example request

{
  "amount": 2,
  "first_name": "John",
  "last_name": "Doe",
  "email_address": "johndoe@email.com",
  "payment_option": "GOOGLEPAY",
  "description": "Support",
  "transaction_reference": "TX20251109",
  "redirect_url": "https://redirect.url/success",
  "cancel_url": "https://redirect.url/cancel",
  "error_url": "https://redirect.url/error",
  "country_code": "NGN",
  "currency_code": "USD"
}

Response

Initiate Payment Successful Response

statusboolean

Request status.

messagestring

Response message.

Example response

{
  "status": true,
  "message": "payment initiated successfully",
  "data": {
    "error_url": "https://redirect.url/error",
    "merchant_reference": "TX20251109",
    "payment_option": "GOOGLEPAY",
    "transaction_amount": 2,
    "slug_name": "dev-guide-test",
    "currency": "USD",
    "paymentUrl": "https://checkout.payaza.com/pay/...",
    "transaction_reference": "TX20251109",
    "cancel_url": "https://redirect.url/cancel",
    "redirect_url": "https://redirect.url/success"
  }
}

All 57 operations