Skip to main content
GET
/
payouts
/
supported
List supported payout methods
curl --request GET \
  --url https://api.salesive.com/api/v1/payouts/supported \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Supported payouts retrieved",
  "data": [
    {
      "_id": "66a9b8c7d6e5f4a3b2c1d0e9",
      "id": "bank_transfer_paystack",
      "name": "Bank Transfer via Paystack",
      "description": "Withdraw to your bank account",
      "active": true,
      "platform": "paystack",
      "channel": "transfer",
      "currencies": [
        "NGN"
      ],
      "image": "https://cdn.salesive.com/payouts/paystack.png"
    }
  ]
}
Returns the supported payout methods/providers available for the store’s currency; payouts are read-only for apps. The store is bound to your app token server-side — never send a shop id.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Response

Supported payout methods/providers.

Standard Salesive response envelope. The operation-specific payload is carried in data.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
object[]