Skip to main content
GET
Get a payout method by id
Returns one configured payout method with its merchant-supplied 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.

Path Parameters

id
string
required

The payout method's id (Mongo ObjectId).

Response

The requested payout method.

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

A payout method configured by the store. payout references the supported payout method by id; data holds the merchant-supplied method details.