Get Transaction

GET

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 )

Play

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

Get Transaction

Path parameters

transactionIdstringRequired

Response

This endpoint returns an object.

bankAccountToBankAccountobject

bankAccountToMailedCheckobject

bankAccountToWalletobject

cardToWalletobject

walletToBankAccountobject

customobject

offPlatformobject

Get Transaction

Path parameters

Headers

Response

Errors