ChargebeeAPI

Virtual bank accounts

A virtual bank account is a unique account number which is generated so you don't need to share your sensitive bank account details with your users. A virtual bank account can be paid with ACH credit or wire transfer. Users can make payment of the amount due to this account, and the amount will be matched with the invoice.

Sample Virtual bank accountJSON

Virtual bank accounts attributes

id
required, string, max chars=40

Identifier of the virtual bank account

customer_id
required, string, max chars=50

Identifier of the customer.

email
required, string, max chars=70

Email address associated with the virtual bank account

scheme
optional, enumerated string, default=ach_credit

Type of the credit transfer

Possible Enum Values
ach_credit

ACH Credit Transfer

This scheme is deprecated. Instead of ach_credit use us_automated_bank_transfer .

sepa_credit

SEPA Credit Transfer

This scheme is deprecated. Instead of sepa_credit use eu_automated_bank_transfer .

us_automated_bank_transfer

US Automated Bank Transfer

gb_automated_bank_transfer

UK Automated Bank Transfer

eu_automated_bank_transfer

EU Automated Bank Transfer

jp_automated_bank_transfer

JP Automated Bank Transfer

mx_automated_bank_transfer

MX Automated Bank Transfer

bank_name
optional, string, max chars=100

Name of the bank

account_number
required, string, min chars=5, max chars=50

The account number to which funds will be transferred.

routing_number
optional, string, min chars=3, max chars=50

The routing number of the bank

swift_code
optional, string, min chars=3, max chars=11

Swift code of the bank in which the account exists.

gateway
required, enumerated string

Name of the gateway this virtual bank account is stored in.

Possible Enum Values
chargebee

Chargebee test gateway.

chargebee_payments

Chargebee Payments gateway

adyen

Adyen is a payment gateway.

stripe

Stripe is a payment gateway.

wepay

WePay is a payment gateway.

gateway_account_id
required, string, max chars=50

The gateway account in which this virtual bank account is stored.

resource_version
optional, long

Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.

updated_at
optional, timestamp(UTC) in seconds

Timestamp indicating when this virtual bank account resource was last updated.

created_at
required, timestamp(UTC) in seconds

Timestamp indicating when this virtual bank account resource is created.

reference_id
required, string, max chars=150

Identifier provided by the gateway for the virtual bank account source. In case of Stripe, the reference_id consists of a combination of Stripe Customer ID and Stripe Source ID separated by a forward slash (e.g. cus_63MnDn0t6kfDW7/src_6WjCF20vT9WN1G).

deleted
required, boolean

Indicates that this resource has been deleted.