Get Transaction

GET

https://api.mercoa.com/transaction/:transactionId

GET

/transaction/:transactionId

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

Try it

1 {
2   "type": "bankAccountToBankAccount",
3   "amount": 10000,
4   "createdAt": "2024-01-01T00:00:00Z",
5   "currency": "USD",
6   "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
7   "invoices": [
8     {
9       "approvalPolicy": [
10         {
11           "id": "apvl_8545a84e-a45f-41bf-bdf1-33b42a55812c",
12           "trigger": [
13             {
14               "type": "amount",
15               "amount": 100,
16               "currency": "USD"
17             }
18           ],
19           "rule": {
20             "type": "approver",
21             "identifierList": {
22               "type": "rolesList",
23               "value": [
24                 "Admin",
25                 "Controller"
26               ]
27             },
28             "numApprovers": 2
29           },
30           "upstreamPolicyId": "root",
31           "createdAt": "2024-01-01T00:00:00Z",
32           "updatedAt": "2024-01-02T00:00:00Z"
33         }
34       ],
35       "approvers": [
36         {
37           "approvalPolicyId": "apvl_5ce50275-1789-42ea-bc60-bb7e6d03635c",
38           "approvalSlotId": "inap_9bb311c9-7c15-4c9e-8148-63814e0abec6",
39           "action": "APPROVE",
40           "eligibleRoles": [
41             "admin"
42           ],
43           "eligibleUserIds": [
44             "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
45           ],
46           "date": "2021-01-01T00:00:00Z",
47           "assignedUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
48         }
49       ],
50       "createdAt": "2021-01-01T00:00:00Z",
51       "hasDocuments": true,
52       "hasSourceEmail": true,
53       "id": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
54       "metadata": {
55         "key1": "value1",
56         "key2": "value2"
57       },
58       "paymentDestinationConfirmed": true,
59       "status": "PAID",
60       "updatedAt": "2021-01-01T00:00:00Z",
61       "amount": 100,
62       "comments": [
63         {
64           "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
65           "text": "This is an approval comment",
66           "createdAt": "2021-01-01T00:00:00Z",
67           "updatedAt": "2021-01-01T00:00:00Z",
68           "user": {
69             "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
70             "roles": [
71               "admin",
72               "approver"
73             ],
74             "createdAt": "2024-01-01T00:00:00Z",
75             "updatedAt": "2024-01-01T00:00:00Z",
76             "foreignId": "MY-DB-ID-12345",
77             "email": "john.doe@acme.com",
78             "name": "John Doe"
79           },
80           "associatedApprovalAction": {
81             "userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
82             "action": "APPROVE"
83           }
84         }
85       ],
86       "creatorUser": {
87         "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
88         "roles": [
89           "admin",
90           "approver"
91         ],
92         "createdAt": "2024-01-01T00:00:00Z",
93         "updatedAt": "2024-01-01T00:00:00Z",
94         "foreignId": "MY-DB-ID-12345",
95         "email": "john.doe@acme.com",
96         "name": "John Doe"
97       },
98       "currency": "USD",
99       "deductionDate": "2021-01-01T00:00:00Z",
100       "dueDate": "2021-01-31T00:00:00Z",
101       "foreignId": "YOUR-DATABASE-ID",
102       "invoiceDate": "2021-01-01T00:00:00Z",
103       "invoiceNumber": "INV-123",
104       "lineItems": [
105         {
106           "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
107           "currency": "USD",
108           "category": "EXPENSE",
109           "createdAt": "2021-01-01T00:00:00Z",
110           "updatedAt": "2021-01-01T00:00:00Z",
111           "amount": 100,
112           "description": "Product A",
113           "name": "Product A",
114           "quantity": 1,
115           "unitPrice": 100,
116           "serviceStartDate": "2021-01-01T00:00:00Z",
117           "serviceEndDate": "2021-01-31T00:00:00Z",
118           "metadata": {
119             "key1": "value1",
120             "key2": "value2"
121           },
122           "glAccountId": "600394"
123         }
124       ],
125       "noteToSelf": "For the month of January",
126       "payer": {
127         "acceptedTos": true,
128         "accountType": "business",
129         "createdAt": "2024-01-01T00:00:00Z",
130         "email": "customer@acme.com",
131         "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
132         "isCustomer": true,
133         "isNetworkPayee": false,
134         "isNetworkPayor": false,
135         "isPayee": false,
136         "isPayor": true,
137         "name": "Acme Inc.",
138         "profile": {
139           "business": {
140             "legalBusinessName": "Acme Inc.",
141             "taxIDProvided": true,
142             "email": "customer@acme.com",
143             "businessType": "llc",
144             "phone": {
145               "countryCode": "1",
146               "number": "4155551234"
147             },
148             "address": {
149               "addressLine1": "123 Main St",
150               "city": "San Francisco",
151               "stateOrProvince": "CA",
152               "postalCode": "94105",
153               "addressLine2": "Unit 1",
154               "country": "US"
155             },
156             "ownersProvided": true,
157             "taxId": {
158               "ein": {
159                 "number": "12-3456789"
160               }
161             }
162           }
163         },
164         "status": "verified",
165         "updatedAt": "2024-01-02T00:00:00Z",
166         "accounts": [
167           {
168             "accountId": "85866843",
169             "postalCode": "94105",
170             "nameOnAccount": "John Doe"
171           }
172         ],
173         "counterpartyType": [
174           "ENTITY"
175         ],
176         "foreignId": "MY-DB-ID-12345",
177         "paymentMethods": [
178           {
179             "type": "bankAccount",
180             "accountName": "My Checking Account",
181             "accountNumber": "99988767623",
182             "accountType": "CHECKING",
183             "bankName": "Chase",
184             "createdAt": "2021-01-01T00:00:00Z",
185             "frozen": false,
186             "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
187             "isDefaultDestination": true,
188             "isDefaultSource": true,
189             "metadata": {},
190             "routingNumber": "12345678",
191             "status": "VERIFIED",
192             "supportedCurrencies": [
193               "USD"
194             ],
195             "updatedAt": "2021-01-01T00:00:00Z",
196             "confirmedByEntity": true
197           }
198         ]
199       },
200       "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
201       "paymentDestination": {
202         "type": "check",
203         "addressLine1": "123 Main St",
204         "city": "New York",
205         "country": "US",
206         "createdAt": "2021-01-01T00:00:00Z",
207         "frozen": false,
208         "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
209         "isDefaultDestination": true,
210         "isDefaultSource": false,
211         "metadata": {},
212         "payToTheOrderOf": "John Doe",
213         "postalCode": "10001",
214         "stateOrProvince": "NY",
215         "supportedCurrencies": [
216           "USD"
217         ],
218         "updatedAt": "2021-01-01T00:00:00Z",
219         "addressLine2": "Apt 1",
220         "confirmedByEntity": true
221       },
222       "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
223       "paymentDestinationOptions": {
224         "type": "check",
225         "delivery": "MAIL",
226         "printDescription": true
227       },
228       "paymentSource": {
229         "type": "bankAccount",
230         "accountName": "My Checking Account",
231         "accountNumber": "99988767623",
232         "accountType": "CHECKING",
233         "bankName": "Chase",
234         "createdAt": "2021-01-01T00:00:00Z",
235         "frozen": false,
236         "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
237         "isDefaultDestination": true,
238         "isDefaultSource": true,
239         "metadata": {},
240         "routingNumber": "12345678",
241         "status": "VERIFIED",
242         "supportedCurrencies": [
243           "USD"
244         ],
245         "updatedAt": "2021-01-01T00:00:00Z",
246         "confirmedByEntity": true
247       },
248       "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
249       "processedAt": "2021-01-01T00:00:00Z",
250       "serviceEndDate": "2021-01-31T00:00:00Z",
251       "serviceStartDate": "2021-01-01T00:00:00Z",
252       "settlementDate": "2021-01-03T00:00:00Z",
253       "transactions": [
254         {
255           "type": "bankAccountToBankAccount",
256           "amount": 10000,
257           "createdAt": "2024-01-01T00:00:00Z",
258           "currency": "USD",
259           "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
260           "payer": {
261             "acceptedTos": true,
262             "accountType": "business",
263             "createdAt": "2024-01-01T00:00:00Z",
264             "email": "customer@acme.com",
265             "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
266             "isCustomer": true,
267             "isNetworkPayee": false,
268             "isNetworkPayor": false,
269             "isPayee": false,
270             "isPayor": true,
271             "name": "Acme Inc.",
272             "profile": {
273               "business": {
274                 "legalBusinessName": "Acme Inc.",
275                 "taxIDProvided": true,
276                 "email": "customer@acme.com",
277                 "businessType": "llc",
278                 "phone": {
279                   "countryCode": "1",
280                   "number": "4155551234"
281                 },
282                 "address": {
283                   "addressLine1": "123 Main St",
284                   "city": "San Francisco",
285                   "stateOrProvince": "CA",
286                   "postalCode": "94105",
287                   "addressLine2": "Unit 1",
288                   "country": "US"
289                 },
290                 "ownersProvided": true,
291                 "taxId": {
292                   "ein": {
293                     "number": "12-3456789"
294                   }
295                 }
296               }
297             },
298             "status": "verified",
299             "updatedAt": "2024-01-02T00:00:00Z",
300             "accounts": [
301               {
302                 "accountId": "85866843",
303                 "postalCode": "94105",
304                 "nameOnAccount": "John Doe"
305               }
306             ],
307             "counterpartyType": [
308               "ENTITY"
309             ],
310             "foreignId": "MY-DB-ID-12345",
311             "paymentMethods": [
312               {
313                 "type": "bankAccount",
314                 "accountName": "My Checking Account",
315                 "accountNumber": "99988767623",
316                 "accountType": "CHECKING",
317                 "bankName": "Chase",
318                 "createdAt": "2021-01-01T00:00:00Z",
319                 "frozen": false,
320                 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
321                 "isDefaultDestination": true,
322                 "isDefaultSource": true,
323                 "metadata": {},
324                 "routingNumber": "12345678",
325                 "status": "VERIFIED",
326                 "supportedCurrencies": [
327                   "USD"
328                 ],
329                 "updatedAt": "2021-01-01T00:00:00Z",
330                 "confirmedByEntity": true
331               }
332             ]
333           },
334           "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
335           "paymentDestination": {
336             "type": "bankAccount",
337             "accountName": "My Checking Account",
338             "accountNumber": "99988767623",
339             "accountType": "CHECKING",
340             "bankName": "Chase",
341             "createdAt": "2021-01-01T00:00:00Z",
342             "frozen": false,
343             "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
344             "isDefaultDestination": true,
345             "isDefaultSource": true,
346             "metadata": {},
347             "routingNumber": "12345678",
348             "status": "VERIFIED",
349             "supportedCurrencies": [
350               "USD"
351             ],
352             "updatedAt": "2021-01-01T00:00:00Z",
353             "confirmedByEntity": true
354           },
355           "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
356           "paymentSource": {
357             "type": "bankAccount",
358             "accountName": "My Checking Account",
359             "accountNumber": "99988767623",
360             "accountType": "CHECKING",
361             "bankName": "Chase",
362             "createdAt": "2021-01-01T00:00:00Z",
363             "frozen": false,
364             "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
365             "isDefaultDestination": true,
366             "isDefaultSource": true,
367             "metadata": {},
368             "routingNumber": "12345678",
369             "status": "VERIFIED",
370             "supportedCurrencies": [
371               "USD"
372             ],
373             "updatedAt": "2021-01-01T00:00:00Z",
374             "confirmedByEntity": true
375           },
376           "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
377           "status": "COMPLETED",
378           "updatedAt": "2024-01-01T00:00:00Z",
379           "vendor": {
380             "acceptedTos": false,
381             "accountType": "business",
382             "createdAt": "2024-01-01T00:00:00Z",
383             "email": "vendor@bigboxstore.com",
384             "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
385             "isCustomer": false,
386             "isNetworkPayee": false,
387             "isNetworkPayor": false,
388             "isPayee": true,
389             "isPayor": false,
390             "name": "Big Box Store",
391             "profile": {
392               "business": {
393                 "legalBusinessName": "Big Box Store",
394                 "taxIDProvided": false,
395                 "email": "vendor@bigboxstore.com",
396                 "businessType": "publicCorporation",
397                 "ownersProvided": false
398               }
399             },
400             "status": "unverified",
401             "updatedAt": "2024-01-02T00:00:00Z",
402             "counterpartyType": [
403               "ENTITY"
404             ],
405             "foreignId": "MY-DB-ID-90909",
406             "paymentMethods": [
407               {
408                 "type": "bankAccount",
409                 "accountName": "Vendor Checking Account",
410                 "accountNumber": "55934059697648",
411                 "accountType": "CHECKING",
412                 "bankName": "Chase",
413                 "createdAt": "2021-01-01T00:00:00Z",
414                 "frozen": false,
415                 "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
416                 "isDefaultDestination": true,
417                 "isDefaultSource": true,
418                 "metadata": {},
419                 "routingNumber": "66554433",
420                 "status": "NEW",
421                 "supportedCurrencies": [
422                   "USD"
423                 ],
424                 "updatedAt": "2021-01-01T00:00:00Z",
425                 "confirmedByEntity": false
426               }
427             ]
428           },
429           "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
430         }
431       ],
432       "vendor": {
433         "acceptedTos": false,
434         "accountType": "business",
435         "createdAt": "2024-01-01T00:00:00Z",
436         "email": "vendor@bigboxstore.com",
437         "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
438         "isCustomer": false,
439         "isNetworkPayee": false,
440         "isNetworkPayor": false,
441         "isPayee": true,
442         "isPayor": false,
443         "name": "Big Box Store",
444         "profile": {
445           "business": {
446             "legalBusinessName": "Big Box Store",
447             "taxIDProvided": false,
448             "email": "vendor@bigboxstore.com",
449             "businessType": "publicCorporation",
450             "ownersProvided": false
451           }
452         },
453         "status": "unverified",
454         "updatedAt": "2024-01-02T00:00:00Z",
455         "counterpartyType": [
456           "ENTITY"
457         ],
458         "foreignId": "MY-DB-ID-90909",
459         "paymentMethods": [
460           {
461             "type": "bankAccount",
462             "accountName": "Vendor Checking Account",
463             "accountNumber": "55934059697648",
464             "accountType": "CHECKING",
465             "bankName": "Chase",
466             "createdAt": "2021-01-01T00:00:00Z",
467             "frozen": false,
468             "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
469             "isDefaultDestination": true,
470             "isDefaultSource": true,
471             "metadata": {},
472             "routingNumber": "66554433",
473             "status": "NEW",
474             "supportedCurrencies": [
475               "USD"
476             ],
477             "updatedAt": "2021-01-01T00:00:00Z",
478             "confirmedByEntity": false
479           }
480         ]
481       },
482       "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
483     }
484   ],
485   "payer": {
486     "acceptedTos": true,
487     "accountType": "business",
488     "createdAt": "2024-01-01T00:00:00Z",
489     "email": "customer@acme.com",
490     "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
491     "isCustomer": true,
492     "isNetworkPayee": false,
493     "isNetworkPayor": false,
494     "isPayee": false,
495     "isPayor": true,
496     "name": "Acme Inc.",
497     "profile": {
498       "business": {
499         "legalBusinessName": "Acme Inc.",
500         "taxIDProvided": true,
501         "email": "customer@acme.com",
502         "businessType": "llc",
503         "phone": {
504           "countryCode": "1",
505           "number": "4155551234"
506         },
507         "address": {
508           "addressLine1": "123 Main St",
509           "city": "San Francisco",
510           "stateOrProvince": "CA",
511           "postalCode": "94105",
512           "addressLine2": "Unit 1",
513           "country": "US"
514         },
515         "ownersProvided": true,
516         "taxId": {
517           "ein": {
518             "number": "12-3456789"
519           }
520         }
521       }
522     },
523     "status": "verified",
524     "updatedAt": "2024-01-02T00:00:00Z",
525     "accounts": [
526       {
527         "accountId": "85866843",
528         "postalCode": "94105",
529         "nameOnAccount": "John Doe"
530       }
531     ],
532     "counterpartyType": [
533       "ENTITY"
534     ],
535     "foreignId": "MY-DB-ID-12345",
536     "paymentMethods": [
537       {
538         "type": "bankAccount",
539         "accountName": "My Checking Account",
540         "accountNumber": "99988767623",
541         "accountType": "CHECKING",
542         "bankName": "Chase",
543         "createdAt": "2021-01-01T00:00:00Z",
544         "frozen": false,
545         "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
546         "isDefaultDestination": true,
547         "isDefaultSource": true,
548         "metadata": {},
549         "routingNumber": "12345678",
550         "status": "VERIFIED",
551         "supportedCurrencies": [
552           "USD"
553         ],
554         "updatedAt": "2021-01-01T00:00:00Z",
555         "confirmedByEntity": true
556       }
557     ]
558   },
559   "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
560   "paymentDestination": {
561     "type": "bankAccount",
562     "accountName": "My Checking Account",
563     "accountNumber": "99988767623",
564     "accountType": "CHECKING",
565     "bankName": "Chase",
566     "createdAt": "2021-01-01T00:00:00Z",
567     "frozen": false,
568     "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
569     "isDefaultDestination": true,
570     "isDefaultSource": true,
571     "metadata": {},
572     "routingNumber": "12345678",
573     "status": "VERIFIED",
574     "supportedCurrencies": [
575       "USD"
576     ],
577     "updatedAt": "2021-01-01T00:00:00Z",
578     "confirmedByEntity": true
579   },
580   "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
581   "paymentSource": {
582     "type": "bankAccount",
583     "accountName": "My Checking Account",
584     "accountNumber": "99988767623",
585     "accountType": "CHECKING",
586     "bankName": "Chase",
587     "createdAt": "2021-01-01T00:00:00Z",
588     "frozen": false,
589     "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
590     "isDefaultDestination": true,
591     "isDefaultSource": true,
592     "metadata": {},
593     "routingNumber": "12345678",
594     "status": "VERIFIED",
595     "supportedCurrencies": [
596       "USD"
597     ],
598     "updatedAt": "2021-01-01T00:00:00Z",
599     "confirmedByEntity": true
600   },
601   "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
602   "status": "COMPLETED",
603   "updatedAt": "2024-01-01T00:00:00Z",
604   "vendor": {
605     "acceptedTos": false,
606     "accountType": "business",
607     "createdAt": "2024-01-01T00:00:00Z",
608     "email": "vendor@bigboxstore.com",
609     "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
610     "isCustomer": false,
611     "isNetworkPayee": false,
612     "isNetworkPayor": false,
613     "isPayee": true,
614     "isPayor": false,
615     "name": "Big Box Store",
616     "profile": {
617       "business": {
618         "legalBusinessName": "Big Box Store",
619         "taxIDProvided": false,
620         "email": "vendor@bigboxstore.com",
621         "businessType": "publicCorporation",
622         "ownersProvided": false
623       }
624     },
625     "status": "unverified",
626     "updatedAt": "2024-01-02T00:00:00Z",
627     "counterpartyType": [
628       "ENTITY"
629     ],
630     "foreignId": "MY-DB-ID-90909",
631     "paymentMethods": [
632       {
633         "type": "bankAccount",
634         "accountName": "Vendor Checking Account",
635         "accountNumber": "55934059697648",
636         "accountType": "CHECKING",
637         "bankName": "Chase",
638         "createdAt": "2021-01-01T00:00:00Z",
639         "frozen": false,
640         "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
641         "isDefaultDestination": true,
642         "isDefaultSource": true,
643         "metadata": {},
644         "routingNumber": "66554433",
645         "status": "NEW",
646         "supportedCurrencies": [
647           "USD"
648         ],
649         "updatedAt": "2021-01-01T00:00:00Z",
650         "confirmedByEntity": false
651       }
652     ]
653   },
654   "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
655 }

Get Transaction

Path parameters

transactionIdstringRequired

Response

This endpoint returns an object.

bankAccountToBankAccountobject

bankAccountToMailedCheckobject

bankAccountToPrintedCheckobject

bankAccountToWalletobject

cardToWalletobject

walletToBankAccountobject

customobject

offPlatformobject

Get Transaction

Path parameters

Headers

Response

Errors