Transaction Completed

A transaction was completed

Payload

The payload of this webhook request is an object.
eventTypestringRequired
transactionobjectRequired

Response

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