---
title: "Changes to Refund Payment"
method: POST
path: "/api/v2/payments/{payment_id}/refund"
---

# Changes to Refund Payment

`POST /api/v2/payments/{payment_id}/refund`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 13 of 16 revisions.

- **2026-11-05** `9c73cbd109e4`: 1 warning, 3 info
- **2026-11-01** `f938a256fa91`: 3 warning
- **2026-10-28** `61006610408c`: 3 warning
- **2026-10-28** `6762ca2358ea`: 1 warning
- **2026-10-28** `bb23366f1a76`: 15 warning
- **2026-10-09** `dfac786362d9`: 7 warning
- **2026-10-01** `1d015757f82f`: 1 warning
- **2026-09-27** `887ba33c169b`: 2 warning
- **2026-09-15** `85261606a8ea`: 8 warning, 1 info
- **2026-09-11** `b1bbc301905b`: 2 warning
- **2026-09-07** `7269a6d9677f`: 3 warning, 2 info
- **2026-09-03** `515eeea7d260`: 15 warning, 2 info
- **2026-07-15** `9a960de24945`: 22 warning, 1 info

## Changes

- **2026-11-05** `9c73cbd109e4`: 1 warning, 3 info
  - added the new `DISPOSABLE_EMAIL_NOT_ALLOWED` enum value to the `error/code` response property for the response status `400`
  - added the optional property `created_by_id` to the response with the `200` status
  - added the optional property `created_by_type` to the response with the `200` status
  - added the optional property `organization_id` to the response with the `200` status
- **2026-11-01** `f938a256fa91`: 3 warning
  - added the new `PAYMENT_REFUND_BEFORE_SUCCESS` enum value to the `error/code` response property for the response status `400`
  - added the new `PAYMENT_REFUND_CONFLICT` enum value to the `error/code` response property for the response status `400`
  - added the new `PAYMENT_REFUND_NOT_RECORDED` enum value to the `error/code` response property for the response status `400`
- **2026-10-28** `61006610408c`: 3 warning
  - added the new `INVOICE_CANCEL_CONFLICT` enum value to the `error/code` response property for the response status `400`
  - added the new `INVOICE_REACTIVATION_BLOCKED` enum value to the `error/code` response property for the response status `400`
  - added the new `INVOICE_REACTIVATION_CONFLICT` enum value to the `error/code` response property for the response status `400`
- **2026-10-28** `6762ca2358ea`: 1 warning
  - added the new `COUPON_USED_IN_ACTIVE_PAYMENT_LINK` enum value to the `error/code` response property for the response status `400`
- **2026-10-28** `bb23366f1a76`: 15 warning
  - added the new `ACCOUNTING_GATEWAY_RECEIVABLES_AUTOMATIC_POSTING_REQUIRED` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_GATEWAY_RECEIVABLES_FIELDS_MISSING` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_GATEWAY_RECEIVABLES_FIELD_REQUIRED` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_GATEWAY_RECEIVABLES_NO_ACTIVE_PROVIDER` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_GATEWAY_RECEIVABLES_RECONNECT_REQUIRED` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_SETTLEMENT_CONNECTION_INACTIVE` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_SETTLEMENT_CURRENCY_MISMATCH` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_SETTLEMENT_PERIOD_LOCKED` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_SETTLEMENT_TOTALS_MISMATCH` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_SETTLEMENT_UNSUPPORTED_LINE_TYPE` enum value to the `error/code` response property for the response status `400`
  - added the new `CONNECTED_APP_TOKEN_INVALID` enum value to the `error/code` response property for the response status `400`
  - added the new `INVOICE_EXPIRED` enum value to the `error/code` response property for the response status `400`
  - added the new `INVOICE_SEND_CONFLICT` enum value to the `error/code` response property for the response status `400`
  - added the new `PAYMENT_CLAIM_CONFLICT` enum value to the `error/code` response property for the response status `400`
  - added the new `PAYMENT_SUCCESS_CONFLICT` enum value to the `error/code` response property for the response status `400`
- **2026-10-09** `dfac786362d9`: 7 warning
  - added the new `ACCOUNTING_PARENT_NOT_SYNCED` enum value to the `error/code` response property for the response status `400`
  - added the new `INVOICE_EXPIRY_CONFLICT` enum value to the `error/code` response property for the response status `400`
  - added the new `INVOICE_NOT_EXPIRABLE` enum value to the `error/code` response property for the response status `400`
  - added the new `INVOICE_ROW_LOCKED` enum value to the `error/code` response property for the response status `400`
  - added the new `INVOICE_SYNCED_TO_ANOTHER_ACC_PLATFORM` enum value to the `error/code` response property for the response status `400`
  - added the new `ZATCA_CUSTOMER_ADDRESS_INCOMPLETE` enum value to the `error/code` response property for the response status `400`
  - added the new `ZATCA_NOT_ELIGIBLE` enum value to the `error/code` response property for the response status `400`
- **2026-10-01** `1d015757f82f`: 1 warning
  - added the new `OAUTH_ONLY_ACCOUNT` enum value to the `error/code` response property for the response status `400`
- **2026-09-27** `887ba33c169b`: 2 warning
  - added the new `PAYMENT_REFUND_INSUFFICIENT_BALANCE` enum value to the `error/code` response property for the response status `400`
  - added the new `PAYMENT_REFUND_WINDOW_EXPIRED` enum value to the `error/code` response property for the response status `400`
- **2026-09-15** `85261606a8ea`: 8 warning, 1 info
  - added the new `DISCOUNT_RULE_APPLICABLE_COUPON_MISSING` enum value to the `error/code` response property for the response status `400`
  - added the new `DISCOUNT_RULE_COUPON_CURRENCY_UNAVAILABLE_FOR_PRODUCT` enum value to the `error/code` response property for the response status `400`
  - added the new `DISCOUNT_RULE_COUPON_FIXED_AMOUNT_INVALID` enum value to the `error/code` response property for the response status `400`
  - added the new `DISCOUNT_RULE_COUPON_INELIGIBLE_AFTER_UPDATE` enum value to the `error/code` response property for the response status `400`
  - added the new `DISCOUNT_RULE_COUPON_PERCENTAGE_TOO_HIGH` enum value to the `error/code` response property for the response status `400`
  - added the new `DISCOUNT_RULE_PRODUCT_ALREADY_ASSIGNED` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_OVERRIDE_RULE_NOT_AVAILABLE` enum value to the `error/code` response property for the response status `400`
  - added the new `POS_TRANSACTION_ID_REQUIRES_CARD` enum value to the `error/code` response property for the response status `400`
  - added the optional property `pos_transaction_id` to the response with the `200` status
