Skip to main content
POST
GHS Collection Application
All example requests on this page are based on the sandbox (test) environment. Please be careful to distinguish it from the production environment.

Secret Key & Private Key (Generate Signature)

Body

application/json
appId
integer<int64>
required

Business ID obtained from the backend; it must match the URL currency

orderId
string
required

Unique merchant order ID, up to 48 characters

Maximum string length: 48
amount
string
required

Transaction amount in GHS, up to 2 decimal places; subject to the merchant backend business configuration

Pattern: ^((([1-9]\d*)(\.\d{1,4})?)|(0\.(?!0+$)\d{1,4}))$
payType
enum<string>
required

Payment type; only EWALLET is supported

Available options:
EWALLET
phone
string
required

Payer phone number: 12 digits starting with 233, without a plus sign

Pattern: ^233\d{9}$
sign
string
required

Signature

inBankCode
string

Mobile Money operator payment code supported by the merchant backend payment-code configuration

name
string

Payer name

email
string<email>

Payer email

callBackUrl
string<uri>

Redirect URL after successful payment

callBackFailUrl
string<uri>

Redirect URL after failed payment

notifyUrl
string<uri>

Asynchronous notification URL

subject
string

Transaction title, product name, or payment reason

body
string

Detailed remark

partnerUserId
string

Unique user identifier

Maximum string length: 64
Pattern: ^[a-zA-Z0-9\-~!@#$%&*()_]+$

Response

200 - application/json

Success

status
string

API status: 1 normal, 0 exception

error
string

Error code

msg
string

Message

data
object
Last modified on October 29, 2026