Skip to end of banner
Go to start of banner

GET vouchers/retrieve_secret_number

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This method returns a voucher's secret number. The secret number of a single voucher is returned by each call

Available from CRM.COM R5.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

voucher_identifier

(mandatory)

Voucher identifier

The identifier of the voucher that should be returned as a result. The allowed vouchers identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the voucher

number

(semi-optional)

String

The number of the voucher

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name

Type

Description

id

String

The ID of the retrieved voucher

secret_number

String

The secret_number of the retrieved voucher

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

{
	"status":
	{
		"message": null,
		"description": null,
		"code": "OK"
	},
	"data":
	{
		"secret_number": "0977835",
		"id": "87DB0829834D1AC4B38B64616BF8855D"
	}
}
  • No labels