---
# @generated by sylphx-gen. Do not edit.
title: "Refund a checkout session"
description: "`money.checkout_sessions.refund` (POST /v1/{name}:refund): Refund all or part of a paid one-time checkout."
type: reference
product: payments
summary: "Refund all or part of a paid one-time checkout."
updated: 2026-09-28
nav: false
---

Refund all or part of a paid one-time checkout.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/checkout_sessions/checkout-session:refund`
- **Scope** `billing:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [checkout_sessions](/docs/api/checkout_sessions)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The Money checkout resource to refund. Required. |
| `amount_minor` | `int64` | Optional partial amount in minor units; empty refunds the remaining amount. |
| `reason` | `string` | Optional processor refund reason. |
| `metadata` | `map<string, string>` | Caller metadata, such as the app's return and order ids. At most 20 keys. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `refund` | `Refund` | The refund receipt, read back from the processor after creation. Output only. |

### Refund

| Field | Type | What it is |
| --- | --- | --- |
| `id` | `string` | The processor's refund id. Output only. |
| `checkout_session` | `string` | The Money checkout resource this refund belongs to. Output only. |
| `payment_intent` | `string` | The processor payment intent the refund applies to. Output only. |
| `amount_minor` | `int64` | Amount refunded in minor units. Output only. |
| `currency_code` | `string` | ISO 4217 currency code. Output only. |
| `status` | `string` | The processor's refund status. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`UNAVAILABLE`](/docs/api/errors/UNAVAILABLE) — The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/checkout_sessions/checkout-session:refund" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**TypeScript**

```ts
const response = await sylphx.money.checkoutSessions.refund({ name: 'orgs/acme/projects/shop/envs/production/checkout_sessions/checkout-session' })
```

**Rust**

```rust
let mut req = sylphx::money::RefundCheckoutSessionRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/checkout_sessions/checkout-session".to_string();
let response = sx.money().checkout_sessions().refund(req).await?;
```

**CLI**

```bash
sylphx money checkout-sessions refund orgs/acme/projects/shop/envs/production/checkout_sessions/checkout-session
```

**MCP**

```json
{ "method_id": "money.checkout_sessions.refund", "args": {"name":"orgs/acme/projects/shop/envs/production/checkout_sessions/checkout-session"} }
```