Create Payout

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

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

const res = await payx.payout.create({
  amount: 50.0,
  phoneNumber: '0551234987',
  network: 'MTN',
  payeeNote: 'Supplier Payment'
});

{
  "message": "Payout initiated",
  "transactionId": "tx_987654321",
  "status": "PENDING"
}

POST

payout

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

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

const res = await payx.payout.create({
  amount: 50.0,
  phoneNumber: '0551234987',
  network: 'MTN',
  payeeNote: 'Supplier Payment'
});

{
  "message": "Payout initiated",
  "transactionId": "tx_987654321",
  "status": "PENDING"
}

Body Parameters

number

required

The amount to send in GHS.

string

required

The recipient’s 10-digit mobile money number.

string

required

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

string

default:"GHS"

The currency code. Currently only GHS is supported.

string

A note that will appear in the recipient’s transaction history.

string

A note for the merchant’s internal records.

string

Optional email address of the recipient.

object

Custom JSON data to associate with the payout.

Response

string

A summary of the initiation status.

string

The unique ID for this transaction.

string

The current status.

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

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

const res = await payx.payout.create({
  amount: 50.0,
  phoneNumber: '0551234987',
  network: 'MTN',
  payeeNote: 'Supplier Payment'
});

{
  "message": "Payout initiated",
  "transactionId": "tx_987654321",
  "status": "PENDING"
}

​Body Parameters

​Response

Body Parameters

Response