Ghana

Supported payment methods and integration details for Ghana

Country Details

Country ID: 16 • Country Code: 233 • Currency: GHS (Ghanaian Cedi)

Supported Payment Methods & Payload Requirements

Channel	Flow	`payment_method_type`	Required Payload Array / Fields	Destination / Operator	API Reference
MTN MoMo	Deposit	`"mtn"`	`mobile` (format: `"233XXXXXXXXX"`)	MTN Ghana (Prompt on handset)	Collections API
Telecel (Vodafone Cash)	Deposit	`"vodafone"`	`mobile` (format: `"233XXXXXXXXX"`)	Telecel Ghana (Prompt on handset)	Collections API
AT (AirtelTigo)	Deposit	`"at"`	`mobile` (format: `"233XXXXXXXXX"`)	AT Ghana (Prompt on handset)	Collections API
MTN MoMo	Payout	`"mtn"`	`mtn: [{"phone_number": "233XXXXXXXXX"}]`	MTN Ghana Mobile Wallet	Payments API
Telecel (Vodafone Cash)	Payout	`"Vodafone"`	`Vodafone: [{"phone_number": "233XXXXXXXXX"}]`	Telecel Ghana Mobile Wallet	Payments API
AT (AirtelTigo)	Payout	`"at"`	`at: [{"phone_number": "233XXXXXXXXX"}]`	AT Ghana Mobile Wallet	Payments API

Payment Flow: How It Works

Deposits (Collections)

Initiation: Send a signed POST request to the Unified Collections endpoint with payment_method_type set to "mtn", "vodafone", or "at", along with country_id: 16, currency: "GHS", amount, and the customer’s phone number in mobile (format: 233XXXXXXXXX).
Handset Prompt: The customer receives a prompt on their handset to enter their PIN and authorize the transfer.
Initial Response: Niobi returns an acknowledgement (payment_step: 1) containing the assigned depositId.
Callback Confirmation: Once the customer confirms the payment on their phone, Niobi delivers an asynchronous webhook callback (payment_step: 2, status: "success") to your callback_url.

Payouts (Disbursements)

When submitting a payout to Ghana via the Unified Payments endpoint, pass the appropriate payment_method_type and its corresponding nested array:

MTN MoMo: Pass payment_method_type: "mtn" with an mtn array containing phone_number.
Telecel (Vodafone Cash): Pass payment_method_type: "Vodafone" with a Vodafone array containing phone_number.
AT (AirtelTigo): Pass payment_method_type: "at" with an at array containing phone_number.

Sample Requests & Responses

MTN MoMo Deposit Request

{
    "client_id": "YOUR_CLIENT_ID",
    "params": {
        "amount": 100,
        "callback_url": "https://example.com/callback",
        "country_id": 16,
        "currency": "GHS",
        "email": "customer@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "mobile": "233593456789",
        "payment_method_type": "mtn",
        "third_party_reference_1": "TX-GHS-DEP-1001",
        "third_party_reference_2": "CUST-601"
    },
    "salt": "random_salt_12345",
    "sender": "YOUR_INTEGRATION_NAME",
    "timestamp": 1724835600,
    "signature": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0"
}

Deposit Response (Initiation)

{
    "success": true,
    "message": "Payment process initiated successfully.",
    "data": {
        "account_name": "John Doe",
        "amount": 100,
        "callback_url": "https://example.com/callback",
        "country_id": 16,
        "currency": "GHS",
        "depositId": "dep_12345678",
        "mobile": "233593456789",
        "payment_method_type": "mtn",
        "payment_step": 1,
        "status": "success",
        "third_party_reference_1": "TX-GHS-DEP-1001"
    },
    "status_code": "000000"
}

Payout Request (MTN MoMo)

{
    "client_id": "YOUR_CLIENT_ID",
    "params": {
        "amount": 50,
        "client_callback_url": "https://example.com/callback",
        "country_id": 16,
        "currency": "GHS",
        "first_name": "John",
        "last_name": "Doe",
        "mobile": "233593456789",
        "payment_method_type": "mtn",
        "payment_reference": "YOUR-PAYOUT-REF",
        "third_party_reference_1": "TX-GHS-DISB-2001",
        "mtn": [
            {
                "phone_number": "233593456789"
            }
        ]
    },
    "salt": "random_salt_12345",
    "sender": "YOUR_INTEGRATION_NAME",
    "timestamp": 1724835600,
    "signature": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0"
}

