Get Started
Document V2
Payment V2
Customer V2
Vendor V2
Product V2
Subscriptions V2
Utility V2
List of payments
curl --request GET \
--url https://app.getswipe.in/api/partner/v2/payment/list \
--header 'Authorization: <api-key>'{
"success": true,
"message": "Subscription List fetched successfully",
"error_code": "",
"errors": {},
"data": {
"transactions": [
{
"total_amount": 1000,
"amount_remaining": "900",
"bank_details": {
"account_number": "1234567890",
"ifsc": "SBIN0000001",
"bank_name": "State Bank of India",
"branch": "Mumbai"
},
"customer": {
"id": "CUST123",
"name": "John Doe",
"country_code": "91",
"phone_number": "1234567890",
"email": "johndoe@example.com"
},
"payment_date": "11-06-2024",
"exclusive_notes": "<string>",
"linked_docs": [
{
"amount_settled": 100,
"serial_number": "INV-12",
"document_type": "invoice"
}
],
"notes": "<string>",
"payment_mode": "Cash",
"payment_type": "in",
"status": "success",
"created_by": "Manoj"
}
],
"total_records": 10
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Start date for the list, [DD-MM-YYY]
End date for the list, [DD-MM-YYY]
Filter list based on active status of the payment
Number of records to fetch
Page number
Response
Success flag
true
Response message
"Subscription List fetched successfully"
Error code
""
Errors
List of transactions
Amount of Payment
1000
Remaining amount after the settlement
"900"
Bank Details of payment for as document
Account Number
"1234567890"
IFSC Code
"SBIN0000001"
Bank Name
"State Bank of India"
Branch
"Mumbai"
Customer Details for the document
Unique id for each customer. If a new id is sent, a new Customer with the below details will be automatically created.
"CUST123"
Name of the Customer
"John Doe"
Customer Phone Number Country code
"91"
Customer Phone Number
"1234567890"
Customer Email
"johndoe@example.com"
Payment date [DD-MM-YYYY]
"11-06-2024"
Internal notes for the payment
List of documents linked to this payment
Amount settled for the document, from the payment
100
Invoice number assigned to document
"INV-12"
Type of document
"invoice"
Notes for the document
Payment mode of the recorded payment
"Cash"
Payment flow of the recorded payment
"in"
Active status of the payment
"success"
Document created by
"Manoj"
Total number of records
10
curl --request GET \
--url https://app.getswipe.in/api/partner/v2/payment/list \
--header 'Authorization: <api-key>'{
"success": true,
"message": "Subscription List fetched successfully",
"error_code": "",
"errors": {},
"data": {
"transactions": [
{
"total_amount": 1000,
"amount_remaining": "900",
"bank_details": {
"account_number": "1234567890",
"ifsc": "SBIN0000001",
"bank_name": "State Bank of India",
"branch": "Mumbai"
},
"customer": {
"id": "CUST123",
"name": "John Doe",
"country_code": "91",
"phone_number": "1234567890",
"email": "johndoe@example.com"
},
"payment_date": "11-06-2024",
"exclusive_notes": "<string>",
"linked_docs": [
{
"amount_settled": 100,
"serial_number": "INV-12",
"document_type": "invoice"
}
],
"notes": "<string>",
"payment_mode": "Cash",
"payment_type": "in",
"status": "success",
"created_by": "Manoj"
}
],
"total_records": 10
}
}