v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Merchants

Search merchants

get/merchants

Query parameters

merchant_idstring

Search for specific merchant ID(s). Comma separate for multiple.

merchant_namestring

Search for merchants by name.

gateway_idinteger

Search merchants that are on a specific gateway. Comma Separate for Multiple.

1 - NMI
2 - Inovio
3 - Unipay
4 - Agp
5 - Test
9 - Check
10 - Authorize.net
11 - Stripe - Legacy
12 - Cash
13 - Qualpay
14 - Paypal Payment Pro
15 - Paypal - Legacy
16 - Braintree
18 - Paysafe
19 - Link4Pay
20 - SeamlessChex
21 - Worldnet
22 - Fluidpay
24 - Maverick
26 - Worldpay
27 - Paynetworx
28 - Everypay
29 - Moneris
30 - USA ePay
31 - Everyware
32 - Axcess
33 - Surepay
34 - Bill1st
35 - Checkout.com
36 - Qoin
37 - RocketGate
39 - Sezzle
40 - PayPal
42 - Cybersource
43 - ConnectX
44 - Revolv3
46 - CCBill
47 - FlexFactor
49 - Stripe

card_type_idinteger

Return merchants that accept a specific card type. Comma Separate for Multiple.

1 - Mastercard
2 - Visa
3 - Discover
4 - American Express
5 - Digital Wallet
6 - ACH

currency_idinteger

Return merchants that accept a specific currency. Comma separate for Multiple

1 - USD
2 - EUR
3 - GBP
4 - CAD
5 - AUD
6 - NZD
7 - DKK
8 - SEK
9 - NOK

merchant_mid_idstring

Filter results using the Merchant Identification Number ( MID ) configured when setting up a merchant.

merchant_descriptorstring

Filter results using the Merchant Descriptor configured when setting up a merchant.

primary_merchant_category_idinteger

Filter results using the Primary Category ID configured when setting up a merchant. This value can be found on the Merchant Category page in Vrio.

secondary_merchant_category_idinteger

Filter results using the Secondary Category ID configured when setting up a merchant. This value can be found on the Merchant Category page in Vrio.

merchant_activeboolean

Return merchants with a specific active status.

with'merchant_currencies' | 'merchant_payment_methods' | 'merchant_card_types' | 'primary_merchant_category' | 'secondary_merchant_category'

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=merchant_currencies,merchant_payment_methods)

limitinteger

Limit the number of results. Default: 25, max: 200.

offsetinteger

Offset the results

sort_bystring

Field to sort result by

order'asc' | 'desc'

Order by asc or desc

Response

totalstring

Example response

{
  "merchants": [
    {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00"
    }
  ]
}