Skip to main content
POST
/
merchant-collection
/
mobile_payment
/
initiate
Initiate Payment
curl --request POST \
  --url https://api.payaza.africa/live/merchant-collection/mobile_payment/initiate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 2,
  "first_name": "John",
  "last_name": "Doe",
  "payment_option": "GOOGLEPAY",
  "description": "Support",
  "transaction_reference": "TX20251109",
  "redirect_url": "https://redirect.url/success",
  "cancel_url": "https://redirect.urlcancel",
  "error_url": "https://redirect.url/error",
  "country_code": "USA",
  "currency_code": "USD"
}
'
{
  "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": "{{paymentUrl}}",
    "transaction_reference": "TX20251109",
    "cancel_url": "https://redirect.urlcancel",
    "redirect_url": "https://redirect.url/success"
  }
}

Authorizations

​
Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

Body

application/json
​
amount
number
required

The amount to be charged.

Example:

2

​
first_name
string
required

The customer's first name.

Example:

"John"

​
last_name
string
required

The customer's last name..

Example:

"Doe"

​
payment_option
string
required

APPLEPAY or GOOGLEPAY.

Example:

"GOOGLEPAY"

​
description
string
required

The description of this transaction.

Example:

"Support"

​
transaction_reference
string
required

The unique identifier of this transaction.

Example:

"TX20251109"

​
redirect_url
string<uri>
required

URL to redirect on successsful.

Example:

"https://redirect.url/success"

​
cancel_url
string<uri>
required

URL to redirect when user cancels.

Example:

"https://redirect.url/cancel"

​
error_url
string<uri>
required

URL to redirect on failed payment.

Example:

"https://redirect.url/error"

​
country_code
string
required

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

Example:

"NGN"

​
currency_code
string
required

GBP, EUR and USD.

Example:

"USD"

Response

Initiate Payment Successful Response

​
status
boolean

Request status.

Example:

true

​
message
string

Response message.

Example:

"payment initiated successfully"

​
data
object

Payment initialization details.