Payout with Token

Make a payout request using a saved customer token.

Endpoint Information

Name: Make Payout Request with Customer Token
Method: POST
URL: {{base_url}}/api/v1/payout/request

Description

Send funds to a returning customer using their saved token (previously generated from customer info).

Authentication

Type: Basic Auth

• Username: App Key
• Password: Secret Key

Request Body

Content-Type: application/json

{
  "merchantAccountId": "{{your_account_no}}",
  "customerToken": "9b18c3f97440add095b7d67527e306e5",
  "reference": "ref-5015",
  "currency": "USD",
  "amount": "27",
  "payoutType": "",  // optional: cardPayout or bankPayout
  "solutionId": "f0850594-efc0-449b-b0ab-7ada65dcd56a",  // optional
  "webhookUrl": "{{webhookUrl}}"  // optional
}

Key Parameters

Parameter	Type	Required	Description
customerToken	string	Yes	The token of the customer to receive funds
reference	string	Yes	Unique reference (min 10 chars)
amount	string	Yes	Payout amount
currency	string	Yes	Currency code

Response

Success Response

{
  "success": true,
  "message": "Payout request created successfully",
  "data": {
    "payout_url": "https://sgw.paymid.com/secure-payout/24fbae5b-3ad0-4702-bd4a-c31f5a0db233",
    "reference": "ref-5015"
  }
}