List of payments - Swipe

List of payments

curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/payment/list \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.getswipe.in/api/partner/v2/payment/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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
  }
}

{
  "success": false,
  "error_code": "",
  "message": "",
  "errors": {},
  "data": {}
}

{
  "success": false,
  "error_code": "",
  "message": "",
  "errors": {},
  "data": {}
}

{
  "success": false,
  "error_code": "",
  "message": "",
  "errors": {},
  "data": {}
}

GET

/

v2

/

payment

/

list

List of payments

curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/payment/list \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.getswipe.in/api/partner/v2/payment/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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
  }
}

{
  "success": false,
  "error_code": "",
  "message": "",
  "errors": {},
  "data": {}
}

{
  "success": false,
  "error_code": "",
  "message": "",
  "errors": {},
  "data": {}
}

{
  "success": false,
  "error_code": "",
  "message": "",
  "errors": {},
  "data": {}
}

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.

Query Parameters

start_date

string

default:01-01-2024

required

Start date for the list, [DD-MM-YYYY]

end_date

string

default:31-12-2024

required

End date for the list, [DD-MM-YYYY]

status

string

default:success

required

Filter list based on active status of the payment

num_records

integer

default:10

Number of records to fetch

page

integer

default:1

Page number

Response

Payment details fetched successfully

success

boolean

Success flag

Example:

true

message

string

Response message

Example:

"Subscription List fetched successfully"

error_code

string

Error code

Example:

""

errors

object

Errors

data

object

Show child attributes