List of payments

GET /v2/payment/list

Try it

List of payments

cURL

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

200

{
  "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": "[e-mail]"
        },
        "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

Authorization · string · header · required

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

Query Parameters

start_date · string · default: 01-01-2024 · required

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

end_date · string · default: 31-12-2024 · required

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

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

200

application/json

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

data. transactions · object[]

List of transactions

Show child attributes

data.transactions. total_amount · number

Amount of Payment

Example:

1000

data.transactions. amount_remaining · string

Remaining amount after the settlement

Example:

"900"

data.transactions. bank_details · object

Bank Details of payment for as document

Show child attributes

data.transactions.bank_details. account_number · string · required

Account Number

Example:

"1234567890"

data.transactions.bank_details. ifsc · string · required

IFSC Code

Example:

"SBIN0000001"

data.transactions.bank_details. bank_name · string · required

Bank Name

Example:

"State Bank of India"

data.transactions.bank_details. branch · string · required

Branch

Example:

"Mumbai"

data.transactions. customer · object

Customer Details for the document

Show child attributes

data.transactions.customer. id · string · required

Unique id for each customer. If a new id is sent, a new Customer with the below details will be automatically created.

Example:

"CUST123"

data.transactions.customer. name · string · required

Name of the Customer

Example:

"John Doe"

data.transactions.customer. country_code · string

Customer Phone Number Country code

Example:

"91"

data.transactions.customer. phone_number · string

Customer Phone Number

Example:

"1234567890"

data.transactions.customer. email · string

Customer Email

Example:

"[e-mail]"

data.transactions. payment_date · string

Payment date [DD-MM-YYYY]

Example:

"11-06-2024"

data.transactions. exclusive_notes · string

Internal notes for the payment

data.transactions. linked_docs · object[]

List of documents linked to this payment

Show child attributes

data.transactions.linked_docs. amount_settled · number

Amount settled for the document, from the payment

Example:

100

data.transactions.linked_docs. serial_number · string

Invoice number assigned to document

Example:

"INV-12"

data.transactions.linked_docs. document_type · string

Type of document

Example:

"invoice"

data.transactions. notes · string

Notes for the document

data.transactions. payment_mode · string

Payment mode of the recorded payment

Example:

"Cash"

data.transactions. payment_type · string

Payment flow of the recorded payment

Example:

"in"

data.transactions. status · string

Active status of the payment

Example:

"success"

data.transactions. created_by · string

Document created by

Example:

"Manoj"

data. total_records · integer

Total number of records

Example:

10