POST /invoices/{invoice-id}/record_payment

To record offline payments (Cash,Check etc) for 'payment_due' or 'not_paid' invoices.

The invoice status will be marked as 'paid' when the amount that is due is recorded.

Servers

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

Path parameters

Name	Type	Required	Description
`invoice-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-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
`reference_number`	String	No	The reference number for this transaction. For example, the check number when payment_method = `check`.
`amount`	Integer	No	Amount paid. If this parameter is not passed then the entire invoice due amount will be recorded.
`payment_method`	String	Yes	The payment method of this transaction. * card - Card * cash - Cash * bank_transfer - Bank Transfer * paypal_express_checkout - Paypal Express Checkout * amazon_payments - Amazon Payments * check - Check * direct_debit - Direct Debit * 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. * other - Payment Methods other than the above types Possible values: `"check"` `"other"` `"cash"` `"direct_debit"` `"bank_transfer"`
`memo`	String	No	A short description or note regarding the payment received. This will be the description in the transaction created.
`paid_at`	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.