Get Transaction

GET

Get Transaction

Path parameters

transactionIdstringRequired

Response

This endpoint returns an object.

Bank Account to Bank Account

Bank Account to Mailed Check

Custom

Off Platform

GET

1 curl https://api.mercoa.com/transaction/trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4 \
2      -H "Authorization: Bearer <token>"

200ACH_Success

1 {
2   "type": "bankAccountToBankAccount",
3   "createdAt": "2024-01-01T00:00:00Z",
4   "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
5   "invoices": [
6     {
7       "approvalPolicy": [
8         {
9           "id": "apvl_8545a84e-a45f-41bf-bdf1-33b42a55812c",
10           "trigger": [
11             {
12               "type": "amount",
13               "amount": 100,
14               "currency": "USD"
15             }
16           ],
17           "rule": {
18             "type": "approver",
19             "identifierList": {
20               "type": "rolesList",
21               "value": [
22                 "Admin",
23                 "Controller"
24               ]
25             },
26             "numApprovers": 2
27           },
28           "upstreamPolicyId": "root",
29           "createdAt": "2024-01-01T00:00:00Z",
30           "updatedAt": "2024-01-02T00:00:00Z"
31         }
32       ],
33       "approvers": [
34         {
35           "approvalPolicyId": "apvl_5ce50275-1789-42ea-bc60-bb7e6d03635c",
36           "approvalSlotId": "inap_9bb311c9-7c15-4c9e-8148-63814e0abec6",
37           "action": "APPROVE",
38           "eligibleRoles": [
39             "admin"
40           ],
41           "eligibleUserIds": [
42             "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
43           ],
44           "date": "2021-01-01T00:00:00Z",
45           "assignedUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
46         }
47       ],
48       "createdAt": "2021-01-01T00:00:00Z",
49       "hasDocuments": true,
50       "hasSourceEmail": true,
51       "id": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
52       "metadata": {
53         "key1": "value1",
54         "key2": "value2"
55       },
56       "paymentDestinationConfirmed": true,
57       "status": "PAID",
58       "updatedAt": "2021-01-01T00:00:00Z",
59       "amount": 100,
60       "comments": [
61         {
62           "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
63           "text": "This is an approval comment",
64           "createdAt": "2021-01-01T00:00:00Z",
65           "updatedAt": "2021-01-01T00:00:00Z",
66           "user": {
67             "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
68             "roles": [
69               "admin",
70               "approver"
71             ],
72             "createdAt": "2024-01-01T00:00:00Z",
73             "updatedAt": "2024-01-01T00:00:00Z",
74             "foreignId": "MY-DB-ID-12345",
75             "email": "john.doe@acme.com",
76             "name": "John Doe"
77           },
78           "associatedApprovalAction": {
79             "userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
80             "action": "APPROVE"
81           }
82         }
83       ],
84       "creatorUser": {
85         "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
86         "roles": [
87           "admin",
88           "approver"
89         ],
90         "createdAt": "2024-01-01T00:00:00Z",
91         "updatedAt": "2024-01-01T00:00:00Z",
92         "foreignId": "MY-DB-ID-12345",
93         "email": "john.doe@acme.com",
94         "name": "John Doe"
95       },
96       "currency": "USD",
97       "deductionDate": "2021-01-01T00:00:00Z",
98       "dueDate": "2021-01-31T00:00:00Z",
99       "foreignId": "YOUR-DATABASE-ID",
100       "invoiceDate": "2021-01-01T00:00:00Z",
101       "invoiceNumber": "INV-123",
102       "lineItems": [
103         {
104           "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
105           "currency": "USD",
106           "category": "EXPENSE",
107           "createdAt": "2021-01-01T00:00:00Z",
108           "updatedAt": "2021-01-01T00:00:00Z",
109           "amount": 100,
110           "description": "Product A",
111           "name": "Product A",
112           "quantity": 1,
113           "unitPrice": 100,
114           "serviceStartDate": "2021-01-01T00:00:00Z",
115           "serviceEndDate": "2021-01-31T00:00:00Z",
116           "metadata": {
117             "key1": "value1",
118             "key2": "value2"
119           },
120           "glAccountId": "600394"
121         }
122       ],
123       "noteToSelf": "For the month of January",
124       "payer": {
125         "acceptedTos": true,
126         "accountType": "business",
127         "createdAt": "2024-01-01T00:00:00Z",
128         "email": "customer@acme.com",
129         "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
130         "isCustomer": true,
131         "isNetworkPayee": false,
132         "isNetworkPayor": false,
133         "isPayee": false,
134         "isPayor": true,
135         "name": "Acme Inc.",
136         "profile": {
137           "business": {
138             "legalBusinessName": "Acme Inc.",
139             "taxIDProvided": true,
140             "email": "customer@acme.com",
141             "businessType": "llc",
142             "phone": {
143               "countryCode": "1",
144               "number": "4155551234"
145             },
146             "address": {
147               "addressLine1": "123 Main St",
148               "city": "San Francisco",
149               "stateOrProvince": "CA",
150               "postalCode": "94105",
151               "addressLine2": "Unit 1",
152               "country": "US"
153             },
154             "ownersProvided": true,
155             "taxId": {
156               "ein": {
157                 "number": "12-3456789"
158               }
159             }
160           }
161         },
162         "status": "verified",
163         "updatedAt": "2024-01-02T00:00:00Z",
164         "accounts": [
165           {
166             "accountId": "85866843",
167             "postalCode": "94105",
168             "nameOnAccount": "John Doe"
169           }
170         ],
171         "counterpartyType": [
172           "ENTITY"
173         ],
174         "foreignId": "MY-DB-ID-12345",
175         "paymentMethods": [
176           {
177             "type": "bankAccount",
178             "accountName": "My Checking Account",
179             "accountNumber": "99988767623",
180             "accountType": "CHECKING",
181             "bankName": "Chase",
182             "createdAt": "2021-01-01T00:00:00Z",
183             "frozen": false,
184             "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
185             "isDefaultDestination": true,
186             "isDefaultSource": true,
187             "metadata": {},
188             "routingNumber": "12345678",
189             "status": "VERIFIED",
190             "supportedCurrencies": [
191               "USD"
192             ],
193             "updatedAt": "2021-01-01T00:00:00Z"
194           }
195         ]
196       },
197       "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
198       "paymentDestination": {
199         "type": "check",
200         "addressLine1": "123 Main St",
201         "city": "New York",
202         "country": "US",
203         "createdAt": "2021-01-01T00:00:00Z",
204         "frozen": false,
205         "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
206         "isDefaultDestination": true,
207         "isDefaultSource": false,
208         "metadata": {},
209         "payToTheOrderOf": "John Doe",
210         "postalCode": "10001",
211         "stateOrProvince": "NY",
212         "supportedCurrencies": [
213           "USD"
214         ],
215         "updatedAt": "2021-01-01T00:00:00Z",
216         "addressLine2": "Apt 1"
217       },
218       "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
219       "paymentDestinationOptions": {
220         "type": "check",
221         "delivery": "MAIL",
222         "printDescription": true
223       },
224       "paymentSource": {
225         "type": "bankAccount",
226         "accountName": "My Checking Account",
227         "accountNumber": "99988767623",
228         "accountType": "CHECKING",
229         "bankName": "Chase",
230         "createdAt": "2021-01-01T00:00:00Z",
231         "frozen": false,
232         "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
233         "isDefaultDestination": true,
234         "isDefaultSource": true,
235         "metadata": {},
236         "routingNumber": "12345678",
237         "status": "VERIFIED",
238         "supportedCurrencies": [
239           "USD"
240         ],
241         "updatedAt": "2021-01-01T00:00:00Z"
242       },
243       "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
244       "processedAt": "2021-01-01T00:00:00Z",
245       "serviceEndDate": "2021-01-31T00:00:00Z",
246       "serviceStartDate": "2021-01-01T00:00:00Z",
247       "settlementDate": "2021-01-03T00:00:00Z",
248       "vendor": {
249         "acceptedTos": false,
250         "accountType": "business",
251         "createdAt": "2024-01-01T00:00:00Z",
252         "email": "vendor@bigboxstore.com",
253         "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
254         "isCustomer": false,
255         "isNetworkPayee": false,
256         "isNetworkPayor": false,
257         "isPayee": true,
258         "isPayor": false,
259         "name": "Big Box Store",
260         "profile": {
261           "business": {
262             "legalBusinessName": "Big Box Store",
263             "taxIDProvided": false,
264             "email": "vendor@bigboxstore.com",
265             "businessType": "publicCorporation",
266             "ownersProvided": false
267           }
268         },
269         "status": "unverified",
270         "updatedAt": "2024-01-02T00:00:00Z",
271         "counterpartyType": [
272           "ENTITY"
273         ],
274         "foreignId": "MY-DB-ID-90909",
275         "paymentMethods": [
276           {
277             "type": "bankAccount",
278             "accountName": "Vendor Checking Account",
279             "accountNumber": "55934059697648",
280             "accountType": "CHECKING",
281             "bankName": "Chase",
282             "createdAt": "2021-01-01T00:00:00Z",
283             "frozen": false,
284             "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
285             "isDefaultDestination": true,
286             "isDefaultSource": true,
287             "metadata": {},
288             "routingNumber": "66554433",
289             "status": "NEW",
290             "supportedCurrencies": [
291               "USD"
292             ],
293             "updatedAt": "2021-01-01T00:00:00Z"
294           }
295         ]
296       },
297       "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
298     }
299   ],
300   "status": "COMPLETED",
301   "updatedAt": "2024-01-01T00:00:00Z"
302 }

