Create — Mercoa | Documentation

Create custom payment method schema

Request

This endpoint expects an object.

namestringRequired

isSourcebooleanRequired

This payment method can be used as a payment source for an invoice

isDestinationbooleanRequired

This payment method can be used as a payment destination for an invoice

fieldslist of objectsRequired

supportedCurrencieslist of enumsOptional

List of currencies that this payment method supports. If not provided, the payment method will support only USD.

estimatedProcessingTimeintegerOptional

Estimated time in days for this payment method to process a payments. Set as 0 for same-day payment methods, -1 for unknown processing time.

maxAmountdoubleOptional

The maximum amount that can be transferred from this payment method in a single transaction.

minAmountdoubleOptional

The minimum amount that can be transferred from this payment method in a single transaction. Default is 1.

feesobjectOptional

Response

This endpoint returns an object.

idstring

namestring

isSourceboolean

This payment method can be used as a payment source for an invoice

isDestinationboolean

This payment method can be used as a payment destination for an invoice

supportedCurrencieslist of enums

List of currencies that this payment method supports.

fieldslist of objects

estimatedProcessingTimeinteger

Estimated time in days for this payment method to process a payments. 0 is an same-day payment methods, -1 is unknown processing time.

createdAtdatetime

updatedAtdatetime

maxAmountdoubleOptional

The maximum amount that can be transferred from this payment method in a single transaction.

minAmountdoubleOptional

The minimum amount that can be transferred from this payment method in a single transaction. Default is 1.

feesobjectOptional

1 curl -X POST https://api.mercoa.com/paymentMethod/schema \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "name": "Wire", 6 "isSource": false, 7 "isDestination": true, 8 "fields": [ 9 { 10 "name": "bankName", 11 "type": "text", 12 "optional": false, 13 "displayName": "Bank Name" 14 }, 15 { 16 "name": "recipientName", 17 "type": "text", 18 "optional": false, 19 "displayName": "Recipient Name" 20 }, 21 { 22 "name": "accountNumber", 23 "type": "usBankAccountNumber", 24 "optional": false, 25 "displayName": "Account Number", 26 "useAsAccountNumber": true 27 }, 28 { 29 "name": "routingNumber", 30 "type": "usBankRoutingNumber", 31 "optional": false, 32 "displayName": "Routing Number" 33 } 34 ], 35 "supportedCurrencies": [ 36 "USD", 37 "EUR" 38 ], 39 "estimatedProcessingTime": 0, 40 "maxAmount": 100000, 41 "minAmount": 1 42 }'

1 { 2 "id": "cpms_4794d597-70dc-4fec-b6ec-c5988e759769", 3 "name": "Wire", 4 "isSource": false, 5 "isDestination": true, 6 "supportedCurrencies": [ 7 "USD", 8 "EUR" 9 ], 10 "fields": [ 11 { 12 "name": "bankName", 13 "type": "text", 14 "optional": false, 15 "displayName": "Bank Name" 16 }, 17 { 18 "name": "recipientName", 19 "type": "text", 20 "optional": false, 21 "displayName": "Recipient Name" 22 }, 23 { 24 "name": "accountNumber", 25 "type": "usBankAccountNumber", 26 "optional": false, 27 "displayName": "Account Number", 28 "useAsAccountNumber": true 29 }, 30 { 31 "name": "routingNumber", 32 "type": "usBankRoutingNumber", 33 "optional": false, 34 "displayName": "Routing Number" 35 } 36 ], 37 "estimatedProcessingTime": 0, 38 "createdAt": "2021-01-01T00:00:00Z", 39 "updatedAt": "2021-01-01T00:00:00Z", 40 "maxAmount": 100000, 41 "minAmount": 1 42 }

1	curl -X POST https://api.mercoa.com/paymentMethod/schema \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Wire",
6	"isSource": false,
7	"isDestination": true,
8	"fields": [
9	{
10	"name": "bankName",
11	"type": "text",
12	"optional": false,
13	"displayName": "Bank Name"
14	},
15	{
16	"name": "recipientName",
17	"type": "text",
18	"optional": false,
19	"displayName": "Recipient Name"
20	},
21	{
22	"name": "accountNumber",
23	"type": "usBankAccountNumber",
24	"optional": false,
25	"displayName": "Account Number",
26	"useAsAccountNumber": true
27	},
28	{
29	"name": "routingNumber",
30	"type": "usBankRoutingNumber",
31	"optional": false,
32	"displayName": "Routing Number"
33	}
34	],
35	"supportedCurrencies": [
36	"USD",
37	"EUR"
38	],
39	"estimatedProcessingTime": 0,
40	"maxAmount": 100000,
41	"minAmount": 1
42	}'

1	{
2	"id": "cpms_4794d597-70dc-4fec-b6ec-c5988e759769",
3	"name": "Wire",
4	"isSource": false,
5	"isDestination": true,
6	"supportedCurrencies": [
7	"USD",
8	"EUR"
9	],
10	"fields": [
11	{
12	"name": "bankName",
13	"type": "text",
14	"optional": false,
15	"displayName": "Bank Name"
16	},
17	{
18	"name": "recipientName",
19	"type": "text",
20	"optional": false,
21	"displayName": "Recipient Name"
22	},
23	{
24	"name": "accountNumber",
25	"type": "usBankAccountNumber",
26	"optional": false,
27	"displayName": "Account Number",
28	"useAsAccountNumber": true
29	},
30	{
31	"name": "routingNumber",
32	"type": "usBankRoutingNumber",
33	"optional": false,
34	"displayName": "Routing Number"
35	}
36	],
37	"estimatedProcessingTime": 0,
38	"createdAt": "2021-01-01T00:00:00Z",
39	"updatedAt": "2021-01-01T00:00:00Z",
40	"maxAmount": 100000,
41	"minAmount": 1
42	}