logo Developer API
Giftable Coupons


Intro

Coupons allow you to gift your withdrawable balance to other users. You can only create coupons with your withdrawable balance. The receiving user can log into their BitSkins account and go to Help -> Redeem Coupon to redeem the coupon code. If you do not have enough withdrawable balance at the time the recipient redeems the coupon, the redemption of the coupon will fail.

Recipients of coupons can only spend the funds at BitSkins. The redeemed funds are not withdrawable into cash.

All of the following methods require the API Key, which you can retrieve through the settings page after you enable API access for your account. All API calls are accessible through GET and POST methods. Furthermore, all API calls require Secure Access to be enabled, and a two-factor security code generated for every single API call you make. For information on how to generate this two-factor security code, see the General API documentation.

The interactive widget you will see under the respective API calls here once your account is Secure Access-verified generates the codes automatically.

Default API throttle limits are 8 requests per second. Contact us if you need higher limits.

Create Coupons

Allows you to create coupons. These coupons rely on your withdrawable (or couponable) balance (see Help -> FAQ). Upto 500 coupons in a single API call.

Multiple simultaneous calls to this method may result in 'Failed to acquire lock' errors.

Endpoint
/api/v1/create_coupons

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
amount
Amount (in USD) for the coupon code.
quantity
Number of coupons to create.

Example Request

          
https://bitskins.com/api/v1/create_coupons/?api_key=API_KEY&code=CODE&amount=AMOUNT&quantity=QUANTITY

Disable Coupons

Allows you to disable unredeemed coupons.

Multiple simultaneous calls to this method may result in 'Failed to acquire lock' errors.

Endpoint
/api/v1/disable_coupons

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
coupon_codes
Comma-separated list of coupon codes to disable.

Example Request

          
https://bitskins.com/api/v1/disable_coupons/?api_key=API_KEY&code=CODE&coupon_codes=COUPON_CODES

Get My Coupons

Allows you to retrieve coupons you created.

Endpoint
/api/v1/get_coupons

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
status
Must be one of: redeemed, redeemable, disabled
page
The page number. (optional)

Example Request

          
https://bitskins.com/api/v1/get_coupons/?api_key=API_KEY&code=CODE&status=STATUS&page=PAGE

Get Coupon Status

Allows you to retrieve status of given coupons you created.

Endpoint
/api/v1/get_coupon_status

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
coupon_codes
Coupon codes delimited by commas.

Example Request

          
https://bitskins.com/api/v1/get_coupon_status/?api_key=API_KEY&code=CODE&coupon_codes=COUPON_CODES

Redeem Coupon

Allows you to redeem a coupon. The coupon must not have been created by you.

Multiple simultaneous calls to this method may result in 'Failed to acquire lock' errors.

Endpoint
/api/v1/redeem_coupon

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
coupon_code
The coupon code to redeem.

Example Request

          
https://bitskins.com/api/v1/redeem_coupon/?api_key=API_KEY&code=CODE&coupon_code=COUPON_CODE