# Refund a card payment (v1)

```http
PUT https://secure.yoprint.com/v1/api/store/{team_slug}/sales_order/{hash_id}/payment_gateway_refund/{id}
```

- Status: legacy, deprecated
- API version: v1
- Operation ID: `v1_public_sales_order_payment_gateway_refund`
- Section: Invoices and payments › [Payments](https://developer.yoprint.com/reference/payments.md)
- Web page: https://developer.yoprint.com/reference/payments/v1-sales-order-payment-gateway-refund/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

> **Legacy (deprecated).** A newer operation does this better: use [Refund a card payment through the gateway](https://developer.yoprint.com/reference/payments/v2-sales-order-payment-gateway-refund.md) (`PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_gateway_refund/{id}`) instead. Its answers say so in the `Deprecation` and `X-YoPrint-Successor` headers.

The older path for refunding a card payment. It runs exactly the same code as Refund a card payment through the gateway (`v2.public.sales_order.payment.gateway.refund`): use that one.

## Permission

Any member of the team.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The sales order's or quote's `id` (a hash id). The `ord_` unique key and the order number do not work here. Example `V4keXwwxMQyXw7`.
- `id` (string, required): The card payment's `id` (a hash id). Example `JMQ642WFe4sANJ`.

## Request body

Content type `application/json`, required.

Fields:

- `amount` (integer, required): How much to refund, in thousandths. Required in practice: see above. Minimum 1.
- `locking_token` (string, required): Your one-time token for this refund. Required.
- `intent` (string, optional): Accepted and not used: the refund is the same whatever you send. Any other value is refused with 422. One of: `"provider_refund_only"`, `"cancel_and_return_credit"`, `"return_to_source_credit"`.

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/sales_order/V4keXwwxMQyXw7/payment_gateway_refund/JMQ642WFe4sANJ' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 25000,
    "locking_token": "refund-1001-a"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (null, required): No data.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": null,
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: Another order's payment, a record that isn't a card payment, a Charge It Pro payment or a Customer Portal payment its provider can't refund (`refund_failed`); a payment from Customer Portal credit (`customer_payment_parent_refund_required`). Fix: Check the payment, or refund it in the provider's dashboard and record it with Record a refund.
  - When: The provider refused (`refund_processing_failed`). For Stripe the message says why (for example a disputed charge, or more than is left to refund) and `error.data` has `provider` `stripe` and `provider_error_code`. Fix: Read the message; check the payment in the provider's dashboard.
  - When: A payment is frozen by an open dispute or review (`customer_payment_disputed_funds_unavailable` or `invoice_payment_funding_withheld`, with `error.reason`). Fix: Wait for the provider's decision, then try again.
  - When: An Authorize.Net payment that hasn't settled (`invoice_payment_refund_requires_settlement`, `invoice_payment_refund_provider_state_invalid`), or the Customer Portal payment's provider account changed (`invoice_payment_provider_identity_mismatch`). Fix: Wait for settlement, or refund it in the provider's dashboard.
  - When: More than the payment can refund (`validation_error`, "Refund Amount greater than what payment can be refunded"). This is found after the provider refunded: check the provider before you do anything else. Fix: Refund at most the payment's `refundable_amount` plus unspent credit issued from it.
- `500` A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as `action_not_allowed`; an unexpected failure answers `{"message": "Server Error"}`. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.
  - When: No `amount`, an id that is no record of the team, or a payment through the old Square connection (`{"message": "Server Error"}`). Fix: Send `amount` and a card payment `id` (`payment_gateway` not null).

## Related

- [Refund a card payment through the gateway](https://developer.yoprint.com/reference/payments/v2-sales-order-payment-gateway-refund.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_gateway_refund/{id}`