Custom Payment Method Schema

Get

GET
Get custom payment method schema

Path parameters

schemaIdstringRequired

Response

This endpoint returns an object
id
string
name
string
isSource
boolean
This payment method can be used as a payment source for an invoice
isDestination
boolean
This payment method can be used as a payment destination for an invoice
supportedCurrencies
list of enums
List of currencies that this payment method supports.
fields
list of objects
createdAt
datetime
updatedAt
datetime
GET
1curl https://api.mercoa.com/paymentMethod/schema/cpms_14f78dcd-4614-426e-a37a-7af262431d41 \
2 -H "Authorization: Bearer <token>"
200Retrieved
1{
2 "id": "cpms_14f78dcd-4614-426e-a37a-7af262431d41",
3 "name": "Check",
4 "isSource": false,
5 "isDestination": true,
6 "supportedCurrencies": [
7 "USD"
8 ],
9 "fields": [
10 {
11 "name": "payToTheOrderOf",
12 "type": "text",
13 "optional": false,
14 "displayName": "Pay To The Order Of"
15 },
16 {
17 "name": "accountNumber",
18 "type": "number",
19 "optional": false,
20 "displayName": "Account Number",
21 "useAsAccountNumber": true
22 },
23 {
24 "name": "routingNumber",
25 "type": "number",
26 "optional": false,
27 "displayName": "Routing Number"
28 },
29 {
30 "name": "address",
31 "type": "address",
32 "optional": false,
33 "displayName": "Address"
34 }
35 ],
36 "createdAt": "2021-01-01T00:00:00Z",
37 "updatedAt": "2021-01-01T00:00:00Z"
38}