Find

GET

Query parameters

limitintegerOptional

Number of payment methods to return. Limit can range between 1 and 100, and the default is 10.

startingAfterstringOptional

The ID of the payment method to start after. If not provided, the first page of payment methods will be returned.

typeenumOptional

Type of payment method to filter

entityIdstringOptional

Entity ID to filter

Response

This endpoint returns an object

countinteger

hasMoreboolean

datalist of objects

GET

1 curl https://api.mercoa.com/paymentMethods \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "count": 1,
3   "hasMore": false,
4   "data": [
5     {
6       "paymentMethod": {
7         "type": "bankAccount",
8         "accountName": "My Checking Account",
9         "accountNumber": "99988767623",
10         "accountType": "CHECKING",
11         "bankName": "Chase",
12         "createdAt": "2021-01-01T00:00:00Z",
13         "frozen": false,
14         "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
15         "isDefaultDestination": true,
16         "isDefaultSource": true,
17         "metadata": {},
18         "routingNumber": "12345678",
19         "status": "VERIFIED",
20         "supportedCurrencies": [
21           "USD"
22         ],
23         "updatedAt": "2021-01-01T00:00:00Z"
24       },
25       "entity": {
26         "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
27         "name": "Acme Inc.",
28         "email": "customer@acme.com",
29         "isCustomer": true,
30         "accountType": "business",
31         "profile": {
32           "business": {
33             "legalBusinessName": "Acme Inc.",
34             "taxIDProvided": true,
35             "email": "customer@acme.com",
36             "businessType": "llc",
37             "phone": {
38               "countryCode": "1",
39               "number": "4155551234"
40             },
41             "address": {
42               "addressLine1": "123 Main St",
43               "city": "San Francisco",
44               "stateOrProvince": "CA",
45               "postalCode": "94105",
46               "addressLine2": "Unit 1",
47               "country": "US"
48             },
49             "ownersProvided": true
50           }
51         },
52         "status": "verified",
53         "acceptedTos": true,
54         "isPayor": true,
55         "isPayee": false,
56         "isNetworkPayor": false,
57         "isNetworkPayee": false,
58         "createdAt": "2024-01-01T00:00:00Z",
59         "updatedAt": "2024-01-02T00:00:00Z",
60         "foreignId": "MY-DB-ID-12345"
61       }
62     }
63   ]
64 }

Built with

1	curl https://api.mercoa.com/paymentMethods \
2	-H "Authorization: Bearer <token>"

1	{
2	"count": 1,
3	"hasMore": false,
4	"data": [
5	{
6	"paymentMethod": {
7	"type": "bankAccount",
8	"accountName": "My Checking Account",
9	"accountNumber": "99988767623",
10	"accountType": "CHECKING",
11	"bankName": "Chase",
12	"createdAt": "2021-01-01T00:00:00Z",
13	"frozen": false,
14	"id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
15	"isDefaultDestination": true,
16	"isDefaultSource": true,
17	"metadata": {},
18	"routingNumber": "12345678",
19	"status": "VERIFIED",
20	"supportedCurrencies": [
21	"USD"
22	],
23	"updatedAt": "2021-01-01T00:00:00Z"
24	},
25	"entity": {
26	"id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
27	"name": "Acme Inc.",
28	"email": "customer@acme.com",
29	"isCustomer": true,
30	"accountType": "business",
31	"profile": {
32	"business": {
33	"legalBusinessName": "Acme Inc.",
34	"taxIDProvided": true,
35	"email": "customer@acme.com",
36	"businessType": "llc",
37	"phone": {
38	"countryCode": "1",
39	"number": "4155551234"
40	},
41	"address": {
42	"addressLine1": "123 Main St",
43	"city": "San Francisco",
44	"stateOrProvince": "CA",
45	"postalCode": "94105",
46	"addressLine2": "Unit 1",
47	"country": "US"
48	},
49	"ownersProvided": true
50	}
51	},
52	"status": "verified",
53	"acceptedTos": true,
54	"isPayor": true,
55	"isPayee": false,
56	"isNetworkPayor": false,
57	"isNetworkPayee": false,
58	"createdAt": "2024-01-01T00:00:00Z",
59	"updatedAt": "2024-01-02T00:00:00Z",
60	"foreignId": "MY-DB-ID-12345"
61	}
62	}
63	]
64	}