List Installment links

post

https://backend.sa.amwal.tech/payment_links/{store_id}/

Path Params

store_id

string

required

Your store ID

Body Params

page

integer

≥ 1

Defaults to 1

Page number for pagination. Use this to navigate through multiple pages of results.

page_size

integer

1 to 100

Defaults to 10

Number of payment links to return per page. Maximum is 100. Higher values may impact performance.

string

length ≤ 100

Search term to filter payment links. Searches in title, description, customer name, email, terminal_id, and cashier_id. Case-insensitive.

payment_mode

string

enum

Defaults to all

Filter by payment mode. 'online' for traditional payment links, 'in_store' for POS transactions, 'all' for both.

Allowed:

branch

string

length ≤ 50

Filter by specific branch. Useful for multi-location businesses to view transactions by location.

status

string

enum

Defaults to all

Filter by payment status. For in-store, 'Paid' transactions are most relevant for reporting.

Allowed:

date_from

date

Filter transactions from this date (inclusive). Format: YYYY-MM-DD

date_to

date

Filter transactions until this date (inclusive). Format: YYYY-MM-DD

sort_by

string

enum

Defaults to created_at

Field to sort results by. Most commonly used is 'created_at' for chronological order.

Allowed:

sort_order

string

enum

Defaults to desc

Sort direction. 'desc' shows newest/highest first, 'asc' shows oldest/lowest first.

Allowed:

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Online payment links retrieved successfully with summary statistics for reporting

400Invalid request parameters