Skip to main content
POST
/
v1
/
payment
Record payment
curl --request POST \
  --url https://app.getswipe.in/api/partner/v1/payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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",
  "notes": "",
  "send_sms": true,
  "send_email": true,
  "exclusive_notes": "",
  "customer": "CUST123",
  "documents": [
    {
      "amount_paying": 27,
      "hash_id": "SLascded"
    }
  ]
}'
{
  "success": true,
  "message": "Payment Recorded successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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
Example:

"UPI"

​
customer
string
required

Customer ID

Example:

"CUST123"

​
bank_details
object
​
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

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

Response

Payment recorded successfully

​
success
boolean

Success flag

Example:

true

​
message
string

Response message

Example:

"Payment Recorded successfully"