---
updatedAt: 2026-07-09T19:39:10.000Z
agentTools:
  projectIndex: https://developer.i-payout.com/llms.txt
---

# Redeem voucher

This API will redeem the provided voucher.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "IPS Portal Rest API - V1",
    "description": "i-payout API",
    "contact": {
      "name": "i-payout tech support",
      "email": "techsupport@i-payout.com"
    },
    "license": {
      "name": "i-payout API",
      "url": "http://www.i-payout.com"
    },
    "version": "v1"
  },
  "paths": {
    "/api/v1/vouchers/redeem": {
      "post": {
        "tags": [
          "Voucher"
        ],
        "summary": "Redeem voucher",
        "description": "This API will redeem the provided voucher.",
        "operationId": "redeem-voucher",
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RedeemVoucherCodeViewModel"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/RedeemVoucherCodeViewModel"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/RedeemVoucherCodeViewModel"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponseRedeemVoucherCode"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponseRedeemVoucherCode"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponseRedeemVoucherCode"
                }
              }
            }
          }
        },
        "security": [
          {
            "Bearer": [],
            "X-MerchantId": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ApiResponseRedeemVoucherCode": {
        "type": "object",
        "properties": {
          "isSuccess": {
            "type": "boolean",
            "description": "Indicates if the API call was successful or not."
          },
          "message": {
            "type": "string",
            "description": "A human readable status message that may be used for debugging.",
            "nullable": true
          },
          "statusCode": {
            "$ref": "#/components/schemas/StatusConstants"
          },
          "logIdentifier": {
            "type": "string",
            "description": "Utilized for support, a log identifier to provide to i-payout when requesting technical support.",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/ApiResponseRedeemVoucherCodeData"
          }
        },
        "additionalProperties": false,
        "description": "Redeem voucher response"
      },
      "ApiResponseRedeemVoucherCodeData": {
        "type": "object",
        "properties": {
          "transactionIdentifer": {
            "type": "integer",
            "description": "i-payout redeem transaction identiffier",
            "format": "int64"
          },
          "token": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Redeem voucher response"
      },
      "RedeemVoucherCodeViewModel": {
        "required": [
          "amount",
          "currencyCode",
          "merchantReferenceId",
          "voucherCode"
        ],
        "type": "object",
        "properties": {
          "voucherCode": {
            "maxLength": 10,
            "type": "string",
            "description": "Voucher code to be redeemded."
          },
          "amount": {
            "type": "number",
            "description": "Amount to redeem. If submit as zero, the full voucher amount will be redeemed.If submitted amount is less than the voucher amount, remaining balance will be credited back to the sender.",
            "format": "double"
          },
          "currencyCode": {
            "maxLength": 3,
            "type": "string",
            "description": "The redeem currency code. If empty, system will take the voucher currency code"
          },
          "merchantReferenceId": {
            "maxLength": 100,
            "type": "string",
            "description": "Reference id for the redemption transaction"
          },
          "comments": {
            "maxLength": 500,
            "type": "string",
            "description": "Comments for the transaction",
            "nullable": true
          },
          "redeemUserName": {
            "maxLength": 300,
            "type": "string",
            "description": "If there is any eWallet account for the person that is redeeming, then you can submit the username of that account",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": ""
      },
      "StatusConstants": {
        "enum": [
          "NO_ERROR",
          "EMAIL_ADDRESS_EXISTS",
          "CAPTCHA_FAILED",
          "INVALID_REFERENCEID",
          "INVALID_OPERATION",
          "INVALID_TIN_VALIDATION_STATUS",
          "RECORD_NOT_FOUND",
          "Already_Exist",
          "Batch_Closed",
          "IP_BLACKLISTED",
          "CREDIT_CARD_PROCESSOR_ISSUE",
          "FEES_NOT_ACCEPTED",
          "PAYOUT_CAPABILITIES_DISABLED",
          "INVALID_RECURRING_PAYMENT_STATUS",
          "INVOICE_CAPABILITIES_DISABLED",
          "INVALID_EWALLET_REGISTRATION",
          "PRIVATE_KEY_ISSUE",
          "FILE_NOT_EXISTS",
          "OLDUSER_NEWUSER_MISMATCH",
          "USER_CANNOT_CREATED",
          "CANNOT_CREATE_NEW_BATCH",
          "REFERENCEID_ALREADY_EXISTS",
          "DELETE_RECORD_ERROR",
          "FX_ConversionRate_Issue",
          "RATE_LIMIT_EXCEEDED",
          "IP_NOT_ALLOWED",
          "COUNTRY_NOT_ALLOWED",
          "INVALID_FIELD_VALUE_LENGTH",
          "UNAUTHORIZED_API_CALL",
          "FEE_VALUE_NOT_FOUND_FOR_CUSTOMER",
          "IPADDRESS_GENERATION_ISSUE",
          "MERCHANT_NOT_FOUND",
          "INVALID_PARAMS",
          "Missing_HEADER_PARAMS",
          "INVALID_URL",
          "INVALID_AMOUNT",
          "INVALID_CURRENCY",
          "REQUIRED_PARAMETER",
          "INVALID_REQUEST_PARAM",
          "INVALID_REQUEST_RESPONSE_PARAM",
          "INVALID_SERVER_CONFIG",
          "ACCESS_DENIED",
          "INVALID_COUNTRY_CODE",
          "PROCESSING",
          "PENDING",
          "NO_RECORDS_FOUND",
          "INVALID_MERCHANT",
          "PAL_INVALID_EMAIL",
          "INVALID_CARD_NUMBER",
          "INSUFFICIENT_FUNDS",
          "USERNAME_EXISTS",
          "USER_NOT_LOGGED_IN",
          "INVALID_CLIENT_CREDENTIALS",
          "ACCOUNT_NOT_FOUND",
          "GENERAL_ERROR",
          "CUSTOMER_NOT_FOUND",
          "INTERNAL_ERROR"
        ],
        "type": "string",
        "description": "Api response status code. For possible values, see <a target='_blank' href='https://i-payout.readme.io/reference/status-code-values' />Status Code Values </a>."
      }
    },
    "securitySchemes": {
      "basic": {
        "type": "http",
        "description": "Use API username and password to get the dynamic bearer token which can be used to access all other API, Example: 'Basic 12345adfad'",
        "scheme": "basic"
      },
      "Bearer": {
        "type": "apiKey",
        "description": "JWT Authorization header using the Bearer scheme.Enter 'Bearer' [space] and then your token in the text input below. Example: 'Bearer 12345abcdef'",
        "name": "Authorization",
        "in": "header"
      },
      "X-MerchantId": {
        "type": "apiKey",
        "description": "Merchant Identifier (GUID)",
        "name": "X-MerchantId",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "Bearer": [],
      "basic": [],
      "X-MerchantId": []
    }
  ]
}
```