POST /payment_sources/create_voucher_payment_source

Create a voucher payment method for the payment source.

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: `"all-disabled"`
`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: `"all-disabled"`
`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: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`customer_id`	String	Yes	Identifier of the customer with whom this payment source is associated.
`voucher_payment_source`	Object	No	Parameters for voucher_payment_source
`voucher_payment_source.tax_id`	String	No	Customer Tax id
`voucher_payment_source.gateway_account_id`	String	No	The gateway account to which the payment method is associated.
`voucher_payment_source.voucher_type`	String	Yes	Voucher based payment methods * boleto - Boleto Valid values: `"boleto"`
`voucher_payment_source.billing_address`	Object	No	The billing address of the customer. The value is a JSON object with the following keys and their values: `first_name`:(string, max chars=150) The first name of the contact. `last_name`:(string, max chars=150) The last name of the contact. `line1`:(string, max chars=180) The first line of the address. `line2`:(string, max chars=180) The second line of the address. `country_code`:(string, max chars=50) The two-letter, ISO 3166 alpha-2 country code for the address. `state_code`:(string, max chars=50) The ISO 3166-2 state/province code without the country prefix.For instance, for Arizona (USA), set state_code as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC)`. `city`:(string, max chars=50) The city name for the address. `postal_code`:(string, max chars=20) The postal or ZIP code for the address. `phone`:(string, max chars=50) The contact phone number for the address. `email`:(string, max chars=70) The contact email address for the address. </ul

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.