POST /tokens/create_using_temp_token
Generate a token using the one time token created by payment gateways for any specific payment method.
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 |
|---|---|---|---|
gw_obj_type |
String | No |
Represents what type of object at gateway eg. "token" in case Stripe token and "source" in case of Stripe Source. |
currency_code |
String | No |
Used to derieve Bank Account Scheme by default will take site default currency. |
token_billing_address |
Object | No |
Parameters for token_billing_address |
token_billing_address.line2 |
String | No |
Address line 2, as available in card billing address. |
token_billing_address.line1 |
String | No |
Address line 1, as available in card billing address. |
token_billing_address.state_code |
String | No |
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set |
token_billing_address.zip |
String | No |
Postal or Zip code, as available in card billing address. |
token_billing_address.state |
String | No |
The state/province name. |
token_billing_address.country_code |
String | No |
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code. Note: If you enter an invalid country code, the system will return an error. Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then |
token_billing_address.city |
String | No |
City, as available in card billing address. |
gateway_account_id |
String | No |
The gateway account to which the token is associated. |
payment_method_type |
String | Yes |
Type of payment method of the token. * google_pay - Payments made via Google Pay. * apple_pay - Payments made via Apple Pay. * unionpay - Payments made via UnionPay. * ideal - Payments made via iDEAL. * amazon_payments - Payments made via Amazon Payments. * bancontact - Payments made via Bancontact Card. * netbanking_emandates - Netbanking (eMandates) Payments. * alipay - Payments made via Alipay. Valid values:
|
additional_information |
Object | No |
|
token_additional_detail |
Object | No |
Parameters for token_additional_detail |
token_additional_detail.last_name |
String | No |
Cardholder's last name |
token_additional_detail.first_name |
String | No |
Cardholder's first name |
token_additional_detail.expiry_year |
Integer | No |
Card expiry year. |
token_additional_detail.expiry_month |
Integer | No |
Card expiry month. |
id_at_vault |
String | Yes |
Single-use token created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details. |
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.