Welcome

New CY.SEND API for sell PIN it's very fast and powerful. Just try it

Introduction

Before you begin using our API you need to get API credentials

Item Value
Host api.cysend.com
Port 80 or 443
Protocol HTTP or HTTPS

API Functions

Here is the list of API functions with explanation

Warning: For all API request you need send hash

Get Balance

Return account balance in account currency.

You need to send in path your account username and return format as you wish, available (json).

https://api.cysend.com/{username}/merchant_v0_6/{format}/get_balance

Response parameters

Parameter Type Description
errorintError code
error_descstringError code description
balancefloatAccount balance at current moment
currencystringAccount currency in ISO alpha 2

Get PIN Price list

Return list of product what you can buy.

You need to send in path your account username and return format as you wish, available (json).

https://api.cysend.com/{username}/merchant_v0_6/{format}/get_pin_pricelist

Response parameters

Parameter Type Description
errorintError code
error_descstringError code description
product_idintCY.SEND id of product
countrystringCountry name in ISO alpha 2
face_valuefloatFacial price of product
face_currencystringFacial price currency in ISO alpha 2
pricefloatBuy price of product
vatfloatTransaction VAT
currencystringBuy price currency in ISO alpha 2

Buy PIN

Request for buy selected PIN

You need to send in path your account username and return format as you wish, available (json).

https://api.cysend.com/{username}/merchant_v0_6/{format}/buy_pin

Request parameters

Parameter Type Description
product_idintCY.SEND product id what you received from Get PIN price list request

Response parameters

Parameter Type Description
errorintError code
error_descstringError code description
serialstringPIN serial number
pinstringPIN number
expirationstringPIN expiration date

Hash generation rules

For each API request you need to send hash.

MD5({request_url}|{request_parameter}|MD5({password}))

Description

Item Description
{request_url} Your request to API, full path
{request_parameter} All parameters what you need to send separated by '|' character
{password} Your account password

Return codes

Here is the list of errors

Code Description
0 api.error.0
1000 api.error.1000
1001 api.error.1001
2000 api.error.2000
2001 api.error.2001
2002 api.error.2002
2003 api.error.2003
3000 api.error.3000
3001 api.error.3001
3002 api.error.3002
3003 api.error.3003
3004 api.error.3004
3005 api.error.3005
3006 api.error.3006
3007 api.error.3007 {parameter}
4001 api.error.4001
4002 api.error.4002
4003 api.error.4003
4004 api.error.4004
4005 api.error.4005
5001 api.error.5001