GEgetswipe
Payment V2

Record payment

Records a payment received from a customer. Optionally settle specific documents by pairing each hash_id with an amount_paying — partial settlement is supported and the document's payment status tracks what remains. Non-cash payment modes need a bank account configured on your account, otherwise the request fails with MISSING_BANK_ACCOUNT. Set send_sms or send_email to notify the customer.

post/v2/payment

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v2/payment
  • Auth
    HTTP bearer

Request body

amountnumber required

Amount to be paid

payment_datestring required

Payment date [DD-MM-YYYY]

payment_mode'Cash' | 'Cheque' | 'UPI' | 'Card' | 'Net Banking' | 'paylater' | 'cardless_emi' | 'EMI' | 'TDS' | 'Credits' | 'Opening Balance' required

Payment mode

notesstring

Notes, will be shared with the customer

send_smsboolean

Send SMS, customer will be notified through SMS

send_emailboolean

Send Email, customer will be notified through Email

exclusive_notesstring

Exclusive Notes for internal purpose

customerstring required

Customer ID

Example request

{
  "amount": 27,
  "payment_date": "13-06-2024",
  "bank_details": {
    "account_number": "1234567890",
    "ifsc": "SBIN0000001",
    "bank_name": "State Bank of India",
    "branch": "Mumbai"
  },
  "payment_mode": "UPI",
  "send_sms": true,
  "send_email": true,
  "customer": "CUST123",
  "documents": [
    {
      "amount_paying": 27,
      "hash_id": "SLascded"
    }
  ]
}

Response

Payment recorded successfully

successboolean

Success flag

messagestring

Response message

error_codestring

Error Code

errorsobject

Errors

Example response

{
  "success": true,
  "message": "Message",
  "data": {
    "serial_number": "INV-123"
  }
}

Changes