Skip to main content
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"
  }'

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

Documentation Index

Fetch the complete documentation index at: https://docs.payx.company/llms.txt

Use this file to discover all available pages before exploring further.

​
Body Parameters

​
amount
number
required
The amount to send in GHS.
​
phoneNumber
string
required
The recipient’s 10-digit mobile money number.
​
network
string
required
The network provider. Options: MTN, TELECEL, AIRTELTIGO.
​
currency
string
default:"GHS"
The currency code. Currently only GHS is supported.
​
payeeNote
string
A note that will appear in the recipient’s transaction history.
​
payerMessage
string
A note for the merchant’s internal records.
​
email
string
Optional email address of the recipient.
​
metadata
object
Custom JSON data to associate with the payout.

​
Response

​
message
string
A summary of the initiation status.
​
transactionId
string
The unique ID for this transaction.
​
status
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"
  }'

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