Create Charge

curl -X POST https://payx.company/api/v1/charge \
  -H "x-api-key: sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1.0,
    "phoneNumber": "0551234987",
    "network": "MTN"
  }'

const { PayX } = require('payx-node');
const payx = new PayX({ apiKey: 'sk_test_...' });

const res = await payx.charge.create({
  amount: 1.0,
  phoneNumber: '0551234987',
  network: 'MTN'
});

{
  "message": "Transaction initiated",
  "transactionId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING"
}

POST

charge

curl -X POST https://payx.company/api/v1/charge \
  -H "x-api-key: sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1.0,
    "phoneNumber": "0551234987",
    "network": "MTN"
  }'

const { PayX } = require('payx-node');
const payx = new PayX({ apiKey: 'sk_test_...' });

const res = await payx.charge.create({
  amount: 1.0,
  phoneNumber: '0551234987',
  network: 'MTN'
});

{
  "message": "Transaction initiated",
  "transactionId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING"
}

Body Parameters

number

required

The amount to collect in GHS.

string

required

The customer’s 10-digit mobile money number (e.g., 0551234987).

string

required

The network provider. Options: MTN, TELECEL, AIRTELTIGO.

string

default:"GHS"

The currency code. Currently only GHS is supported.

string

A message displayed to the customer on their phone.

string

A private note for your records.

Response

string

A summary of the initiation status.

string

The unique ID for this transaction. Use this for status checks.

string

The current status. Usually PENDING.

curl -X POST https://payx.company/api/v1/charge \
  -H "x-api-key: sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1.0,
    "phoneNumber": "0551234987",
    "network": "MTN"
  }'

const { PayX } = require('payx-node');
const payx = new PayX({ apiKey: 'sk_test_...' });

const res = await payx.charge.create({
  amount: 1.0,
  phoneNumber: '0551234987',
  network: 'MTN'
});

{
  "message": "Transaction initiated",
  "transactionId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING"
}

​Body Parameters

​Response

Body Parameters

Response