Charge Users Through USSD

This endpoint allows users to make payments using Unstructured Supplementary Service Data (USSD).

POST /api/pgs/payment/v1/makePayment

Charge Users Through USSD

cURL

curl --request POST \
  --url https://charge-payment.com/v1/api/pgs/payment/v1/makePayment \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "<string>",
  "userId": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "callbackURL": "<string>",
  "isV2": true
}
'

200

{
  "reference": 143379339129,
  "clientId": "admintest7",
  "paymentUrl": "https://sandbox.globalaccelerex.com:6038/pay/16661108ZjGG7aY39B",
  "status": "CREATED",
  "paymentChannel": "DEFAULT",
  "paymentUrlReference": "16661108ZjGG7aY39B",
  "externalPaymentReference": "16661108ZjGG7aY39B"
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

reference · string

Unique Transaction Reference Number

userId · string

Customer reference

amount · string

The transaction amount

currency · string

The transaction currency

callbackURL · string

Callback URL on transaction completed

isV2 · boolean

The version of the API called

Response

200

application/json

Transaction Successful

reference · number

Unique Transaction Reference Number

Example:

143379339129

clientId · string

Client unique ID

Example:

"admintest7"

paymentUrl · string

Payment URL from the payment provider

Example:

"https://sandbox.globalaccelerex.com:6038/pay/16661108ZjGG7aY39B"

status · string

Payment Status

Example:

"CREATED"

paymentChannel · string

Payment channel

Example:

"DEFAULT"

paymentUrlReference · string

Payment unique reference

Example:

"16661108ZjGG7aY39B"

externalPaymentReference · string

External Payment unique reference

Example:

"16661108ZjGG7aY39B"