- **2026-09-11** `b1bbc301905b`: 2 warning
  - added the new `ZATCA_ALREADY_ONBOARDED` enum value to the `error/code` response property for the response status `400`
  - added the new `ZATCA_ONBOARDING_IN_PROGRESS` enum value to the `error/code` response property for the response status `400`
- **2026-09-07** `7269a6d9677f`: 3 warning, 2 info
  - removed the request property `allow_refund_multiple_related_payments`
  - added the new `ACCOUNTING_ANOTHER_PROVIDER_ACTIVE` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_BRANCH_PLUGIN_NOT_ENABLED` enum value to the `error/code` response property for the response status `400`
  - added the new optional request property `amount`
  - added the new optional request property `payment_is_part_of_related_set`
- **2026-09-03** `515eeea7d260`: 15 warning, 2 info
  - added the new `ACCOUNTING_BRANCHES_NOT_SUPPORTED` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_CONFIG_FIELD_NOT_SEEDED` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_CONNECTION_INACTIVE` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_DOCUMENT_SYNC_FAILED` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_ENUM_OPTIONS_MISSING` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_FIELD_INVALID` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_FIELD_OPTIONS_FETCH_FAILED` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_OAUTH_EXCHANGE_FAILED` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_OAUTH_STATE_INVALID` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_ORG_CONFIG_INCOMPLETE` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_REFRESH_REQUIRED` enum value to the `error/code` response property for the response status `400`
  - added the new `ACCOUNTING_TEST_CONNECTION_FAILED` enum value to the `error/code` response property for the response status `400`
  - added the new `BNPL` enum value to the `payment_method` response property for the response status `200`
  - added the new `PARTIALLY_REFUNDED` enum value to the `current_status` response property for the response status `200`
  - added the new `SPLIT_REMAINDER` enum value to the `type` response property for the response status `200`
  - added the optional property `amount_refunded` to the response with the `200` status
  - added the optional property `refunds` to the response with the `200` status
- **2026-07-15** `9a960de24945`: 22 warning, 1 info
  - the `refund_note` request property's maxLength was set to `512`
  - added the new `CONSUMER_CONTACT_INFO_CHANGE_NOT_ALLOWED` enum value to the `error/code` response property for the response status `400`
  - added the new `CONSUMER_HAS_ACTIVE_PAYMENT_LINKS` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_CUSTOM_REQUIRES_BOUNDS` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_GLOBAL_CANNOT_DELETE` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_GLOBAL_CANNOT_DISABLE` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_GLOBAL_CANNOT_SET_BOUNDS` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_INSTALLMENTS_NOT_AVAILABLE` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_INVALID_PERCENTAGE_WEIGHTS` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_MAX_INSTALLMENTS_EXCEEDED` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_OPTIONS_REQUIRED` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_OVERLAPPING_MIN_MAX_RANGES` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_RULE_MINIMUM_BELOW_SETTINGS_FLOOR` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_SELECTION_NOT_AVAILABLE` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_SMALLEST_SHARE_BELOW_MIN` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_SPLIT_AMOUNT_BELOW_MIN` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_SPLIT_AMOUNT_REQUIRED` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_TRIAL_VERIFICATION_NOT_ALLOWED` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_UNABLE_TO_COMPUTE_AMOUNT_SPLITS` enum value to the `error/code` response property for the response status `400`
  - added the new `INSTALLMENT_WEIGHTS_REQUIRED` enum value to the `error/code` response property for the response status `400`
  - added the new `SANDBOX_CUSTOMER_CREATION_RESTRICTED` enum value to the `error/code` response property for the response status `400`
  - added the new `WEBHOOK_AUTO_DISABLED` enum value to the `error/code` response property for the response status `400`
  - added the optional property `latest_pgw_message` to the response with the `200` status

---

[Operation](https://skmtc.dev/streampay/apis/stream-app/docs/api/v2/payments/:payment_id/refund/post.md) - [API](https://skmtc.dev/streampay/apis/stream-app.md) - [Page](https://skmtc.dev/streampay/apis/stream-app/changes/api/v2/payments/:payment_id/refund/post)
