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

Record payment

cURL

curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 27,
  "payment_date": "13-06-2024",
  "payment_mode": "UPI",
  "customer": "CUST123"
}
'

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Body

application/json

amount · number · required

Amount to be paid

Example:

27

payment_date · string · required

Payment date [DD-MM-YYYY]

Example:

"13-06-2024"

payment_mode · enum<string> · required

Payment mode

Available options: Cash, Cheque, UPI, Card, Net Banking, paylater, cardless_emi, EMI, TDS, Credits, Opening Balance

Example:

"UPI"

customer · string · required

Customer ID

Example:

"CUST123"

bank_details · object

Show child attributes

notes · string

Notes, will be shared with the customer

Example:

""

send_sms · boolean

Send SMS, customer will be notified through SMS

Example:

true

send_email · boolean

Send Email, customer will be notified through Email

Example:

true

exclusive_notes · string

Exclusive Notes for internal purpose

Example:

""

documents · object[]

Documents to be settled, if any

Show child attributes

Example:

[
  {
    "amount_paying": 27,
    "hash_id": "SLascded"
  }
]

Response

200

application/json

Payment recorded successfully

success · boolean

Success flag

Example:

true

message · string

Response message

Example:

"Message"

error_code · string

Error Code

Example:

""

errors · object

Errors

data · object

Show child attributes