POST
/
admin
/
payments
/
{id}
/
refund
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,
"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.

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.

Response

200
application/json

OK

The payment's details.