Order operations

Refund, void, or capture an order

Performs an operation against an existing order, selected by the apiOperation field in the body:

  • REFUND — repay your customer in part or fully. For partial refunds pass an amount in transaction. The refund amount must not exceed the amount of the original transaction. Refunds use your available Kashier balance (pending balance excluded). Refund statuses: SUCCESS (processed by the processor), FAILURE (cannot be processed; your account is credited with the refund amount), PENDING (initiated, waiting for the processor).
  • VOID — cancel the order's transaction amount fully or partially. You can cancel a pay, refund, authorize, or capture transaction; pass the targetTransactionId returned in a previous response.
  • CAPTURE — capture a previously authorized amount fully or partially. You should capture the amount before 7 or 30 days depending on your configuration. The Authorization Capture feature must be enabled by contacting your account manager or customer success. Releasing an authorized amount back to the customer is done with the VOID operation.

Authentication. Send your secret key in the Authorization header, as you do for the Dashboard API. This route is not the same as the pay call: creating an order (POST /v3/orders) is gated by a Kashier-Hash header and takes no secret key, while refund, void and capture are authenticated by your secret key, and refund and void additionally require the refund permission on the key's role. Do not send a Kashier-Hash on this route.

put/v3/orders/{orderId}

Request

  • Base URL: https://test-fep.kashier.io
  • URL: https://test-fep.kashier.io/v3/orders/{orderId}
  • Auth: API key in header Authorization

Path parameters

orderIdstring required

Kashier Order Id

Request body

OR
OR

Response

Operation result. response.status reflects the resulting order state (e.g. PARTIALLY_REFUNDED order status for refunds, CANCELLED for voids, CAPTURED for captures) and the top-level status is SUCCESS when the request was processed.

responseobject
transactionIdstring
statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.