List merchants

GET

https://apps.runpayments.io/ords/relay/api/boarding/v1/merchants

GET

/ords/relay/api/boarding/v1/merchants

$ curl https://apps.runpayments.io/ords/relay/api/boarding/v1/merchants \
>      -H "Authorization: Bearer <token>"

1 {
2   "items": [
3     {
4       "merchant_id": 10234,
5       "platform": "payroc",
6       "rep_code": "REP789",
7       "customer_id": 56789,
8       "mid": "MID123456789",
9       "dba_name": "Sunrise Coffee Shop",
10       "legal_name": "Sunrise Coffee LLC",
11       "merchant_status": "live",
12       "pended": 0,
13       "merchant_type_id": 3,
14       "external_crm_id": "CRM-4587",
15       "custom_01": "Priority client"
16     }
17   ],
18   "hasMore": true,
19   "limit": 1,
20   "offset": 1,
21   "count": 1,
22   "links": [
23     {
24       "rel": "next",
25       "href": "https://apps.runpayments.io/ords/relay/api/boarding/v1/merchants?limit=1&offset=2"
26     }
27   ]
28 }

Retrieve a list of merchants accessible to the authenticated user. Returns merchants where the current user is associated as a sales officer, sales partner, or distributor client.

List merchants

List merchants

Query parameters

Response

Errors

Query parameters

Response

Errors

$	curl https://apps.runpayments.io/ords/relay/api/boarding/v1/merchants \
>	-H "Authorization: Bearer <token>"

1	{
2	"items": [
3	{
4	"merchant_id": 10234,
5	"platform": "payroc",
6	"rep_code": "REP789",
7	"customer_id": 56789,
8	"mid": "MID123456789",
9	"dba_name": "Sunrise Coffee Shop",
10	"legal_name": "Sunrise Coffee LLC",
11	"merchant_status": "live",
12	"pended": 0,
13	"merchant_type_id": 3,
14	"external_crm_id": "CRM-4587",
15	"custom_01": "Priority client"
16	}
17	],
18	"hasMore": true,
19	"limit": 1,
20	"offset": 1,
21	"count": 1,
22	"links": [
23	{
24	"rel": "next",
25	"href": "https://apps.runpayments.io/ords/relay/api/boarding/v1/merchants?limit=1&offset=2"
26	}
27	]
28	}