THthewayl
Refunds

Create a Refund

Changed on

Request a refund for a completed payment. The order must be paid and linked to a customer. Amount must not exceed the amount paid on the gateway. Optionally provide refundMethod and accountNumber together to send the refund to an alternative account instead of the original payment method.

post/api/v1/refunds

Request

  • Base URL
    https://api.thewayl.com
  • URL
    https://api.thewayl.com/api/v1/refunds
  • Auth
    API key in header X-WAYL-AUTHENTICATION

Request body

referenceIdstring

Your reference ID for the order to be refunded (2-255 characters)

reasonstring

Detailed reason for the refund. Minimum 100 characters, maximum 1500 characters.

amountnumber

Amount to refund in IQD (minimum 1000). Must be less than or equal to the amount paid on the payment gateway.

refundMethod'QiCard' | 'FIB' | 'ZainCash'

Optional alternative refund method. Must be provided together with accountNumber.

accountNumberstring

Optional account ID or number for the alternative refund method. Must be provided together with refundMethod.

Changes

  • 76e77f7f7fefRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property