Counterparty Added

Up Next

Built with

1	curl https://api.mercoa.com/transaction/trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4 \
2	-H "Authorization: Bearer <token>"

1	{
2	"type": "bankAccountToBankAccount",
3	"createdAt": "2024-01-01T00:00:00Z",
4	"id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
5	"invoices": [
6	{
7	"approvalPolicy": [
8	{
9	"id": "apvl_8545a84e-a45f-41bf-bdf1-33b42a55812c",
10	"trigger": [
11	{
12	"type": "amount",
13	"amount": 100,
14	"currency": "USD"
15	}
16	],
17	"rule": {
18	"type": "approver",
19	"identifierList": {
20	"type": "rolesList",
21	"value": [
22	"Admin",
23	"Controller"
24	]
25	},
26	"numApprovers": 2
27	},
28	"upstreamPolicyId": "root",
29	"createdAt": "2024-01-01T00:00:00Z",
30	"updatedAt": "2024-01-02T00:00:00Z"
31	}
32	],
33	"approvers": [
34	{
35	"approvalPolicyId": "apvl_5ce50275-1789-42ea-bc60-bb7e6d03635c",
36	"approvalSlotId": "inap_9bb311c9-7c15-4c9e-8148-63814e0abec6",
37	"action": "APPROVE",
38	"eligibleRoles": [
39	"admin"
40	],
41	"eligibleUserIds": [
42	"user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
43	],
44	"date": "2021-01-01T00:00:00Z",
45	"assignedUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
46	}
47	],
48	"createdAt": "2021-01-01T00:00:00Z",
49	"hasDocuments": true,
50	"hasSourceEmail": true,
51	"id": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
52	"metadata": {
53	"key1": "value1",
54	"key2": "value2"
55	},
56	"paymentDestinationConfirmed": true,
57	"status": "PAID",
58	"updatedAt": "2021-01-01T00:00:00Z",
59	"amount": 100,
60	"comments": [
61	{
62	"id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
63	"text": "This is an approval comment",
64	"createdAt": "2021-01-01T00:00:00Z",
65	"updatedAt": "2021-01-01T00:00:00Z",
66	"user": {
67	"id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
68	"roles": [
69	"admin",
70	"approver"
71	],
72	"createdAt": "2024-01-01T00:00:00Z",
73	"updatedAt": "2024-01-01T00:00:00Z",
74	"foreignId": "MY-DB-ID-12345",
75	"email": "john.doe@acme.com",
76	"name": "John Doe"
77	},
78	"associatedApprovalAction": {
79	"userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
80	"action": "APPROVE"
81	}
82	}
83	],
84	"creatorUser": {
85	"id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
86	"roles": [
87	"admin",
88	"approver"
89	],
90	"createdAt": "2024-01-01T00:00:00Z",
91	"updatedAt": "2024-01-01T00:00:00Z",
92	"foreignId": "MY-DB-ID-12345",
93	"email": "john.doe@acme.com",
94	"name": "John Doe"
95	},
96	"currency": "USD",
97	"deductionDate": "2021-01-01T00:00:00Z",
98	"dueDate": "2021-01-31T00:00:00Z",
99	"foreignId": "YOUR-DATABASE-ID",
100	"invoiceDate": "2021-01-01T00:00:00Z",
101	"invoiceNumber": "INV-123",
102	"lineItems": [
103	{
104	"id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
105	"currency": "USD",
106	"category": "EXPENSE",
107	"createdAt": "2021-01-01T00:00:00Z",
108	"updatedAt": "2021-01-01T00:00:00Z",
109	"amount": 100,
110	"description": "Product A",
111	"name": "Product A",
112	"quantity": 1,
113	"unitPrice": 100,
114	"serviceStartDate": "2021-01-01T00:00:00Z",
115	"serviceEndDate": "2021-01-31T00:00:00Z",
116	"metadata": {
117	"key1": "value1",
118	"key2": "value2"
119	},
120	"glAccountId": "600394"
121	}
122	],
123	"noteToSelf": "For the month of January",
124	"payer": {
125	"acceptedTos": true,
126	"accountType": "business",
127	"createdAt": "2024-01-01T00:00:00Z",
128	"email": "customer@acme.com",
129	"id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
130	"isCustomer": true,
131	"isNetworkPayee": false,
132	"isNetworkPayor": false,
133	"isPayee": false,
134	"isPayor": true,
135	"name": "Acme Inc.",
136	"profile": {
137	"business": {
138	"legalBusinessName": "Acme Inc.",
139	"taxIDProvided": true,
140	"email": "customer@acme.com",
141	"businessType": "llc",
142	"phone": {
143	"countryCode": "1",
144	"number": "4155551234"
145	},
146	"address": {
147	"addressLine1": "123 Main St",
148	"city": "San Francisco",
149	"stateOrProvince": "CA",
150	"postalCode": "94105",
151	"addressLine2": "Unit 1",
152	"country": "US"
153	},
154	"ownersProvided": true,
155	"taxId": {
156	"ein": {
157	"number": "12-3456789"
158	}
159	}
160	}
161	},
162	"status": "verified",
163	"updatedAt": "2024-01-02T00:00:00Z",
164	"accounts": [
165	{
166	"accountId": "85866843",
167	"postalCode": "94105",
168	"nameOnAccount": "John Doe"
169	}
170	],
171	"counterpartyType": [
172	"ENTITY"
173	],
174	"foreignId": "MY-DB-ID-12345",
175	"paymentMethods": [
176	{
177	"type": "bankAccount",
178	"accountName": "My Checking Account",
179	"accountNumber": "99988767623",
180	"accountType": "CHECKING",
181	"bankName": "Chase",
182	"createdAt": "2021-01-01T00:00:00Z",
183	"frozen": false,
184	"id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
185	"isDefaultDestination": true,
186	"isDefaultSource": true,
187	"metadata": {},
188	"routingNumber": "12345678",
189	"status": "VERIFIED",
190	"supportedCurrencies": [
191	"USD"
192	],
193	"updatedAt": "2021-01-01T00:00:00Z"
194	}
195	]
196	},
197	"payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
198	"paymentDestination": {
199	"type": "check",
200	"addressLine1": "123 Main St",
201	"city": "New York",
202	"country": "US",
203	"createdAt": "2021-01-01T00:00:00Z",
204	"frozen": false,
205	"id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
206	"isDefaultDestination": true,
207	"isDefaultSource": false,
208	"metadata": {},
209	"payToTheOrderOf": "John Doe",
210	"postalCode": "10001",
211	"stateOrProvince": "NY",
212	"supportedCurrencies": [
213	"USD"
214	],
215	"updatedAt": "2021-01-01T00:00:00Z",
216	"addressLine2": "Apt 1"
217	},
218	"paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
219	"paymentDestinationOptions": {
220	"type": "check",
221	"delivery": "MAIL",
222	"printDescription": true
223	},
224	"paymentSource": {
225	"type": "bankAccount",
226	"accountName": "My Checking Account",
227	"accountNumber": "99988767623",
228	"accountType": "CHECKING",
229	"bankName": "Chase",
230	"createdAt": "2021-01-01T00:00:00Z",
231	"frozen": false,
232	"id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
233	"isDefaultDestination": true,
234	"isDefaultSource": true,
235	"metadata": {},
236	"routingNumber": "12345678",
237	"status": "VERIFIED",
238	"supportedCurrencies": [
239	"USD"
240	],
241	"updatedAt": "2021-01-01T00:00:00Z"
242	},
243	"paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
244	"processedAt": "2021-01-01T00:00:00Z",
245	"serviceEndDate": "2021-01-31T00:00:00Z",
246	"serviceStartDate": "2021-01-01T00:00:00Z",
247	"settlementDate": "2021-01-03T00:00:00Z",
248	"vendor": {
249	"acceptedTos": false,
250	"accountType": "business",
251	"createdAt": "2024-01-01T00:00:00Z",
252	"email": "vendor@bigboxstore.com",
253	"id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
254	"isCustomer": false,
255	"isNetworkPayee": false,
256	"isNetworkPayor": false,
257	"isPayee": true,
258	"isPayor": false,
259	"name": "Big Box Store",
260	"profile": {
261	"business": {
262	"legalBusinessName": "Big Box Store",
263	"taxIDProvided": false,
264	"email": "vendor@bigboxstore.com",
265	"businessType": "publicCorporation",
266	"ownersProvided": false
267	}
268	},
269	"status": "unverified",
270	"updatedAt": "2024-01-02T00:00:00Z",
271	"counterpartyType": [
272	"ENTITY"
273	],
274	"foreignId": "MY-DB-ID-90909",
275	"paymentMethods": [
276	{
277	"type": "bankAccount",
278	"accountName": "Vendor Checking Account",
279	"accountNumber": "55934059697648",
280	"accountType": "CHECKING",
281	"bankName": "Chase",
282	"createdAt": "2021-01-01T00:00:00Z",
283	"frozen": false,
284	"id": "pm_7610541f-4619-4033-8620-cfccfb811293",
285	"isDefaultDestination": true,
286	"isDefaultSource": true,
287	"metadata": {},
288	"routingNumber": "66554433",
289	"status": "NEW",
290	"supportedCurrencies": [
291	"USD"
292	],
293	"updatedAt": "2021-01-01T00:00:00Z"
294	}
295	]
296	},
297	"vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
298	}
299	],
300	"status": "COMPLETED",
301	"updatedAt": "2024-01-01T00:00:00Z"
302	}