Get a single merchant

GET

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

GET

/ords/relay/api/boarding/v1/merchants/:merchant_id

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

1 {
2   "merchant_id": 1,
3   "platform": "payroc",
4   "rep_code": "REP12345",
5   "customer_id": 987654,
6   "dba_name": "Sunshine Coffee Roasters",
7   "legal_name": "Sunshine Coffee Roasters LLC",
8   "tax_id": "12-3456789",
9   "years_in_business": 5,
10   "website": "https://www.sunshinecoffee.com",
11   "phone": "+1-555-123-4567",
12   "mcc_code": "5812",
13   "business_desc": "Specialty coffee roasting and retail shop",
14   "annual_volume": 1200000,
15   "average_ticket": 25,
16   "in_person_pct": 70,
17   "online_pct": 25,
18   "telephone_pct": 5,
19   "ownership_type": "LLC",
20   "merchant_status": "active",
21   "external_crm_id": "CRM-2024-0001",
22   "custom_01": "Preferred customer",
23   "signer_first_name": "Emily",
24   "signer_last_name": "Johnson",
25   "signer_dob": "03/22/1985",
26   "signer_res_address1": "123 Maple Street",
27   "signer_res_address2": "Apt 4B",
28   "signer_res_city": "Portland",
29   "signer_res_state": "OR",
30   "signer_res_zip": "97205",
31   "signer_email": "emily.johnson@sunshinecoffee.com",
32   "signer_phone": "+1-555-987-6543",
33   "signer_ownership_pct": 100,
34   "addresses": [
35     {
36       "address1": "456 Coffee Lane",
37       "address2": "Suite 101",
38       "city": "Portland",
39       "state": "OR",
40       "zip": "97205",
41       "address_type": "business"
42     }
43   ],
44   "pricing": {
45     "pricing_type": "ic_plus",
46     "discount_frequency": "monthly",
47     "funding_rollup": "net_fees_and_deposits",
48     "dues_and_assessments": true,
49     "amex_program": "amex_opt_blue",
50     "amex_esa_per_item": 0.1,
51     "ic_plus": {
52       "rate_bps": 150,
53       "amex_rate_bps": 200,
54       "per_item": 0.05,
55       "passthrough_interchange": "gross"
56     },
57     "swipe_non_swipe": {
58       "swipe_per_item": 0.03,
59       "swipe_rate_bps": 120,
60       "non_swipe_per_item": 0.1,
61       "non_swipe_rate_bps": 180
62     },
63     "merchant_surcharge_program": {
64       "per_item": 0.05
65     },
66     "flat_rate": {
67       "per_item": 0.1,
68       "rate_bps": 250
69     }
70   },
71   "fees": {
72     "merchant_service_fees": [
73       {
74         "fee_id": "monthly_maintenance",
75         "cost": 15
76       },
77       {
78         "fee_id": "gateway_fee",
79         "cost": 25
80       }
81     ],
82     "pci_program": {
83       "type": "Level 1 PCI Compliance",
84       "cost": "99.99"
85     }
86   },
87   "products": [
88     {
89       "platform_equipment_id": 101,
90       "quantity": 3,
91       "product_id": "TERMINAL-XYZ",
92       "fees": [
93         {
94           "fee_id": "rental_fee",
95           "cost": 12.5
96         }
97       ]
98     }
99   ]
100 }

Retrieve a detailed merchant record from Run Partner.

Get a single merchant

GET

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

GET

/ords/relay/api/boarding/v1/merchants/:merchant_id

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

