POST /virtual_bank_accounts/create_using_permanent_token
Creates a virtual bank account using the identifier provided by the gateway.
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 Possible 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 Possible 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-event-email |
String | No |
skip only emails Possible values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
customer_id |
String | Yes |
Identifier of the customer. |
scheme |
String | No |
type of the credit transfer. * mx_automated_bank_transfer - MX Automated Bank Transfer * sepa_credit - SEPA Credit Transfer * eu_automated_bank_transfer - EU Automated Bank Transfer * ach_credit - ACH Credit Transfer * jp_automated_bank_transfer - JP Automated Bank Transfer * us_automated_bank_transfer - US Automated Bank Transfer * gb_automated_bank_transfer - UK Automated Bank Transfer Possible values:
Default value: "ach_credit" |
reference_id |
String | Yes |
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). |
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.