Skip to main content
GET
List payout methods

Purpose

See which payout methods each vendor can be paid with.

When to use

Before you pick a method for a payout. Part of the Pay vendors with the API flow.

Request and response

The parameters, request body, code examples (curl and other languages) and a full response example are shown below this section. They are generated from the OpenAPI spec.

Errors

Every error has the shape {"success": false, "error": {"code", "message", "errorId", "details"}}. Branch on error.code.

Previous step

Pay vendors with the API

Next step

List pending payouts

Authorizations

x-access-token
string
header
required

JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.

Query Parameters

method
enum<string>

Keep only the vendors that can be paid with this method

Available options:
stripe,
paypal,
globalPayouts,
manual
vendorId
string

Narrow the list to this vendor. Must be a vendor of this shop; otherwise 404.

first
integer

Number of items to return (forward pagination)

Required range: 1 <= x <= 100
after
string

Cursor for forward pagination (from a previous page endCursor)

last
integer

Number of items to return (backward pagination)

Required range: 1 <= x <= 100
before
string

Cursor for backward pagination (from a previous page startCursor)

Response

Vendors with their payout methods

success
enum<boolean>
required
Available options:
true
data
object
required