Refund a card payment (v1)

PUT/v1/api/store/{team_slug}/sales_order/{hash_id}/payment_gateway_refund/{id}

v1Legacy · deprecatedOperation ID v1_public_sales_order_payment_gateway_refund

Legacy (deprecated)

A newer operation does this better.Use Refund a card payment through the gateway (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; see Deprecated operations.

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_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  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
• idstringrequired

  The card payment's id (a hash id).

  • Example JMQ642WFe4sANJ

Request body

application/json, required.

• amountintegerrequired

  How much to refund, in thousandths. Required in practice: see above.

  • Minimum 1
• locking_tokenstringrequired

  Your one-time token for this refund. Required.

• intentstring

  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"

Response

200Successful response.

• datanullrequired

  No data.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You 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.

• 404Not 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.

• 422The 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.

• 500A 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

• PUTRefund a card payment through the gateway/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_gateway_refund/{id}

Example request

curl

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"  }'

Example response 200

Response

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