Payment Method Updated

Payload

1 {
2   "eventType": "paymentMethod.updated",
3   "entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
4   "updatedByEntityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
5   "paymentMethod": {
6     "type": "bankAccount",
7     "accountName": "My Checking Account",
8     "accountNumber": "99988767623",
9     "accountType": "CHECKING",
10     "bankName": "Chase",
11     "createdAt": "2021-01-01T00:00:00Z",
12     "frozen": false,
13     "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
14     "isDefaultDestination": true,
15     "isDefaultSource": true,
16     "metadata": {},
17     "routingNumber": "12345678",
18     "status": "VERIFIED",
19     "supportedCurrencies": [
20       "USD"
21     ],
22     "updatedAt": "2021-01-01T00:00:00Z",
23     "confirmedByEntity": true
24   },
25   "entity": {
26     "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
27     "name": "Acme Inc.",
28     "email": "customer@acme.com",
29     "isCustomer": true,
30     "accountType": "business",
31     "profile": {
32       "business": {
33         "legalBusinessName": "Acme Inc.",
34         "taxIDProvided": true,
35         "email": "customer@acme.com",
36         "businessType": "llc",
37         "phone": {
38           "countryCode": "1",
39           "number": "4155551234"
40         },
41         "address": {
42           "addressLine1": "123 Main St",
43           "city": "San Francisco",
44           "stateOrProvince": "CA",
45           "postalCode": "94105",
46           "addressLine2": "Unit 1",
47           "country": "US"
48         },
49         "ownersProvided": true,
50         "taxId": {
51           "ein": {
52             "number": "12-3456789"
53           }
54         }
55       }
56     },
57     "status": "verified",
58     "acceptedTos": true,
59     "isPayor": true,
60     "isPayee": false,
61     "isNetworkPayor": false,
62     "isNetworkPayee": false,
63     "createdAt": "2024-01-01T00:00:00Z",
64     "updatedAt": "2024-01-02T00:00:00Z",
65     "foreignId": "MY-DB-ID-12345"
66   },
67   "user": {
68     "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
69     "roles": [
70       "admin",
71       "approver"
72     ],
73     "createdAt": "2024-01-01T00:00:00Z",
74     "updatedAt": "2024-01-01T00:00:00Z",
75     "foreignId": "MY-DB-ID-12345",
76     "email": "john.doe@acme.com",
77     "name": "John Doe"
78   }
79 }

A payment method was updated

Payload

The payload of this webhook request is an object.

eventTypestringRequired

The type of the event.

entityIdstringRequired

ID of the entity that the payment method belongs to.

updatedByEntityIdstringRequired

ID of the entity that created or updated the payment method. This will be different from the entityId if the payment method was added by a different entity (e.g. a C2 creating a payment method for a C3). If the payment method was created or updated by an admin, this will be ‘admin’.

paymentMethodobjectRequired

The payment method details.

entityobjectRequired

Entity that the payment method belongs to.

userobjectOptional

User who initiated the change.

Response

200

any

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