Payout Response (Initiation)

{
    "success": true,
    "message": "Payment process initiated successfully.",
    "data": {
        "creation_date": "2026-08-28T12:30:00.000000Z",
        "from": "YOUR_INTEGRATION_NAME",
        "payment_step": 1,
        "reference": "ref_98765432",
        "to": "233593456789",
        "total": 50,
        "type": "MTN MoMo"
    },
    "status_code": "000000"
}

Webhook/Callback Examples

Successful Deposit Callback

{
    "client_id": "YOUR_CLIENT_ID",
    "salt": "random_salt_12345",
    "sender": "YOUR_INTEGRATION_NAME",
    "timestamp": 1724835600,
    "signature": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0",
    "params": {
        "amount": 100,
        "currency": "GHS",
        "depositId": "dep_12345678",
        "email": "customer@example.com",
        "mobile": "233593456789",
        "name": "John Doe",
        "payment_step": 2,
        "status": "success",
        "status_code": "000000",
        "third_party_reference_1": "TX-GHS-DEP-1001",
        "third_party_reference_2": "CUST-601"
    }
}

Successful Payout Callback

{
    "client_id": "YOUR_CLIENT_ID",
    "salt": "random_salt_12345",
    "sender": "YOUR_INTEGRATION_NAME",
    "timestamp": 1724835600,
    "signature": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0",
    "params": {
        "account": "233593456789",
        "amount": 50,
        "currency": "GHS",
        "fee": 1,
        "message": "Payment was transferred successfully.",
        "mobile": "233593456789",
        "payee": "John Doe",
        "payment_channel": "MTN MoMo",
        "payment_reference": "YOUR-PAYOUT-REF",
        "payment_step": 2,
        "payoutId": "bd8f51a2-xxxx-xxxx-xxxx-xxxxx9a",
        "ref": "ref_98765432",
        "status": "success",
        "statusCode": "000000",
        "third_party_reference_1": "TX-GHS-DISB-2001",
        "third_party_reference_2": null,
        "transaction_date": "2026-08-28 12:30:00",
        "transaction_detail": "Disbursement made through MTN MoMo",
        "type": "Pay out"
    }
}

Try it

Try it: POST /api/v4/niobi-unified-collections

Collections API reference for Ghana deposits.

Try it: POST /api/v4/niobi-unified-payments

Payments API reference for Ghana payouts.

Transaction Limits

For the full list of minimum and maximum transaction limits for Ghana (GHS) collections and payouts, please see the Transaction Limits for Ghana section on the Transaction Limits page.

Get Started with Niobi

API Authentication

Collecting Payments

Making Payments

Transaction Status

Supporting Documentation

Ghana | Supported Payment Methods & Corridors

Ghana

Supported Payment Methods & Payload Requirements

Payment Flow: How It Works

Deposits (Collections)

Payouts (Disbursements)

Sample Requests & Responses

MTN MoMo Deposit Request

Deposit Response (Initiation)

Payout Request (MTN MoMo)

Payout Response (Initiation)

Webhook/Callback Examples

Successful Deposit Callback

Successful Payout Callback

Try it

Try it: POST /api/v4/niobi-unified-collections

Try it: POST /api/v4/niobi-unified-payments

Transaction Limits

​Ghana

​Supported Payment Methods & Payload Requirements

​Payment Flow: How It Works

​Deposits (Collections)

​Payouts (Disbursements)

​Sample Requests & Responses

​MTN MoMo Deposit Request

​Deposit Response (Initiation)

​Payout Request (MTN MoMo)

​Payout Response (Initiation)

​Webhook/Callback Examples

​Successful Deposit Callback

​Successful Payout Callback

​Try it

Try it: POST /api/v4/niobi-unified-collections

Try it: POST /api/v4/niobi-unified-payments

​Transaction Limits

Ghana

Supported Payment Methods & Payload Requirements

Payment Flow: How It Works

Deposits (Collections)

Payouts (Disbursements)

Sample Requests & Responses

MTN MoMo Deposit Request

Deposit Response (Initiation)

Payout Request (MTN MoMo)

Payout Response (Initiation)

Webhook/Callback Examples

Successful Deposit Callback

Successful Payout Callback

Try it

Transaction Limits