Skip to main content
GET
List merchant referrals

Authorizations

Authorization
string
header
required

Merchant API key bearer token. Legacy wire prefixes api_key_ and api_ are also accepted.

Path Parameters

merchantId
string
required

Referring merchant TypeID (mer_...).

Query Parameters

cursor
string

Opaque pagination cursor from a previous response.

limit
number

Maximum referrals to return (default 20, max 100).

Example:

20

status
enum<string>

Optional referral status filter.

Available options:
pending,
completed

Response

200 - application/json
items
object[]
required
nextCursor
string | null
required