Get Transaction

GET

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

GET

/transaction/:transactionId

1 from mercoa import Mercoa
2 
3 client = Mercoa(
4     token="YOUR_TOKEN",
5 )
6 client.transaction.get(
7     transaction_id="trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
8 )

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       "paymentSourceOptions": {
250         "type": "bnpl",
251         "acceptedTerms": true,
252         "defermentWeeks": 8,
253         "installmentsStartDate": "2025-06-18"
254       },
255       "processedAt": "2021-01-01T00:00:00Z",
256       "serviceEndDate": "2021-01-31T00:00:00Z",
257       "serviceStartDate": "2021-01-01T00:00:00Z",
258       "settlementDate": "2021-01-03T00:00:00Z",
259       "transactions": [
260         {
261           "type": "bankAccountToBankAccount",
262           "amount": 10000,
263           "createdAt": "2024-01-01T00:00:00Z",
264           "currency": "USD",
265           "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
266           "payer": {
267             "acceptedTos": true,
268             "accountType": "business",
269             "createdAt": "2024-01-01T00:00:00Z",
270             "email": "customer@acme.com",
271             "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
272             "isCustomer": true,
273             "isNetworkPayee": false,
274             "isNetworkPayor": false,
275             "isPayee": false,
276             "isPayor": true,
277             "name": "Acme Inc.",
278             "profile": {
279               "business": {
280                 "legalBusinessName": "Acme Inc.",
281                 "taxIDProvided": true,
282                 "email": "customer@acme.com",
283                 "businessType": "llc",
284                 "phone": {
285                   "countryCode": "1",
286                   "number": "4155551234"
287                 },
288                 "address": {
289                   "addressLine1": "123 Main St",
290                   "city": "San Francisco",
291                   "stateOrProvince": "CA",
292                   "postalCode": "94105",
293                   "addressLine2": "Unit 1",
294                   "country": "US"
295                 },
296                 "ownersProvided": true,
297                 "taxId": {
298                   "ein": {
299                     "number": "12-3456789"
300                   }
301                 }
302               }
303             },
304             "status": "verified",
305             "updatedAt": "2024-01-02T00:00:00Z",
306             "accounts": [
307               {
308                 "accountId": "85866843",
309                 "postalCode": "94105",
310                 "nameOnAccount": "John Doe"
311               }
312             ],
313             "counterpartyType": [
314               "ENTITY"
315             ],
316             "foreignId": "MY-DB-ID-12345",
317             "paymentMethods": [
318               {
319                 "type": "bankAccount",
320                 "accountName": "My Checking Account",
321                 "accountNumber": "99988767623",
322                 "accountType": "CHECKING",
323                 "bankName": "Chase",
324                 "createdAt": "2021-01-01T00:00:00Z",
325                 "frozen": false,
326                 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
327                 "isDefaultDestination": true,
328                 "isDefaultSource": true,
329                 "metadata": {},
330                 "routingNumber": "12345678",
331                 "status": "VERIFIED",
332                 "supportedCurrencies": [
333                   "USD"
334                 ],
335                 "updatedAt": "2021-01-01T00:00:00Z",
336                 "confirmedByEntity": true
337               }
338             ]
339           },
340           "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
341           "paymentDestination": {
342             "type": "bankAccount",
343             "accountName": "My Checking Account",
344             "accountNumber": "99988767623",
345             "accountType": "CHECKING",
346             "bankName": "Chase",
347             "createdAt": "2021-01-01T00:00:00Z",
348             "frozen": false,
349             "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
350             "isDefaultDestination": true,
351             "isDefaultSource": true,
352             "metadata": {},
353             "routingNumber": "12345678",
354             "status": "VERIFIED",
355             "supportedCurrencies": [
356               "USD"
357             ],
358             "updatedAt": "2021-01-01T00:00:00Z",
359             "confirmedByEntity": true
360           },
361           "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
362           "paymentSource": {
363             "type": "bankAccount",
364             "accountName": "My Checking Account",
365             "accountNumber": "99988767623",
366             "accountType": "CHECKING",
367             "bankName": "Chase",
368             "createdAt": "2021-01-01T00:00:00Z",
369             "frozen": false,
370             "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
371             "isDefaultDestination": true,
372             "isDefaultSource": true,
373             "metadata": {},
374             "routingNumber": "12345678",
375             "status": "VERIFIED",
376             "supportedCurrencies": [
377               "USD"
378             ],
379             "updatedAt": "2021-01-01T00:00:00Z",
380             "confirmedByEntity": true
381           },
382           "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
383           "status": "COMPLETED",
384           "updatedAt": "2024-01-01T00:00:00Z",
385           "vendor": {
386             "acceptedTos": false,
387             "accountType": "business",
388             "createdAt": "2024-01-01T00:00:00Z",
389             "email": "vendor@bigboxstore.com",
390             "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
391             "isCustomer": false,
392             "isNetworkPayee": false,
393             "isNetworkPayor": false,
394             "isPayee": true,
395             "isPayor": false,
396             "name": "Big Box Store",
397             "profile": {
398               "business": {
399                 "legalBusinessName": "Big Box Store",
400                 "taxIDProvided": false,
401                 "email": "vendor@bigboxstore.com",
402                 "businessType": "publicCorporation",
403                 "ownersProvided": false
404               }
405             },
406             "status": "unverified",
407             "updatedAt": "2024-01-02T00:00:00Z",
408             "counterpartyType": [
409               "ENTITY"
410             ],
411             "foreignId": "MY-DB-ID-90909",
412             "paymentMethods": [
413               {
414                 "type": "bankAccount",
415                 "accountName": "Vendor Checking Account",
416                 "accountNumber": "55934059697648",
417                 "accountType": "CHECKING",
418                 "bankName": "Chase",
419                 "createdAt": "2021-01-01T00:00:00Z",
420                 "frozen": false,
421                 "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
422                 "isDefaultDestination": true,
423                 "isDefaultSource": true,
424                 "metadata": {},
425                 "routingNumber": "66554433",
426                 "status": "NEW",
427                 "supportedCurrencies": [
428                   "USD"
429                 ],
430                 "updatedAt": "2021-01-01T00:00:00Z",
431                 "confirmedByEntity": false
432               }
433             ]
434           },
435           "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
436         }
437       ],
438       "vendor": {
439         "acceptedTos": false,
440         "accountType": "business",
441         "createdAt": "2024-01-01T00:00:00Z",
442         "email": "vendor@bigboxstore.com",
443         "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
444         "isCustomer": false,
445         "isNetworkPayee": false,
446         "isNetworkPayor": false,
447         "isPayee": true,
448         "isPayor": false,
449         "name": "Big Box Store",
450         "profile": {
451           "business": {
452             "legalBusinessName": "Big Box Store",
453             "taxIDProvided": false,
454             "email": "vendor@bigboxstore.com",
455             "businessType": "publicCorporation",
456             "ownersProvided": false
457           }
458         },
459         "status": "unverified",
460         "updatedAt": "2024-01-02T00:00:00Z",
461         "counterpartyType": [
462           "ENTITY"
463         ],
464         "foreignId": "MY-DB-ID-90909",
465         "paymentMethods": [
466           {
467             "type": "bankAccount",
468             "accountName": "Vendor Checking Account",
469             "accountNumber": "55934059697648",
470             "accountType": "CHECKING",
471             "bankName": "Chase",
472             "createdAt": "2021-01-01T00:00:00Z",
473             "frozen": false,
474             "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
475             "isDefaultDestination": true,
476             "isDefaultSource": true,
477             "metadata": {},
478             "routingNumber": "66554433",
479             "status": "NEW",
480             "supportedCurrencies": [
481               "USD"
482             ],
483             "updatedAt": "2021-01-01T00:00:00Z",
484             "confirmedByEntity": false
485           }
486         ]
487       },
488       "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
489     }
490   ],
491   "payer": {
492     "acceptedTos": true,
493     "accountType": "business",
494     "createdAt": "2024-01-01T00:00:00Z",
495     "email": "customer@acme.com",
496     "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
497     "isCustomer": true,
498     "isNetworkPayee": false,
499     "isNetworkPayor": false,
500     "isPayee": false,
501     "isPayor": true,
502     "name": "Acme Inc.",
503     "profile": {
504       "business": {
505         "legalBusinessName": "Acme Inc.",
506         "taxIDProvided": true,
507         "email": "customer@acme.com",
508         "businessType": "llc",
509         "phone": {
510           "countryCode": "1",
511           "number": "4155551234"
512         },
513         "address": {
514           "addressLine1": "123 Main St",
515           "city": "San Francisco",
516           "stateOrProvince": "CA",
517           "postalCode": "94105",
518           "addressLine2": "Unit 1",
519           "country": "US"
520         },
521         "ownersProvided": true,
522         "taxId": {
523           "ein": {
524             "number": "12-3456789"
525           }
526         }
527       }
528     },
529     "status": "verified",
530     "updatedAt": "2024-01-02T00:00:00Z",
531     "accounts": [
532       {
533         "accountId": "85866843",
534         "postalCode": "94105",
535         "nameOnAccount": "John Doe"
536       }
537     ],
538     "counterpartyType": [
539       "ENTITY"
540     ],
541     "foreignId": "MY-DB-ID-12345",
542     "paymentMethods": [
543       {
544         "type": "bankAccount",
545         "accountName": "My Checking Account",
546         "accountNumber": "99988767623",
547         "accountType": "CHECKING",
548         "bankName": "Chase",
549         "createdAt": "2021-01-01T00:00:00Z",
550         "frozen": false,
551         "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
552         "isDefaultDestination": true,
553         "isDefaultSource": true,
554         "metadata": {},
555         "routingNumber": "12345678",
556         "status": "VERIFIED",
557         "supportedCurrencies": [
558           "USD"
559         ],
560         "updatedAt": "2021-01-01T00:00:00Z",
561         "confirmedByEntity": true
562       }
563     ]
564   },
565   "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
566   "paymentDestination": {
567     "type": "bankAccount",
568     "accountName": "My Checking Account",
569     "accountNumber": "99988767623",
570     "accountType": "CHECKING",
571     "bankName": "Chase",
572     "createdAt": "2021-01-01T00:00:00Z",
573     "frozen": false,
574     "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
575     "isDefaultDestination": true,
576     "isDefaultSource": true,
577     "metadata": {},
578     "routingNumber": "12345678",
579     "status": "VERIFIED",
580     "supportedCurrencies": [
581       "USD"
582     ],
583     "updatedAt": "2021-01-01T00:00:00Z",
584     "confirmedByEntity": true
585   },
586   "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
587   "paymentSource": {
588     "type": "bankAccount",
589     "accountName": "My Checking Account",
590     "accountNumber": "99988767623",
591     "accountType": "CHECKING",
592     "bankName": "Chase",
593     "createdAt": "2021-01-01T00:00:00Z",
594     "frozen": false,
595     "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
596     "isDefaultDestination": true,
597     "isDefaultSource": true,
598     "metadata": {},
599     "routingNumber": "12345678",
600     "status": "VERIFIED",
601     "supportedCurrencies": [
602       "USD"
603     ],
604     "updatedAt": "2021-01-01T00:00:00Z",
605     "confirmedByEntity": true
606   },
607   "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
608   "status": "COMPLETED",
609   "updatedAt": "2024-01-01T00:00:00Z",
610   "vendor": {
611     "acceptedTos": false,
612     "accountType": "business",
613     "createdAt": "2024-01-01T00:00:00Z",
614     "email": "vendor@bigboxstore.com",
615     "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
616     "isCustomer": false,
617     "isNetworkPayee": false,
618     "isNetworkPayor": false,
619     "isPayee": true,
620     "isPayor": false,
621     "name": "Big Box Store",
622     "profile": {
623       "business": {
624         "legalBusinessName": "Big Box Store",
625         "taxIDProvided": false,
626         "email": "vendor@bigboxstore.com",
627         "businessType": "publicCorporation",
628         "ownersProvided": false
629       }
630     },
631     "status": "unverified",
632     "updatedAt": "2024-01-02T00:00:00Z",
633     "counterpartyType": [
634       "ENTITY"
635     ],
636     "foreignId": "MY-DB-ID-90909",
637     "paymentMethods": [
638       {
639         "type": "bankAccount",
640         "accountName": "Vendor Checking Account",
641         "accountNumber": "55934059697648",
642         "accountType": "CHECKING",
643         "bankName": "Chase",
644         "createdAt": "2021-01-01T00:00:00Z",
645         "frozen": false,
646         "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
647         "isDefaultDestination": true,
648         "isDefaultSource": true,
649         "metadata": {},
650         "routingNumber": "66554433",
651         "status": "NEW",
652         "supportedCurrencies": [
653           "USD"
654         ],
655         "updatedAt": "2021-01-01T00:00:00Z",
656         "confirmedByEntity": false
657       }
658     ]
659   },
660   "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
661 }

Get Transaction

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

transactionIdstringRequired

Response

This endpoint returns an object.

bankAccountToBankAccountobject

bankAccountToMailedCheckobject

bankAccountToPrintedCheckobject

bankAccountToWalletobject

cardToBankAccountobject

cardToWalletobject

walletToBankAccountobject

walletToWalletobject

customobject

offPlatformobject

Authentication

Path parameters

Response

Errors