Admin Orders

Create Refund

post/api/v1/admin/orders/{order_id}/refunds

Request

  • Base URL: https://api.g3m.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.g3m.co/api/v1/admin/orders/{order_id}/refunds
  • Auth: none declared. Required headers: Idempotency-Key

Path parameters

order_idstring uuid required

Headers

Idempotency-Keystring required

Request body

action'cancel_customer_cost' | 'cancel_full_refund' | 'partial_refund' required
amount_centsinteger nullable
reasonstring required
internal_notestring nullable

Response

Successful Response

idstring uuid required
payment_idstring uuid required
order_idstring uuid required
created_by_admin_idstring uuid required
action'cancel_customer_cost' | 'cancel_full_refund' | 'partial_refund' required
status'pending' | 'succeeded' | 'failed' required
gross_paid_centsinteger required
refund_amount_centsinteger required
retained_amount_centsinteger required
currencystring required
reasonstring required
internal_notestring nullable required
stripe_refund_idstring nullable required
stripe_credit_note_idstring nullable required
stripe_credit_note_numberstring nullable required
stripe_credit_note_pdf_urlstring nullable required
failure_codestring nullable required
failure_messagestring nullable required
created_atstring date-time required
updated_atstring date-time required
succeeded_atstring date-time nullable required

Changes

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