Skip to navigation

Get Payment Redemption Link

This API endpoint provides a unique URL for the redemption of a user’s wallet balance. Based on the requested format, the response data could either be a direct URL or an object containing the URL along with additional related information.

Request Body

  • return_array (boolean): This flag determines the shape of the response. If set to false, the server will return the data as a plain URL. If it is true, the server will return the data as an object, including the redemption URL, user ID, token, and expiration time.

Response

  • url (string): The URL for the payment redemption link.

  • user_id (string): The user ID associated with this request.

  • token (string): A unique token associated with the redemption link.

  • expiration (integer): The time in seconds until the redemption link expires. This field would only be included if ‘return_array’ is set to true.

Query parameters

api_tokenstringOptional

Response

Get Payment Redemption Link
messagestringOptional
apistringOptional
statusstringOptional
dataobjectOptional