1 {
2   "merchant_id": 1,
3   "platform": "payroc",
4   "rep_code": "REP12345",
5   "customer_id": 987654,
6   "dba_name": "Sunshine Coffee Roasters",
7   "legal_name": "Sunshine Coffee Roasters LLC",
8   "tax_id": "12-3456789",
9   "years_in_business": 5,
10   "website": "https://www.sunshinecoffee.com",
11   "phone": "+1-555-123-4567",
12   "mcc_code": "5812",
13   "business_desc": "Specialty coffee roasting and retail shop",
14   "annual_volume": 1200000,
15   "average_ticket": 25,
16   "in_person_pct": 70,
17   "online_pct": 25,
18   "telephone_pct": 5,
19   "ownership_type": "LLC",
20   "merchant_status": "active",
21   "external_crm_id": "CRM-2024-0001",
22   "custom_01": "Preferred customer",
23   "signer_first_name": "Emily",
24   "signer_last_name": "Johnson",
25   "signer_dob": "03/22/1985",
26   "signer_res_address1": "123 Maple Street",
27   "signer_res_address2": "Apt 4B",
28   "signer_res_city": "Portland",
29   "signer_res_state": "OR",
30   "signer_res_zip": "97205",
31   "signer_email": "emily.johnson@sunshinecoffee.com",
32   "signer_phone": "+1-555-987-6543",
33   "signer_ownership_pct": 100,
34   "addresses": [
35     {
36       "address1": "456 Coffee Lane",
37       "address2": "Suite 101",
38       "city": "Portland",
39       "state": "OR",
40       "zip": "97205",
41       "address_type": "business"
42     }
43   ],
44   "pricing": {
45     "pricing_type": "ic_plus",
46     "discount_frequency": "monthly",
47     "funding_rollup": "net_fees_and_deposits",
48     "dues_and_assessments": true,
49     "amex_program": "amex_opt_blue",
50     "amex_esa_per_item": 0.1,
51     "ic_plus": {
52       "rate_bps": 150,
53       "amex_rate_bps": 200,
54       "per_item": 0.05,
55       "passthrough_interchange": "gross"
56     },
57     "swipe_non_swipe": {
58       "swipe_per_item": 0.03,
59       "swipe_rate_bps": 120,
60       "non_swipe_per_item": 0.1,
61       "non_swipe_rate_bps": 180
62     },
63     "merchant_surcharge_program": {
64       "per_item": 0.05
65     },
66     "flat_rate": {
67       "per_item": 0.1,
68       "rate_bps": 250
69     }
70   },
71   "fees": {
72     "merchant_service_fees": [
73       {
74         "fee_id": "monthly_maintenance",
75         "cost": 15
76       },
77       {
78         "fee_id": "gateway_fee",
79         "cost": 25
80       }
81     ],
82     "pci_program": {
83       "type": "Level 1 PCI Compliance",
84       "cost": "99.99"
85     }
86   },
87   "products": [
88     {
89       "platform_equipment_id": 101,
90       "quantity": 3,
91       "product_id": "TERMINAL-XYZ",
92       "fees": [
93         {
94           "fee_id": "rental_fee",
95           "cost": 12.5
96         }
97       ]
98     }
99   ]
100 }

Retrieve a detailed merchant record from Run Partner.

Path parameters

merchant_idintegerRequired

The unique identifier for the merchant

Response

Merchant retrieved successfully.

merchant_idinteger

Unique identifier for the merchant.

platformstring

Processing platform (payroc or fiserv).

rep_codestring

Representative code associated with the merchant.

customer_idinteger

Customer ID associated with the merchant.

dba_namestring

Doing Business As (DBA) name of the merchant.

legal_namestring

Legal name of the merchant.

tax_idstring

Tax identification number of the merchant.

years_in_businessinteger

Number of years the business has been operating.

websitestring

Business website URL.

phonestring

Phone number of the merchant.

mcc_codestring

Merchant Category Code (MCC).

business_descstring or null

Description of the business.

annual_volumeinteger

Annual transaction volume in dollars.

average_ticketinteger

Average transaction amount in dollars.

in_person_pctinteger

Percentage of in-person transactions.

online_pctinteger

Percentage of online transactions.

telephone_pctinteger

Percentage of telephone transactions.

ownership_typestring

Ownership type of the business.

merchant_statusstring

Current status of the merchant.

external_crm_idstring or null

External CRM system identifier.

custom_01string or null

Custom field for additional merchant data.

signer_first_namestring

First name of the signer.

signer_last_namestring

Last name of the signer.

signer_dobstring

Date of birth of the signer in the format mm/dd/yyyy.

signer_res_address1string

Residential address line 1 of the signer.

signer_res_address2string

Residential address line 2 of the signer.

signer_res_citystring

Residential city of the signer.

signer_res_statestring

Residential state of the signer (2-character abbreviation).

signer_res_zipstring

Residential ZIP code of the signer.

signer_emailstring

Email address of the signer.

signer_phonestring

Phone number of the signer.

signer_ownership_pctinteger

Ownership percentage of the signer.

addresseslist of objects

List of addresses associated with the merchant.

pricingobject

Pricing details for the merchant.

feesobject

Fee details for the merchant.

productslist of objects

List of products associated with the merchant.

Errors

401

Unauthorized Error

404

Not Found Error