GET
/
admin
/
payments
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.payment.list()
.then(({ payments, count, limit, offset }) => {
  console.log(payments)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "payments": [
    {
      "id": "<string>",
      "amount": 123,
      "authorized_amount": 123,
      "currency_code": "<string>",
      "provider_id": "<string>",
      "data": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "captured_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "captured_amount": 123,
      "refunded_amount": 123,
      "captures": [
        {
          "id": "<string>",
          "amount": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "payment": {}
        }
      ],
      "refunds": [
        {
          "id": "<string>",
          "amount": 123,
          "refund_reason_id": "<string>",
          "note": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "payment": {
            "id": "<string>",
            "amount": 123,
            "authorized_amount": 123,
            "currency_code": "<string>",
            "provider_id": "<string>",
            "data": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "captured_at": "2023-11-07T05:31:56Z",
            "canceled_at": "2023-11-07T05:31:56Z",
            "captured_amount": 123,
            "refunded_amount": 123,
            "captures": [
              {
                "id": "<string>",
                "amount": 123,
                "created_at": "2023-11-07T05:31:56Z",
                "created_by": "<string>",
                "payment": {}
              }
            ],
            "refunds": [
              {
                "id": "<string>",
                "amount": 123,
                "refund_reason_id": "<string>",
                "note": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "created_by": "<string>",
                "payment": {},
                "refund_reason": {
                  "id": "<string>",
                  "label": "<string>",
                  "description": "<string>",
                  "metadata": {},
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z"
                }
              }
            ],
            "payment_collection": {},
            "payment_session": {}
          },
          "refund_reason": {
            "id": "<string>",
            "label": "<string>",
            "description": "<string>",
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "payment_collection": {},
      "payment_session": {
        "id": "<string>",
        "amount": 123,
        "currency_code": "usd",
        "provider_id": "<string>",
        "data": {},
        "context": {
          "customer": {
            "id": "cus_123"
          }
        },
        "status": "authorized",
        "authorized_at": "2023-11-07T05:31:56Z",
        "payment_collection": {},
        "payment": {
          "id": "<string>",
          "amount": 123,
          "authorized_amount": 123,
          "currency_code": "<string>",
          "provider_id": "<string>",
          "data": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "captured_at": "2023-11-07T05:31:56Z",
          "canceled_at": "2023-11-07T05:31:56Z",
          "captured_amount": 123,
          "refunded_amount": 123,
          "captures": [
            {
              "id": "<string>",
              "amount": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "created_by": "<string>",
              "payment": {}
            }
          ],
          "refunds": [
            {
              "id": "<string>",
              "amount": 123,
              "refund_reason_id": "<string>",
              "note": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "created_by": "<string>",
              "payment": {},
              "refund_reason": {
                "id": "<string>",
                "label": "<string>",
                "description": "<string>",
                "metadata": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            }
          ],
          "payment_collection": {},
          "payment_session": {}
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
q
string

Search term to filter the payment's searchable properties.

​
id

Filter by a payment ID.

​
payment_session_id

Filter by a payment session ID to retrieve its associated payments.

​
created_at
object

Filter by the payment's creation date.

​
updated_at
object

Filter by the payment's update date.

​
deleted_at
object

Filter by the payment's deletion date.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

200
application/json

OK

The paginated list of payments.