Beta

Create Bulk Entities (Sync)

POST

1 from mercoa import Mercoa
2 from mercoa.commons import Address, PhoneNumber
3 from mercoa.entity_types import (
4     BulkConnectedEntity,
5     BulkEntityCreationFromObject,
6     BusinessProfileRequest,
7     Ein,
8     EntityCreationRequest,
9     ProfileRequest,
10     TaxId,
11 )
12 
13 client = Mercoa(
14     token="YOUR_TOKEN",
15 )
16 client.entity.bulk.create(
17     request=BulkEntityCreationFromObject(
18         connected_entity=BulkConnectedEntity(
19             id="ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced",
20             link_created_as_payor=False,
21             link_created_as_payee=True,
22         ),
23         entities=[
24             EntityCreationRequest(
25                 is_customer=True,
26                 is_payor=True,
27                 is_payee=False,
28                 account_type="business",
29                 foreign_id="MY-DB-ID-12345",
30                 profile=ProfileRequest(
31                     business=BusinessProfileRequest(
32                         email="customer@acme.com",
33                         legal_business_name="Acme Inc.",
34                         website="http://www.acme.com",
35                         business_type="llc",
36                         phone=PhoneNumber(
37                             country_code="1",
38                             number="4155551234",
39                         ),
40                         address=Address(
41                             address_line_1="123 Main St",
42                             address_line_2="Unit 1",
43                             city="San Francisco",
44                             state_or_province="CA",
45                             postal_code="94105",
46                             country="US",
47                         ),
48                         tax_id=TaxId(
49                             ein=Ein(
50                                 number="12-3456789",
51                             ),
52                         ),
53                     ),
54                 ),
55             )
56         ],
57     ),
58 )

Play

200FromObjects

1 {
2   "data": [
3     {
4       "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
5       "foreignId": "YOUR-ENTITY-ID"
6     },
7     {
8       "foreignId": "YOUR-SECOND-ENTITY-ID",
9       "error": "Entity creation failed"
10     }
11   ]
12 }

Create multiple entities in bulk. This endpoint will process synchronously and return a list of entities that were created or failed to create.

Query parameters

emitWebhooksbooleanOptionalDefaults to false

If true, webhooks will be emitted for each entity that is created. By default, webhooks are not emitted.

Request

This endpoint expects an object.

Bulk Entity Creation from ObjectobjectRequired

Response

This endpoint returns an object.

datalist of objects

Create Bulk Entities (Sync)

Headers

Query parameters

Request

Response

Errors