API ReferenceEntityCustomization

Update

POST

Update entity customization. This lets you turn off metadata and payment methods for an entity.

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

Request

This endpoint expects an object.

metadata

list of objectsRequired

paymentSource

list of objectsRequired

backupDisbursement

list of objectsRequired

paymentDestination

list of objectsRequired

Response

This endpoint returns an object

metadata

list of objects

paymentSource

list of objects

backupDisbursement

list of objects

paymentDestination

list of objects

POST

1 curl -X POST https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced/customization \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "metadata": [
6     {
7       "key": "my_custom_field",
8       "disabled": true
9     },
10     {
11       "key": "my_other_field",
12       "disabled": false
13     }
14   ],
15   "paymentSource": [
16     {
17       "type": "bankAccount",
18       "disabled": true
19     },
20     {
21       "type": "custom",
22       "disabled": true,
23       "schemaId": "cpms_7df2974a-4069-454c-912f-7e58ebe030fb"
24     }
25   ],
26   "backupDisbursement": [
27     {
28       "type": "check",
29       "disabled": true
30     }
31   ],
32   "paymentDestination": [
33     {
34       "type": "bankAccount",
35       "disabled": true
36     },
37     {
38       "type": "check",
39       "disabled": true
40     }
41   ]
42 }'

200Successful

1 {
2   "metadata": [
3     {
4       "key": "my_custom_field",
5       "disabled": true
6     },
7     {
8       "key": "my_other_field",
9       "disabled": false
10     }
11   ],
12   "paymentSource": [
13     {
14       "type": "bankAccount",
15       "disabled": true
16     },
17     {
18       "type": "custom",
19       "disabled": true,
20       "schemaId": "cpms_7df2974a-4069-454c-912f-7e58ebe030fb"
21     }
22   ],
23   "backupDisbursement": [
24     {
25       "type": "check",
26       "disabled": true
27     }
28   ],
29   "paymentDestination": [
30     {
31       "type": "bankAccount",
32       "disabled": true
33     },
34     {
35       "type": "check",
36       "disabled": true
37     }
38   ]
39 }

Built with

1	curl -X POST https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced/customization \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"metadata": [
6	{
7	"key": "my_custom_field",
8	"disabled": true
9	},
10	{
11	"key": "my_other_field",
12	"disabled": false
13	}
14	],
15	"paymentSource": [
16	{
17	"type": "bankAccount",
18	"disabled": true
19	},
20	{
21	"type": "custom",
22	"disabled": true,
23	"schemaId": "cpms_7df2974a-4069-454c-912f-7e58ebe030fb"
24	}
25	],
26	"backupDisbursement": [
27	{
28	"type": "check",
29	"disabled": true
30	}
31	],
32	"paymentDestination": [
33	{
34	"type": "bankAccount",
35	"disabled": true
36	},
37	{
38	"type": "check",
39	"disabled": true
40	}
41	]
42	}'