Salla Docs
Merchant API
Partner APIs
Storefront
Salla CLI
Salla Docs

    [lightMode]

    List Transactions

    GET/transactions
    [updatedIn] 2 months ago

    This endpoints allows you to list all of the Store Owner's payment transactions

    `transactions.read`- Transactions Read Only

    Request

    Authorization: OAuth 2.0
    Add the parameter
    Authorization
    to [header]    ，whose value is to concatenate the Token after the Bearer.
    [api.label.example]
    Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
    [message.queryParameter]
    page
    integer 
    optional

    Pagination Page

    Example:
    1
    last_4_digit
    integer 
    optional

    Account's Last 4 Digits

    Example:
    8490
    status
    enum<string> 
    optional

    Payment Status, as shown in the enum values

    Allowed values:
    initiatedpendingpaidcanceledrefundedpartial_refunded
    Example:
    paid
    amount
    number 
    optional

    Amount Paid

    Example:
    100
    order_id
    integer 
    optional

    The unqiue ID of the Order. List of Order IDs can be found here

    Example:
    982374933

    Request samples

    [api.label.responses]

    Success(200)
    Error Validation(422)
    HTTP Code: 200
    Content Type : JSONapplication/json
    [response.label.jsonSchema]
    status
    integer 
    optional

    Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

    success
    boolean 
    optional

    Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes. NEW

    data
    array[object (Transaction) {10}] 
    optional
    id
    integer 
    required

    A unique alphanumeric code assigned to each individual transaction. List of transactions can be found here.

    customer
    object 
    required
    references
    object 
    required
    total
    object 
    required
    payment_method
    object 
    required
    status
    object 
    required
    card
    object 
    required
    available_actions
    array[string]
    required
    Allowed values:
    printrefund
    created_at
    object (Date) 
    required
    notes
    string  | null 
    required

    Transaction notes

    Example:
    Transaction Notes
    pagination
    object (Pagination) 
    optional

    For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

    count
    number 
    required

    Number of returned results.

    total
    number 
    required

    Number of all results.

    perPage
    number 
    required

    Number of results per page.

    <= 65
    currentPage
    number 
    required

    Number of current page.

    totalPages
    number 
    required

    Number of total pages.

    links
    object 
    required

    Array of linkes to next and previous pages.

    [api.label.example]Success (200)
    {
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 19940416533,
      "customer": {
        "id": 48447423,
        "email": "[email protected]",
        "mobile": "+966512345678",
        "first_name": "Ahmed",
        "last_name": "Adel"
      },
      "references": {
        "order_id": 413420930,
        "cart_id": 171420334123,
        "transaction": 44556293650
      },
      "total": {
        "amount": 121,
        "currency": "SAR"
      },
      "payment_method": {
        "name": "mada",
        "slug": "mada",
        "icon": "https://cdn.assets.salla.network/prod/admin/cp/assets/images/payment_methods/4.png"
      },
      "status": {
        "name": "مؤكدة",
        "slug": "paid"
      },
      "card": {
        "brand": "mada",
        "number": "123123xxxxxx6789",
        "country": "SA"
      },
      "available_actions": [
        "refund",
        "print"
      ],
      "created_at": {
        "date": "2024-07-04 03:33:36.000000",
        "timezone_type": 3,
        "timezone": "Asia/Riyadh"
      },
      "notes": null
    },
    {
      "id": 7172398767,
      "customer": {
        "id": 357838499,
        "email": "[email protected]",
        "mobile": "+966591234567",
        "first_name": "Customer",
        "last_name": "Name"
      },
      "references": {
        "order_id": 637894790,
        "cart_id": 1044130972,
        "transaction": 555984480243
      },
      "total": {
        "amount": 121,
        "currency": "SAR"
      },
      "payment_method": {
        "name": "mada",
        "slug": "mada",
        "icon": "https://cdn.assets.salla.network/prod/admin/cp/assets/images/payment_methods/4.png"
      },
      "status": {
        "name": "ملغية",
        "slug": "canceled"
      },
      "card": {
        "brand": "mada",
        "number": "123123xxxxxx4567",
        "country": "SA"
      },
      "available_actions": [
        "refund"
      ],
      "created_at": {
        "date": "2024-06-30 05:01:13.000000",
        "timezone_type": 3,
        "timezone": "Asia/Riyadh"
      },
      "notes": "تم رفض العملية من قبل البنك يرجى استخدام وسيلة دفع اخرى"
    }
  ],
  "pagination": {
    "count": 4,
    "total": 19,
    "perPage": 15,
    "currentPage": 2,
    "totalPages": 2,
    "links": {
      "next": "http://api.salla.dev/admin/v2/payment/transactions?page=2"
    }
  }
}
    [updatedIn] 2 months ago