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    "createdAt": "2024-01-01T00:00:00Z",
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            "createdAt": "2024-01-01T00:00:00Z",
254            "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
255            "status": "COMPLETED",
256            "updatedAt": "2024-01-01T00:00:00Z"
257          }
258        ],
259        "vendor": {
260          "acceptedTos": false,
261          "accountType": "business",
262          "createdAt": "2024-01-01T00:00:00Z",
263          "email": "vendor@bigboxstore.com",
264          "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
265          "isCustomer": false,
266          "isNetworkPayee": false,
267          "isNetworkPayor": false,
268          "isPayee": true,
269          "isPayor": false,
270          "name": "Big Box Store",
271          "profile": {
272            "business": {
273              "legalBusinessName": "Big Box Store",
274              "taxIDProvided": false,
275              "email": "vendor@bigboxstore.com",
276              "businessType": "publicCorporation",
277              "ownersProvided": false
278            }
279          },
280          "status": "unverified",
281          "updatedAt": "2024-01-02T00:00:00Z",
282          "counterpartyType": [
283            "ENTITY"
284          ],
285          "foreignId": "MY-DB-ID-90909",
286          "paymentMethods": [
287            {
288              "type": "bankAccount",
289              "accountName": "Vendor Checking Account",
290              "accountNumber": "55934059697648",
291              "accountType": "CHECKING",
292              "bankName": "Chase",
293              "createdAt": "2021-01-01T00:00:00Z",
294              "frozen": false,
295              "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
296              "isDefaultDestination": true,
297              "isDefaultSource": true,
298              "metadata": {},
299              "routingNumber": "66554433",
300              "status": "NEW",
301              "supportedCurrencies": [
302                "USD"
303              ],
304              "updatedAt": "2021-01-01T00:00:00Z"
305            }
306          ]
307        },
308        "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
309      }
310    ],
311    "status": "COMPLETED",
312    "updatedAt": "2024-01-01T00:00:00Z"
313  }
314}
Transaction Failed
Built with