Collect Estimate/Invoice Payment

Changed on

collect payment done through card and update invoice/estimate status

post/v2/customer_portal/payments/pay_amount

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/v2/customer_portal/payments/pay_amount
  • Auth
    API key in header x-api-key

Request body

sourcestring
payment_datestring
payment_mode_uidstring
receipt_emailstring
reference_nostring
remarksstring
send_receiptboolean
amount_paidinteger
card_idstring
invoice_statusstring
invoice_uidstring
estimate_uidstring
currencystring
payment_transaction_uidstring
charge_cardboolean
card_on_fileboolean

Response

200

typestring
titlestring
messagestring

Example response

{
  "type": "success",
  "title": "Invoice paid successfully",
  "message": "Invoice paid successfully",
  "data": {
    "invoice_uid": "985b2194-dc41-4fb2-a170-291303abad22",
    "paid_amount": 183.52,
    "total_amount": 183.52
  }
}

Changes