import { RefundReason } from "../../../../models"; /** * @oas [post] /admin/payments/{id}/refund * operationId: "PostPaymentsPaymentRefunds" * summary: "Refund Payment" * description: "Refund a payment. The payment must be captured first." * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Payment. * requestBody: * content: * application/json: * schema: * $ref: "#/components/schemas/AdminPostPaymentRefundsReq" * x-codegen: * method: refundPayment * x-codeSamples: * - lang: JavaScript * label: JS Client * source: | * import Medusa from "@medusajs/medusa-js" * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * // must be previously logged in or use api token * medusa.admin.payments.refundPayment(paymentId, { * amount: 1000, * reason: "return", * note: "Do not like it", * }) * .then(({ payment }) => { * console.log(payment.id); * }); * - lang: Shell * label: cURL * source: | * curl -X POST '{backend_url}/admin/payments/pay_123/refund' \ * -H 'Authorization: Bearer {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ * "amount": 1000, * "reason": "return", * "note": "Do not like it" * }' * security: * - api_token: [] * - cookie_auth: [] * tags: * - Payments * responses: * 200: * description: OK * content: * application/json: * schema: * $ref: "#/components/schemas/AdminRefundRes" * "400": * $ref: "#/components/responses/400_error" * "401": * $ref: "#/components/responses/unauthorized" * "404": * $ref: "#/components/responses/not_found_error" * "409": * $ref: "#/components/responses/invalid_state_error" * "422": * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" */ declare const _default: (req: any, res: any) => Promise; export default _default; /** * @schema AdminPostPaymentRefundsReq * type: object * required: * - amount * - reason * properties: * amount: * description: The amount to refund. * type: integer * reason: * description: The reason for the Refund. * type: string * note: * description: A note with additional details about the Refund. * type: string */ export declare class AdminPostPaymentRefundsReq { amount: number; reason: RefundReason; note?: string; }