API Glossary

Parameter definitions.

This document details the pre-encryption parameters for all endpoints.

​

Create Order

customer · Customer Object · required

Show properties

firstname · string · required

The Customer’s first name.

lastname · string · required

The Customer’s last name.

mobile · string · required

The Customer’s mobile number with the ISO-3 country code.

country · string · required

ISO-2 country code.

email · string

The customer’s email address e.g. [e-mail].

order · Order Object · required

Show properties

amount · number · required

The transaction amount.

reference · string · required

A unique identifier to track the payment.

currency · string · required

The currency code.

description · string · required

The description of the payment order.

payment · Payment Object

Show properties

RedirectUrl · string

Specify the redirection URL for users after payment processing.

paymentlinkid · number

The Payment link’s ID.

frequencyId · number

Specify the ID for the charge frequency e.g. daily, monthly. Learn more about payment frequencies here.

numberOfPayment · number

The total number of times this payment should be made.

paymentMeta · Meta Object

Show properties

ipAddress · string

The Customer’s IP Address.

​

Query Order Fee

amount · string · required

The transaction amount.

paymentmethod · string · required

Expected payment method for the payment. Specify C for card payments.

​

Pay Order

​

Card payments

reference · string · required

A unique identifier to track the payment.

paymentmethod · string · required

Expected payment method for the payment. Specify C for card payments.

country · string · required

ISO-2 country code.

card · Card Object · required

Show properties

cardnumber · string · required

The Customer’s card number.

expirymonth · string · required

2-digit number indicating the card’s expiry month.

expiryyear · string · required

2-digit number indicating the card’s expiry year.

cvv · string · required

A 3 or 4-digit security code on the card.

billingaddress · Address Object · required

Show properties

street · string · required

The primary line of your billing address, including house number and street name.

city · string · required

The name of the town or city where the billing address is situated.

state · string · required

The billing address’ state.

country · string · required

The billing address’ country.

zipcode · string · required

The postal code associated with the billing address.

​

PayPal

reference · string · required

A unique identifier to track the payment.

paymentmethod · string · required

Expected payment method for the payment. Specify PAYPAL for Paypal payments.

card · Card Object · required

Show properties

billingaddress · Address Object · required

Show properties

customerName · string · required

The Customer’s full name.

PhoneNumber · string · required

The Customer’s mobile number including the country code.

HouseNumber · string · required

The unique digit or alphanumeric code assigned to your specific home or building on a street.

street · string · required

The primary line of your billing address, including house number and street name.

city · string · required

The name of the town or city where the billing address is situated.

state · string · required

The billing address’ state.

country · string · required

The billing address’ country.

zipCode · string · required

The postal code associated with the billing address.

​

Query Order Status

reference · string · required

A unique identifier to track the payment.

​

Retrieve Transaction Timeline

eventname · string · required

Add parameter definition.

orderreference · string · required

A unique identifier to track the payment.