Skip to main content
GET
/
payouts
List payout methods
curl --request GET \
  --url https://api.salesive.com/api/v1/payouts \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Payouts retrieved",
  "data": [
    {
      "_id": "66b1f0a3c2d4e5f6a7b8c9d0",
      "user": "66a0c1d2e3f4a5b6c7d8e9f0",
      "shop": "6680aabbccddeeff00112200",
      "payout": "66a9b8c7d6e5f4a3b2c1d0e9",
      "data": {
        "accountNumber": "1234567890",
        "bankCode": "058",
        "accountName": "Ada Lovelace",
        "bankName": "GTBank"
      },
      "createdAt": "2026-02-01T08:00:00.000Z",
      "updatedAt": "2026-02-01T08:00:00.000Z"
    }
  ]
}
Returns the store’s configured payout methods with their method details; 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

The store's configured payout methods.

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[]