Istores API Documentation
MyIstores Api

Payment links

Endpoint:https://api.istores.co.il

List payment links

POST
https://api.istores.co.il
/payment_link

Get payment links with optional filters

List payment links › Request Body
optional

  • date_fromstring · date

    Start date for the filter

    Example: 2026-07-01
  • date_tostring · date

    End date for the filter

    Example: 2026-07-31
  • namestring

    Filter payment links by name

    Example: Summer campaign
  • limitinteger · min: 1 · max: 1000
    Default: 10
  • pageinteger · min: 1 · max: 999
    Default: 1

List payment links › Responses

Payment links list

  • successboolean
    Example: true
  • responseobject[]
  • resultsnumber
    Example: 233
  • pagesnumber
    Example: 100
  • pagenumber
    Example: 4
  • per_pagenumber
    Example: 2
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Create payment link

POST
https://api.istores.co.il
/payment_link/create

Create a payment link

Create payment link › Request Body

  • namestring · maxLength: 96 · required
    Example: Summer campaign
  • statusinteger · enum · required
    Enum values:
    0
    1
    Example: 1
  • itemsobject[] · minItems: 1 · required

Create payment link › Responses

Payment link created successfully

  • successboolean
    Example: true
  • payment_linkobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Get payment link

GET
https://api.istores.co.il
/payment_link/{payment_link_id}

Get payment link details by its id

Get payment link › path Parameters

  • payment_link_idinteger · required

    Payment link ID

Get payment link › Responses

Payment link details

  • successboolean
    Example: true
  • payment_linkobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Update payment link

PUT
https://api.istores.co.il
/payment_link/{payment_link_id}

Update an existing payment link

Update payment link › path Parameters

  • payment_link_idinteger · required

    Payment link ID

Update payment link › Request Body

  • namestring · maxLength: 96 · required
    Example: Summer campaign
  • statusinteger · enum · required
    Enum values:
    0
    1
    Example: 1
  • itemsobject[] · minItems: 1 · required

Update payment link › Responses

Payment link updated successfully

  • successboolean
    Example: true
  • payment_linkobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Delete payment link

DELETE
https://api.istores.co.il
/payment_link/{payment_link_id}

Delete a payment link by its id

Delete payment link › path Parameters

  • payment_link_idinteger · required

    Payment link ID

Delete payment link › Responses

Payment link deleted successfully

  • successboolean
    Example: true
  • responseobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Download payment link QR code

GET
https://api.istores.co.il
/payment_link/{payment_link_id}/generate_qr

Download the payment link QR code

Download payment link QR code › path Parameters

  • payment_link_idinteger · required

    Payment link ID

Download payment link QR code › Responses

string

Refresh payment link expiry

PUT
https://api.istores.co.il
/payment_link/{payment_link_id}/expiry_refresh

Refresh payment link expiry

Refresh payment link expiry › path Parameters

  • payment_link_idinteger · required

    Payment link ID

Refresh payment link expiry › Request Body

  • refreshboolean · required

Refresh payment link expiry › Responses

Payment link expiry refreshed successfully

  • successboolean
    Example: true
  • payment_linkobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49
Custom ordersCustom_field