POST /customers/{customer-id}/record_excess_payment

Use this API to record any excess payments made by the customer, such as advance payments. Such payments will be automatically applied to the future invoices. It can also be manually applied to the existing Not Paid or Payment Due invoices.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`customer-id`	String	Yes

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

Request body fields

Name	Type	Required	Description
`comment`	String	No	Remarks, if any, on the payment.
`transaction`	Object	No	Parameters for transaction
`transaction.reference_number`	String	No	The reference number for this transaction. e.g check number in case of 'check' payments.
`transaction.custom_payment_method_id`	String	No	Identifier of the custom payment method of this transaction.
`transaction.currency_code`	String	No	The currency code (ISO 4217 format) for the transaction.
`transaction.amount`	Integer	Yes	The payment transaction amount
`transaction.payment_method`	String	Yes	The payment method of this transaction * cash - Cash * paypal_express_checkout - Paypal Express Checkout * automated_bank_transfer - Automated Bank Transfer * venmo - Venmo * bancontact - Bancontact * custom - Custom * ideal - IDEAL * check - Check * upi - upi * sepa_instant_transfer - Sepa Instant Transfer * alipay - Alipay * sepa_credit - SEPA Credit * ach_credit - ACH Credit * faster_payments - Faster Payments * sofort - Sofort * direct_debit - Direct Debit * bank_transfer - Bank Transfer * chargeback - Only applicable for a transaction of type = `refund`. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a refund. * unionpay - Unionpay * apple_pay - Apple Pay * dotpay - Dotpay * netbanking_emandates - netbanking_emandates * amazon_payments - Amazon Payments * wechat_pay - WeChat Pay * google_pay - Google Pay * card - Card * klarna_pay_now - Klarna Pay Now * other - Payment Methods other than the above types * boleto - boleto * giropay - giropay * pay_to - PayTo Possible values: `"check"` `"other"` `"cash"` `"bank_transfer"` `"custom"`
`transaction.date`	Integer	Yes	Indicates when this transaction occurred.

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.