Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.01 KB

v1-create-refund-request.md

File metadata and controls

34 lines (25 loc) · 1.01 KB

V1 Create Refund Request

V1CreateRefundRequest

Structure

V1 Create Refund Request

Fields

Name Type Tags Description
payment_id string Required The ID of the payment to refund. If you are creating a PARTIAL
refund for a split tender payment, instead provide the id of the
particular tender you want to refund.
type str (V1 Create Refund Request Type) Required -
reason string Required The reason for the refund.
refunded_money V1 Money Optional -
request_idempotence_key string Optional An optional key to ensure idempotence if you issue the same PARTIAL refund request more than once.

Example (as JSON)

{
  "payment_id": "payment_id0",
  "type": "FULL",
  "reason": "reason4",
  "refunded_money": {
    "amount": 214,
    "currency_code": "CHW"
  },
  "request_idempotence_key": "request_idempotence_key8"
}