POST /virtual_bank_accounts
Creates a virtual bank account for a customer. Email address is mandatory for virtual bank account creation. All notifications related to this virtual bank account will be sent to the email address you specify.
Customer's email and virtual bank accounts will always be in sync.
Servers
- {protocol}://{site}.{environment}:{port}/api/v2
- {protocol}://{site}-test.{environment}:{port}/api/v2
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
chargebee-request-origin-device |
String | No |
The device from which the customer has made the request |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
chargebee-event-webhook |
String | No |
skip only webhooks Valid values:
|
chargebee-business-entity-id |
String | No |
If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation. |
chargebee-event-actions |
String | No |
skip all actions to be done on the events Valid values:
|
chargebee-request-origin-user |
String | No |
The email address of your customer/user. Use this when the email address has only ASCII characters. |
chargebee-request-origin-ip |
String | No |
The IP address of the customer where the request originated |
chargebee-request-origin-user-encoded |
String | No |
The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored. |
chargebee-event-email |
String | No |
skip only emails Valid values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
customer_id |
String | Yes |
Identifier of the customer. |
email |
String | No |
Email address associated with the virtual bank account. |
gateway_account_id |
String | No | |
scheme |
String | No |
Type of the credit transfer. * mx_automated_bank_transfer -MX Automated Bank Transfer * sepa_credit -SEPA Credit Transfer This scheme is deprecated. Instead of EU Automated Bank Transfer * ach_credit -ACH Credit Transfer This scheme is deprecated. Instead of JP Automated Bank Transfer * us_automated_bank_transfer -US Automated Bank Transfer * gb_automated_bank_transfer -UK Automated Bank Transfer Valid values:
Default value: "ach_credit" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.