GEgetswipe
Payment V2

List of payments

Changed on

Lists payments recorded within a required date range.

get/v2/payment/list

Request

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

Query parameters

start_datestring required

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

end_datestring required

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

statusstring required

Filter list based on active status of the payment

num_recordsinteger

Number of records to fetch

pageinteger

Page number

Response

Payment details fetched successfully

successboolean

Success flag

messagestring

Response message

error_codestring

Error code

errorsobject

Errors

Example response

{
  "success": true,
  "message": "Subscription List fetched successfully",
  "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",
        "linked_docs": [
          {
            "amount_settled": 100,
            "serial_number": "INV-12",
            "document_type": "invoice"
          }
        ],
        "payment_mode": "Cash",
        "payment_type": "in",
        "status": "success",
        "created_by": "Manoj"
      }
    ],
    "total_records": 10
  }
}

Changes

  • 0bcdbc62187bRevision changes
    • breaking

      the /// response's property type changed from object to no type for status

    • breaking

      the /// response's property type changed from object to no type for status

    • info

      api operation id v2_get_timeline removed and replaced with get_timeline