Bank account notification payloads
When you subscribe to a BILL event and the event triggers, BILL sends a notification to your provided notificationUrl
. See /v3/funding-accounts/banks in the API reference for more information about the request and response fields.
Sample bank-account.created
payload
bank-account.created
payloadIn this sample unescaped JSON payload, the details of a bank account are available. The notification includes a set of bank-account
fields.
Field | Description |
---|---|
id | BILL-generated ID of the bank account. The value begins with bac . |
archived | Set as true if the bank account is archived |
status | Bank account status (NOT_VERIFIED , VERIFIED , PENDING , BLOCKED , EXPIRED or INVALID ).When you create a bank account, the status is set as PENDING . You can verify the bank account with POST /v3/funding-accounts/banks/{bankAccountId}/verify . |
createdTime | Created date and time |
{
"metadata": {
"eventId": "{event_id}",
"subscriptionId": "{subscription_id}",
"organizationId": "{organization_id}",
"eventType": "bank-account.created",
"version": "1"
},
"bank-account": {
"id": "{bankaccount_id}",
"archived": true,
"accountNumber": "*****2333",
"nameOnAccount": "Noodle Soupsmith",
"routingNumber": "074000010",
"bankName": "Chase",
"status": "PENDING",
"createdBy": "{user_id}",
"type": "CHECKING",
"ownerType": "BUSINESS",
"createdTime": "2024-12-16T23:15:23.127+00:00",
"default": {
"payables": false,
"receivables": false
}
}
}
Sample bank-account.updated
payload
bank-account.updated
payloadIn this sample unescaped JSON payload, the details of an updated bank account are available. The notification includes the bank account id
for identifying the bank account in your organization. In addition, status
provides the updated bank account status and updatedTime
provides the updated date and time.
{
"metadata": {
"eventId": "{event_id}",
"subscriptionId": "{subscription_id}",
"organizationId": "{organization_id}",
"eventType": "bank-account.updated",
"version": "1"
},
"bank-account": {
"id": "{bankaccount_id}",
"status": "VERIFIED",
"updatedTime": "2024-12-17T23:15:23.127+00:00"
}
}
Updated 2 months ago