Transaction Created

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

The payload of this webhook request is an object.
eventTypestringRequired
The type of the event.
transactionobjectRequired
The transaction details.
Response

200
any
Return a 200 status to indicate that the data was received successfully.