Transaction Pending

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