Skip to main content
POST
/
admin
/
payments
/
{id}
/
refund
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.refund("paycol_123", {})
.then(({ payment }) => {
  console.log(payment)
})
{
  "payment": {
    "id": "<string>",
    "amount": 123,
    "currency_code": "<string>",
    "provider_id": "<string>",
    "authorized_amount": 123,
    "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",
        "payment": {},
        "created_by": "<string>"
      }
    ],
    "refunds": [
      {
        "id": "<string>",
        "amount": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "payment": {
          "id": "<string>",
          "amount": 123,
          "currency_code": "<string>",
          "provider_id": "<string>",
          "authorized_amount": 123,
          "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",
              "payment": {},
              "created_by": "<string>"
            }
          ],
          "refunds": [
            {
              "id": "<string>",
              "amount": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "payment": {},
              "refund_reason_id": "<string>",
              "note": "<string>",
              "created_by": "<string>",
              "refund_reason": {
                "id": "<string>",
                "label": "<string>",
                "metadata": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "description": "<string>"
              }
            }
          ],
          "payment_collection": {},
          "payment_session": {}
        },
        "refund_reason_id": "<string>",
        "note": "<string>",
        "created_by": "<string>",
        "refund_reason": {
          "id": "<string>",
          "label": "<string>",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "description": "<string>"
        }
      }
    ],
    "payment_collection": {},
    "payment_session": {
      "id": "<string>",
      "amount": 123,
      "currency_code": "usd",
      "provider_id": "<string>",
      "data": {},
      "status": "authorized",
      "context": {
        "customer": {
          "id": "cus_123"
        }
      },
      "authorized_at": "2023-11-07T05:31:56Z",
      "payment_collection": {},
      "payment": {
        "id": "<string>",
        "amount": 123,
        "currency_code": "<string>",
        "provider_id": "<string>",
        "authorized_amount": 123,
        "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",
            "payment": {},
            "created_by": "<string>"
          }
        ],
        "refunds": [
          {
            "id": "<string>",
            "amount": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "payment": {},
            "refund_reason_id": "<string>",
            "note": "<string>",
            "created_by": "<string>",
            "refund_reason": {
              "id": "<string>",
              "label": "<string>",
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "description": "<string>"
            }
          }
        ],
        "payment_collection": {},
        "payment_session": {}
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The payment's ID.

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.

Body

application/json

The refund's details.

​
amount
number

The amount to refund.

​
refund_reason_id
string

The ID of a refund reason.

​
note
string

A note to attach to the refund.

Response

OK

The payment's details.

​
payment
object
required

The payment's details.