WebhooksComponents
Defined in: src/webhooks/types.gen.ts:190
Properties
Section titled “Properties”headers
Section titled “headers”headers:
never
Defined in: src/webhooks/types.gen.ts:596
parameters
Section titled “parameters”parameters:
never
Defined in: src/webhooks/types.gen.ts:594
pathItems
Section titled “pathItems”pathItems:
never
Defined in: src/webhooks/types.gen.ts:597
requestBodies
Section titled “requestBodies”requestBodies:
never
Defined in: src/webhooks/types.gen.ts:595
responses
Section titled “responses”responses:
never
Defined in: src/webhooks/types.gen.ts:593
schemas
Section titled “schemas”schemas:
object
Defined in: src/webhooks/types.gen.ts:191
AccountingRecordReadyForExport
Section titled “AccountingRecordReadyForExport”AccountingRecordReadyForExport:
object&Record<string,never>
Type Declaration
Section titled “Type Declaration”accountingRecordIds
Section titled “accountingRecordIds”accountingRecordIds:
string[]
Description
Section titled “Description”List of accounting record IDs ready for export.
companyId
Section titled “companyId”companyId:
string
Description
Section titled “Description”This is the id returned in the Get Company endpoint.
You can use the company_id to determine which access token to use when you get the details from our API endpoints.
event_type
Section titled “event_type”event_type:
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT"
Description
Section titled “Description”A list of accounting records are ready for export.
AddWebhookGroupMembersRequest
Section titled “AddWebhookGroupMembersRequest”AddWebhookGroupMembersRequest:
object
AddWebhookGroupMembersRequest.members
Section titled “AddWebhookGroupMembersRequest.members”members:
object[]
Description
Section titled “Description”The list of webhook group members to add to the group.
ApplicationStatus
Section titled “ApplicationStatus”ApplicationStatus:
"ACTIVE"|"PROCESSING"|"REJECTED"|"NO_ACCOUNT"|"NOT_SUBMITTED"|"INFORMATION_PENDING"|"MANUAL_REVIEW"|"CLOSED"
Description
Section titled “Description”Application status of a product.
`NO_ACCOUNT` - There is no active application, and the product account is not provisioned.
`ACTIVE` - The application is approved, and the product account is provisioned.
`NOT_SUBMITTED` - The application is started but not yet submitted.
`INFORMATION_PENDING` - The application is submitted and additional information is requested.
`MANUAL_REVIEW` - The application is under manual review.
`PROCESSING` - The application is submitted and is under review.
`REJECTED` - The application is rejected.
`CLOSED` - The product account is closed.CreateWebhookGroupRequest
Section titled “CreateWebhookGroupRequest”CreateWebhookGroupRequest:
object
CreateWebhookGroupRequest.name
Section titled “CreateWebhookGroupRequest.name”name:
string
Description
Section titled “Description”The name for the webhook group.
Example
Section titled “Example”Some Webhook GroupCreateWebhookSubscriptionRequest
Section titled “CreateWebhookSubscriptionRequest”CreateWebhookSubscriptionRequest:
object
CreateWebhookSubscriptionRequest.event_types
Section titled “CreateWebhookSubscriptionRequest.event_types”event_types: (
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT")[]
Description
Section titled “Description”A list of the webhook event types this subscription will listen to.
CreateWebhookSubscriptionRequest.group_id?
Section titled “CreateWebhookSubscriptionRequest.group_id?”
optionalgroup_id?:string|null
Description
Section titled “Description”ID of the webhook group to which this subscription applies, if any. This is only available for partners.
Example
Section titled “Example”wg_123CreateWebhookSubscriptionRequest.url
Section titled “CreateWebhookSubscriptionRequest.url”url:
string
Description
Section titled “Description”The URL to which webhook events will be sent. Must be a valid HTTPS URL.
Example
Section titled “Example”https://example.com/webhookEventWrapper
Section titled “EventWrapper”EventWrapper:
Record<string,never>
ExpensePaymentStatus
Section titled “ExpensePaymentStatus”ExpensePaymentStatus:
"DECLINED"|"PENDING"
Description
Section titled “Description”PENDING:The transaction is yet to be captured. It may be approved, yet to be approved, or yet to be declined.
`DECLINED`: The transaction was declined.ExpensePaymentType
Section titled “ExpensePaymentType”ExpensePaymentType:
"DECLINED"|"PURCHASE"|"REFUND"|"WITHDRAWAL"
Description
Section titled “Description”PURCHASE: A pending transaction for making a purchase.
`REFUND`: A pending transaction for a refund.
`WITHDRAWAL`: A pending transaction for a withdrawal.
`DECLINED`: A pending transaction that was declined and will not be completed.ExpensePaymentUpdated
Section titled “ExpensePaymentUpdated”ExpensePaymentUpdated:
object&Record<string,never>
Type Declaration
Section titled “Type Declaration”amount?
Section titled “amount?”
optionalamount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
billing_amount?
Section titled “billing_amount?”
optionalbilling_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
card_id
Section titled “card_id”card_id:
string
Description
Section titled “Description”The ID of the card that is associated with the expense.
company_id
Section titled “company_id”company_id:
string
Description
Section titled “Description”This is the id returned in the Get Company endpoint.
You can use the company_id to determine which access token to use when you get the details from our API endpoints.
event_type
Section titled “event_type”event_type:
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT"
expense_id
Section titled “expense_id”expense_id:
string
Description
Section titled “Description”Unique ID associated with the expense.
merchant
Section titled “merchant”merchant:
object
merchant.country
Section titled “merchant.country”country:
string
Description
Section titled “Description”Merchant’s country, in ISO 3166-1 alpha-3 format.
merchant.mcc
Section titled “merchant.mcc”mcc:
string
Description
Section titled “Description”A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to https://en.wikipedia.org/wiki/Merchant_category_code for more details.
merchant.raw_descriptor
Section titled “merchant.raw_descriptor”raw_descriptor:
string
Description
Section titled “Description”Merchant descriptor, it can be the merchant name.
original_amount?
Section titled “original_amount?”
optionaloriginal_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
payment_authorization_code?
Section titled “payment_authorization_code?”
optionalpayment_authorization_code?:string|null
Description
Section titled “Description”The authorization code of the associated card expense.
payment_description
Section titled “payment_description”payment_description:
string
Description
Section titled “Description”Succeeded by the merchant::raw_descriptor field.
payment_status
Section titled “payment_status”payment_status:
"DECLINED"|"PENDING"
payment_status_reason
Section titled “payment_status_reason”payment_status_reason:
"APPROVED"|"OTHER"|"EXCEEDED_BUDGET_LIMIT"|"BUDGET_EXPIRED"|"NO_BUDGET"|"BUDGET_NOT_YET_STARTED"|"BUDGET_CATEGORY_RESTRICTION"|"BUDGET_MERCHANT_RESTRICTION"|"SUSPECTED_FRAUD"|"EXCEEDED_GLOBAL_LIMIT"|"EXCEEDED_USER_LIMIT"|"EXCEEDED_CARD_LIMIT"|"INVALID_EXPIRATION_DATE"|"CARD_NOT_ACTIVE"|"INVALID_CARD_CREDENTIALS"|"INVALID_BILLING_ADDRESS"|"CARD_SUSPENDED"|"CARD_TERMINATED"|"CARD_EXPIRED"|"MCC_BLOCKED"|"USER_SUSPENDED"|"INVALID_PIN"|"INVALID_CVV"|"EXCEEDED_PIN_ATTEMPTS"|"INSIDE_SANCTIONED_COUNTRY"|"SOFT_EXPIRATION"|"TRANSFERRED_CARD_NEW_MERCHANT"|"EXCEEDED_ANCESTOR_BUDGET_LIMIT"|"EXCEEDED_BUDGET_TRANSACTION_LIMIT"|"TOS_BLOCKED"|"COMPLIANCE_BLOCKED"
payment_type
Section titled “payment_type”payment_type:
"DECLINED"|"PURCHASE"|"REFUND"|"WITHDRAWAL"
purchased_at?
Section titled “purchased_at?”
optionalpurchased_at?:string|null
Format: date-time
Description
Section titled “Description”The time the purchase was made.
version
Section titled “version”version:
number
Format: int32
Description
Section titled “Description”Version of this expense. This value starts at 1 and is incremented by 1 with every update.
Example
Section titled “Example”1Description
Section titled “Description”The webhook will be sent when an expense payment changes status. Subscription must be registered with a user with the CARD_ADMIN role.
Merchant
Section titled “Merchant”Merchant:
object
Merchant.country
Section titled “Merchant.country”country:
string
Description
Section titled “Description”Merchant’s country, in ISO 3166-1 alpha-3 format.
Merchant.mcc
Section titled “Merchant.mcc”mcc:
string
Description
Section titled “Description”A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to https://en.wikipedia.org/wiki/Merchant_category_code for more details.
Merchant.raw_descriptor
Section titled “Merchant.raw_descriptor”raw_descriptor:
string
Description
Section titled “Description”Merchant descriptor, it can be the merchant name.
Money:
object
Description
Section titled “Description”Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.
Money.amount
Section titled “Money.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700Money.currency
Section titled “Money.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDPage_WebhookGroup_
Section titled “Page_WebhookGroup_”Page_WebhookGroup_:
object
Page_WebhookGroup_.items
Section titled “Page_WebhookGroup_.items”items:
object[]
Page_WebhookGroup_.next_cursor?
Section titled “Page_WebhookGroup_.next_cursor?”
optionalnext_cursor?:string|null
Page_WebhookGroupMember_
Section titled “Page_WebhookGroupMember_”Page_WebhookGroupMember_:
object
Page_WebhookGroupMember_.items
Section titled “Page_WebhookGroupMember_.items”items:
object[]
Page_WebhookGroupMember_.next_cursor?
Section titled “Page_WebhookGroupMember_.next_cursor?”
optionalnext_cursor?:string|null
Page_WebhookSubscription_
Section titled “Page_WebhookSubscription_”Page_WebhookSubscription_:
object
Page_WebhookSubscription_.items
Section titled “Page_WebhookSubscription_.items”items:
object[]
Page_WebhookSubscription_.next_cursor?
Section titled “Page_WebhookSubscription_.next_cursor?”
optionalnext_cursor?:string|null
PaymentStatusReason
Section titled “PaymentStatusReason”PaymentStatusReason:
"APPROVED"|"OTHER"|"EXCEEDED_BUDGET_LIMIT"|"BUDGET_EXPIRED"|"NO_BUDGET"|"BUDGET_NOT_YET_STARTED"|"BUDGET_CATEGORY_RESTRICTION"|"BUDGET_MERCHANT_RESTRICTION"|"SUSPECTED_FRAUD"|"EXCEEDED_GLOBAL_LIMIT"|"EXCEEDED_USER_LIMIT"|"EXCEEDED_CARD_LIMIT"|"INVALID_EXPIRATION_DATE"|"CARD_NOT_ACTIVE"|"INVALID_CARD_CREDENTIALS"|"INVALID_BILLING_ADDRESS"|"CARD_SUSPENDED"|"CARD_TERMINATED"|"CARD_EXPIRED"|"MCC_BLOCKED"|"USER_SUSPENDED"|"INVALID_PIN"|"INVALID_CVV"|"EXCEEDED_PIN_ATTEMPTS"|"INSIDE_SANCTIONED_COUNTRY"|"SOFT_EXPIRATION"|"TRANSFERRED_CARD_NEW_MERCHANT"|"EXCEEDED_ANCESTOR_BUDGET_LIMIT"|"EXCEEDED_BUDGET_TRANSACTION_LIMIT"|"TOS_BLOCKED"|"COMPLIANCE_BLOCKED"
Description
Section titled “Description”The reason for the payment’s status.
PaymentType
Section titled “PaymentType”PaymentType:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"|"INTERNATIONAL_WIRE"|"BOOK_TRANSFER"|"STABLECOIN"|"ACH_RETURN"|"WIRE_RETURN"|"CHEQUE_RETURN"
Description
Section titled “Description”Only ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE, BOOK_TRANSFER, and STABLECOIN details can be retrieved from the Payments API.
ProductApplication
Section titled “ProductApplication”ProductApplication:
object
Description
Section titled “Description”The product application details for the referral.
ProductApplication.cash
Section titled “ProductApplication.cash”cash:
"ACTIVE"|"PROCESSING"|"REJECTED"|"NO_ACCOUNT"|"NOT_SUBMITTED"|"INFORMATION_PENDING"|"MANUAL_REVIEW"|"CLOSED"
ReferralActivated
Section titled “ReferralActivated”ReferralActivated:
object&Record<string,never>
Type Declaration
Section titled “Type Declaration”event_type
Section titled “event_type”event_type:
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT"
referral_id
Section titled “referral_id”referral_id:
string
Description
Section titled “Description”The referral ID
Description
Section titled “Description”The webhook will be sent when a user signs up with the referral link.
ReferralApplicationStatusChanged
Section titled “ReferralApplicationStatusChanged”ReferralApplicationStatusChanged:
object&Record<string,never>
Type Declaration
Section titled “Type Declaration”application
Section titled “application”application:
object
application.cash
Section titled “application.cash”cash:
"ACTIVE"|"PROCESSING"|"REJECTED"|"NO_ACCOUNT"|"NOT_SUBMITTED"|"INFORMATION_PENDING"|"MANUAL_REVIEW"|"CLOSED"
event_type
Section titled “event_type”event_type:
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT"
referral_id
Section titled “referral_id”referral_id:
string
Description
Section titled “Description”The referral ID
Description
Section titled “Description”The webhook will be sent when the application status is changed.
ReferralCreated
Section titled “ReferralCreated”ReferralCreated:
object&Record<string,never>
Type Declaration
Section titled “Type Declaration”event_type
Section titled “event_type”event_type:
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT"
referral_id
Section titled “referral_id”referral_id:
string
Description
Section titled “Description”The referral ID
Description
Section titled “Description”The webhook will be sent when a referral is created.
RemoveWebhookGroupMembersRequest
Section titled “RemoveWebhookGroupMembersRequest”RemoveWebhookGroupMembersRequest:
object
RemoveWebhookGroupMembersRequest.members
Section titled “RemoveWebhookGroupMembersRequest.members”members:
object[]
Description
Section titled “Description”The list of webhook group members to remove from the group.
TransferFailed
Section titled “TransferFailed”TransferFailed:
object&Record<string,never>
Type Declaration
Section titled “Type Declaration”company_id
Section titled “company_id”company_id:
string
Description
Section titled “Description”This is the id returned in the Get Company endpoint. You can use the company_id to determine which access token to use when you get the details from our API endpoints.
event_type
Section titled “event_type”event_type:
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT"
payment_type
Section titled “payment_type”payment_type:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"|"INTERNATIONAL_WIRE"|"BOOK_TRANSFER"|"STABLECOIN"|"ACH_RETURN"|"WIRE_RETURN"|"CHEQUE_RETURN"
return_for_id?
Section titled “return_for_id?”
optionalreturn_for_id?:string|null
Description
Section titled “Description”The original transaction ID that is returned when the payment type is ACH_RETURN, WIRE_RETURN and CHEQUE_RETURN.
transfer_id
Section titled “transfer_id”transfer_id:
string
Description
Section titled “Description”The transfer ID
Description
Section titled “Description”The webhook will be sent when a transfer failed.
TransferProcessed
Section titled “TransferProcessed”TransferProcessed:
object&Record<string,never>
Type Declaration
Section titled “Type Declaration”company_id
Section titled “company_id”company_id:
string
Description
Section titled “Description”This is the id returned in the Get Company endpoint. You can use the company_id to determine which access token to use when you get the details from our API endpoints.
event_type
Section titled “event_type”event_type:
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT"
payment_type
Section titled “payment_type”payment_type:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"|"INTERNATIONAL_WIRE"|"BOOK_TRANSFER"|"STABLECOIN"|"ACH_RETURN"|"WIRE_RETURN"|"CHEQUE_RETURN"
return_for_id?
Section titled “return_for_id?”
optionalreturn_for_id?:string|null
Description
Section titled “Description”The original transaction ID that is returned when the payment type is ACH_RETURN, WIRE_RETURN and CHEQUE_RETURN.
transfer_id
Section titled “transfer_id”transfer_id:
string
Description
Section titled “Description”The transfer ID
Description
Section titled “Description”The webhook will be sent when a transfer is processed.
UpdateWebhookSubscriptionRequest
Section titled “UpdateWebhookSubscriptionRequest”UpdateWebhookSubscriptionRequest:
object
UpdateWebhookSubscriptionRequest.event_types
Section titled “UpdateWebhookSubscriptionRequest.event_types”event_types: (
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT")[]
Description
Section titled “Description”A list of the webhook event types this subscription will listen to.
UpdateWebhookSubscriptionRequest.group_id?
Section titled “UpdateWebhookSubscriptionRequest.group_id?”
optionalgroup_id?:string|null
Description
Section titled “Description”ID of the webhook group to which this subscription applies, if any. This is only available for partners.
Example
Section titled “Example”wg_123UpdateWebhookSubscriptionRequest.status
Section titled “UpdateWebhookSubscriptionRequest.status”status:
"ACTIVE"|"INACTIVE"
UpdateWebhookSubscriptionRequest.url
Section titled “UpdateWebhookSubscriptionRequest.url”url:
string
Description
Section titled “Description”The URL to which webhook events will be sent. Must be a valid HTTPS URL.
Example
Section titled “Example”https://example.com/webhookUserAttributes
Section titled “UserAttributes”UserAttributes:
"STATUS"|"MANAGER_ID"|"DEPARTMENT_ID"|"LOCATION_ID"
UserUpdated
Section titled “UserUpdated”UserUpdated:
object&Record<string,never>
Type Declaration
Section titled “Type Declaration”company_id
Section titled “company_id”company_id:
string
event_type
Section titled “event_type”event_type:
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT"
updated_attributes
Section titled “updated_attributes”updated_attributes: (
"STATUS"|"MANAGER_ID"|"DEPARTMENT_ID"|"LOCATION_ID")[]
user_id
Section titled “user_id”user_id:
string
Description
Section titled “Description”The webhook will be sent when a user is updated.
WebhookEventType
Section titled “WebhookEventType”WebhookEventType:
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT"
WebhookGroup
Section titled “WebhookGroup”WebhookGroup:
object
Webhook Group
Description
Section titled “Description”A webhook group, which can be used by webhook subscriptions to target only the webhook group members. When an event occurs and it belongs to a member of the group, the webhooks will be sent only to the subscriptions that are associated with the group. If there is no group associated with the event, then the webhook will be sent to all subscriptions that are not associated with any group. Webhook groups are only available for partners.
WebhookGroup.id
Section titled “WebhookGroup.id”id:
string
Description
Section titled “Description”The ID of the webhook group.
Example
Section titled “Example”wg_123WebhookGroup.name
Section titled “WebhookGroup.name”name:
string
Description
Section titled “Description”The name for the webhook group.
Example
Section titled “Example”Some Webhook GroupWebhookGroupMember
Section titled “WebhookGroupMember”WebhookGroupMember:
object
Webhook Group Member
Description
Section titled “Description”A member of a webhook group.
WebhookGroupMember.group_id
Section titled “WebhookGroupMember.group_id”group_id:
string
Description
Section titled “Description”The ID of the webhook group this member belongs to.
Example
Section titled “Example”wg_123WebhookGroupMember.member_id
Section titled “WebhookGroupMember.member_id”member_id:
string
Description
Section titled “Description”The ID of the webhook group member.
Example
Section titled “Example”cuacc_123WebhookGroupMember.member_type
Section titled “WebhookGroupMember.member_type”member_type:
"ACCOUNT"
WebhookGroupMemberInput
Section titled “WebhookGroupMemberInput”WebhookGroupMemberInput:
object
WebhookGroupMemberInput.member_id
Section titled “WebhookGroupMemberInput.member_id”member_id:
string
Description
Section titled “Description”The ID of the webhook group member.
WebhookGroupMemberInput.member_type
Section titled “WebhookGroupMemberInput.member_type”member_type:
"ACCOUNT"
WebhookGroupMemberType
Section titled “WebhookGroupMemberType”WebhookGroupMemberType:
"ACCOUNT"
Description
Section titled “Description”The type of a webhook group member.
WebhookSecret
Section titled “WebhookSecret”WebhookSecret:
object
Webhook Secret
Description
Section titled “Description”A webhook secret, which can be used to validate that incoming webhook messages were sent by Brex.
WebhookSecret.secret
Section titled “WebhookSecret.secret”secret:
string
Description
Section titled “Description”The payload of the secret to be used for webhook validation.
Example
Section titled “Example”whsec_123WebhookSecret.status
Section titled “WebhookSecret.status”status:
"ACTIVE"|"PENDING_REVOKE"|"REVOKED"
WebhookSecretStatus
Section titled “WebhookSecretStatus”WebhookSecretStatus:
"ACTIVE"|"PENDING_REVOKE"|"REVOKED"
Description
Section titled “Description”The status of a webhook secret.
WebhookSubscription
Section titled “WebhookSubscription”WebhookSubscription:
object
Webhook Subscription
Description
Section titled “Description”A webhook subscription. When events of the specified event types occur, they will be sent to the given URL. If the subscription applies to a webhook group, then only events that apply to the members of that group will be sent. If it does not apply to any group, then only events that don’t apply to any specific group will be sent. Webhook groups are only available for partners.
WebhookSubscription.event_types
Section titled “WebhookSubscription.event_types”event_types: (
"REFERRAL_CREATED"|"REFERRAL_ACTIVATED"|"REFERRAL_APPLICATION_STATUS_CHANGED"|"TRANSFER_PROCESSED"|"TRANSFER_FAILED"|"EXPENSE_PAYMENT_UPDATED"|"USER_UPDATED"|"EMBEDDED_CARD_TRANSACTION_UPDATED"|"EMBEDDED_CARD_UPDATED"|"EMBEDDED_ACCOUNT_UPDATED"|"EMBEDDED_CARD_SHIPPING_UPDATED"|"EMBEDDED_DISPUTE_UPDATED"|"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"|"EMBEDDED_CARD_AUTHORIZATION"|"EMBEDDED_FRAUD_ALERT"|"EMBEDDED_BILLING_GROUP_UPDATED"|"EMBEDDED_LEGAL_ENTITY_UPDATED"|"EMBEDDED_BILLING_STATEMENT_UPDATED"|"EMBEDDED_USER_STATUS_UPDATED"|"ACCOUNTING_RECORD_READY_FOR_EXPORT")[]
Description
Section titled “Description”List of event types that this webhook subscription listens to.
Example
Section titled “Example”["EXPENSE_PAYMENT_UPDATED"]WebhookSubscription.group_id?
Section titled “WebhookSubscription.group_id?”
optionalgroup_id?:string|null
Description
Section titled “Description”ID of the webhook group to which this subscription applies, if any.
Example
Section titled “Example”wg_123WebhookSubscription.id
Section titled “WebhookSubscription.id”id:
string
Description
Section titled “Description”ID of the webhook subscription.
Example
Section titled “Example”wsub_123WebhookSubscription.status
Section titled “WebhookSubscription.status”status:
"ACTIVE"|"INACTIVE"
WebhookSubscription.url
Section titled “WebhookSubscription.url”url:
string
Description
Section titled “Description”The URL to which webhook events will be sent. Must be a valid HTTPS URL.
Example
Section titled “Example”https://example.com/webhookWebhookSubscriptionStatus
Section titled “WebhookSubscriptionStatus”WebhookSubscriptionStatus:
"ACTIVE"|"INACTIVE"
Description
Section titled “Description”The status of a webhook subscription.