GiftCardApi: GiftCard operations
In grahamjwhite/binanceRapi: R Package Client for Binance Public Spot API
GiftCardApi R Documentation
GiftCard operations
Description
binanceRapi.GiftCard
Format
An R6Class generator object
Methods
SapiV1GiftcardCreateCodePost Create a Binance Code (USER_DATA)
This API is for creating a Binance Code. To get started with, please make sure: - You have a Binance account - You have passed kyc - You have a sufficient balance in your Binance funding wallet - You need Enable Withdrawals for the API Key which requests this endpoint. Daily creation volume: 2 BTC / 24H Daily creation times: 200 Codes / 24H Weight(IP): 1
-
@param token character
-
@param amount numeric
-
@param timestamp integer
-
@param signature character
-
@param recv.window integer
-
@returnType InlineResponse200141
status code : 200 | Code creation
return type : InlineResponse200141
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1GiftcardCryptographyRsaPublicKeyGet Fetch RSA Public Key (USER_DATA)
This API is for fetching the RSA Public Key. This RSA Public key will be used to encrypt the card code. Please note that the RSA Public key fetched is valid only for the current day. Weight(IP): 1
-
@param timestamp integer
-
@param signature character
-
@param recv.window integer
-
@returnType InlineResponse200144
status code : 200 | RSA Public Key.
return type : InlineResponse200144
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1GiftcardRedeemCodePost Redeem a Binance Code (USER_DATA)
This API is for redeeming the Binance Code. Once redeemed, the coins will be deposited in your funding wallet. Please note that if you enter the wrong code 5 times within 24 hours, you will no longer be able to redeem any Binance Code that day. Weight(IP): 1
-
@param code character
-
@param timestamp integer
-
@param signature character
-
@param external.uid character
-
@param recv.window integer
-
@returnType InlineResponse200142
status code : 200 | Redeemed Information
return type : InlineResponse200142
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1GiftcardVerifyGet Verify a Binance Code (USER_DATA)
This API is for verifying whether the Binance Code is valid or not by entering Binance Code or reference number. Please note that if you enter the wrong binance code 5 times within an hour, you will no longer be able to verify any binance code for that hour. Weight(IP): 1
-
@param reference.no character
-
@param timestamp integer
-
@param signature character
-
@param recv.window integer
-
@returnType InlineResponse200143
status code : 200 | Code Verification
return type : InlineResponse200143
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
Public fields
apiClientHandles the client-server communication.
Methods
Public methods
Method new()
Usage
GiftCardApi$new(apiClient)
Method SapiV1GiftcardCreateCodePost()
Usage
GiftCardApi$SapiV1GiftcardCreateCodePost(
token,
amount,
timestamp,
signature,
recv.window = NULL,
...
)
Method SapiV1GiftcardCreateCodePostWithHttpInfo()
Usage
GiftCardApi$SapiV1GiftcardCreateCodePostWithHttpInfo(
token,
amount,
timestamp,
signature,
recv.window = NULL,
...
)
Method SapiV1GiftcardCryptographyRsaPublicKeyGet()
Usage
GiftCardApi$SapiV1GiftcardCryptographyRsaPublicKeyGet(
timestamp,
signature,
recv.window = NULL,
...
)
Method SapiV1GiftcardCryptographyRsaPublicKeyGetWithHttpInfo()
Usage
GiftCardApi$SapiV1GiftcardCryptographyRsaPublicKeyGetWithHttpInfo(
timestamp,
signature,
recv.window = NULL,
...
)
Method SapiV1GiftcardRedeemCodePost()
Usage
GiftCardApi$SapiV1GiftcardRedeemCodePost(
code,
timestamp,
signature,
external.uid = NULL,
recv.window = NULL,
...
)
Method SapiV1GiftcardRedeemCodePostWithHttpInfo()
Usage
GiftCardApi$SapiV1GiftcardRedeemCodePostWithHttpInfo(
code,
timestamp,
signature,
external.uid = NULL,
recv.window = NULL,
...
)
Method SapiV1GiftcardVerifyGet()
Usage
GiftCardApi$SapiV1GiftcardVerifyGet(
reference.no,
timestamp,
signature,
recv.window = NULL,
...
)
Method SapiV1GiftcardVerifyGetWithHttpInfo()
Usage
GiftCardApi$SapiV1GiftcardVerifyGetWithHttpInfo(
reference.no,
timestamp,
signature,
recv.window = NULL,
...
)
Method clone()
The objects of this class are cloneable with this method.
Usage
GiftCardApi$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
## Not run:
#################### SapiV1GiftcardCreateCodePost ####################
library(binanceRapi)
var.token <- 'token_example' # character | The coin type contained in the Binance Code
var.amount <- 3.4 # numeric | The amount of the coin
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Create a Binance Code (USER_DATA)
api.instance <- GiftCardApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1GiftcardCreateCodePost(var.token, var.amount, var.timestamp, var.signature, recv.window=var.recv.window)
#################### SapiV1GiftcardCryptographyRsaPublicKeyGet ####################
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Fetch RSA Public Key (USER_DATA)
api.instance <- GiftCardApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1GiftcardCryptographyRsaPublicKeyGet(var.timestamp, var.signature, recv.window=var.recv.window)
#################### SapiV1GiftcardRedeemCodePost ####################
library(binanceRapi)
var.code <- 'code_example' # character | Binance Code
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.external.uid <- 'external.uid_example' # character | Each external unique ID represents a unique user on the partner platform. The function helps you to identify the redemption behavior of different users, such as redemption frequency and amount. It also helps risk and limit control of a single account, such as daily limit on redemption volume, frequency, and incorrect number of entries. This will also prevent a single user account reach the partner's daily redemption limits. We strongly recommend you to use this feature and transfer us the User ID of your users if you have different users redeeming Binance codes on your platform. To protect user data privacy, you may choose to transfer the user id in any desired format (max. 400 characters).
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Redeem a Binance Code (USER_DATA)
api.instance <- GiftCardApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1GiftcardRedeemCodePost(var.code, var.timestamp, var.signature, external.uid=var.external.uid, recv.window=var.recv.window)
#################### SapiV1GiftcardVerifyGet ####################
library(binanceRapi)
var.reference.no <- 'reference.no_example' # character | reference number
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Verify a Binance Code (USER_DATA)
api.instance <- GiftCardApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1GiftcardVerifyGet(var.reference.no, var.timestamp, var.signature, recv.window=var.recv.window)
## End(Not run)
grahamjwhite/binanceRapi documentation built on Nov. 22, 2022, 9:37 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| GiftCardApi | R Documentation |
GiftCard operations
Description
binanceRapi.GiftCard
Format
An R6Class generator object
Methods
SapiV1GiftcardCreateCodePost Create a Binance Code (USER_DATA) This API is for creating a Binance Code. To get started with, please make sure: - You have a Binance account - You have passed kyc - You have a sufficient balance in your Binance funding wallet - You need Enable Withdrawals for the API Key which requests this endpoint. Daily creation volume: 2 BTC / 24H Daily creation times: 200 Codes / 24H Weight(IP): 1
-
@param token character
-
@param amount numeric
-
@param timestamp integer
-
@param signature character
-
@param recv.window integer
-
@returnType InlineResponse200141
status code : 200 | Code creation
return type : InlineResponse200141
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1GiftcardCryptographyRsaPublicKeyGet Fetch RSA Public Key (USER_DATA) This API is for fetching the RSA Public Key. This RSA Public key will be used to encrypt the card code. Please note that the RSA Public key fetched is valid only for the current day. Weight(IP): 1
-
@param timestamp integer
-
@param signature character
-
@param recv.window integer
-
@returnType InlineResponse200144
status code : 200 | RSA Public Key.
return type : InlineResponse200144
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1GiftcardRedeemCodePost Redeem a Binance Code (USER_DATA) This API is for redeeming the Binance Code. Once redeemed, the coins will be deposited in your funding wallet. Please note that if you enter the wrong code 5 times within 24 hours, you will no longer be able to redeem any Binance Code that day. Weight(IP): 1
-
@param code character
-
@param timestamp integer
-
@param signature character
-
@param external.uid character
-
@param recv.window integer
-
@returnType InlineResponse200142
status code : 200 | Redeemed Information
return type : InlineResponse200142
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1GiftcardVerifyGet Verify a Binance Code (USER_DATA) This API is for verifying whether the Binance Code is valid or not by entering Binance Code or reference number. Please note that if you enter the wrong binance code 5 times within an hour, you will no longer be able to verify any binance code for that hour. Weight(IP): 1
-
@param reference.no character
-
@param timestamp integer
-
@param signature character
-
@param recv.window integer
-
@returnType InlineResponse200143
status code : 200 | Code Verification
return type : InlineResponse200143
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
Public fields
apiClientHandles the client-server communication.
Methods
Public methods
Method new()
Usage
GiftCardApi$new(apiClient)
Method SapiV1GiftcardCreateCodePost()
Usage
GiftCardApi$SapiV1GiftcardCreateCodePost( token, amount, timestamp, signature, recv.window = NULL, ... )
Method SapiV1GiftcardCreateCodePostWithHttpInfo()
Usage
GiftCardApi$SapiV1GiftcardCreateCodePostWithHttpInfo( token, amount, timestamp, signature, recv.window = NULL, ... )
Method SapiV1GiftcardCryptographyRsaPublicKeyGet()
Usage
GiftCardApi$SapiV1GiftcardCryptographyRsaPublicKeyGet( timestamp, signature, recv.window = NULL, ... )
Method SapiV1GiftcardCryptographyRsaPublicKeyGetWithHttpInfo()
Usage
GiftCardApi$SapiV1GiftcardCryptographyRsaPublicKeyGetWithHttpInfo( timestamp, signature, recv.window = NULL, ... )
Method SapiV1GiftcardRedeemCodePost()
Usage
GiftCardApi$SapiV1GiftcardRedeemCodePost( code, timestamp, signature, external.uid = NULL, recv.window = NULL, ... )
Method SapiV1GiftcardRedeemCodePostWithHttpInfo()
Usage
GiftCardApi$SapiV1GiftcardRedeemCodePostWithHttpInfo( code, timestamp, signature, external.uid = NULL, recv.window = NULL, ... )
Method SapiV1GiftcardVerifyGet()
Usage
GiftCardApi$SapiV1GiftcardVerifyGet( reference.no, timestamp, signature, recv.window = NULL, ... )
Method SapiV1GiftcardVerifyGetWithHttpInfo()
Usage
GiftCardApi$SapiV1GiftcardVerifyGetWithHttpInfo( reference.no, timestamp, signature, recv.window = NULL, ... )
Method clone()
The objects of this class are cloneable with this method.
Usage
GiftCardApi$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
## Not run: #################### SapiV1GiftcardCreateCodePost #################### library(binanceRapi) var.token <- 'token_example' # character | The coin type contained in the Binance Code var.amount <- 3.4 # numeric | The amount of the coin var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Create a Binance Code (USER_DATA) api.instance <- GiftCardApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1GiftcardCreateCodePost(var.token, var.amount, var.timestamp, var.signature, recv.window=var.recv.window) #################### SapiV1GiftcardCryptographyRsaPublicKeyGet #################### library(binanceRapi) var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Fetch RSA Public Key (USER_DATA) api.instance <- GiftCardApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1GiftcardCryptographyRsaPublicKeyGet(var.timestamp, var.signature, recv.window=var.recv.window) #################### SapiV1GiftcardRedeemCodePost #################### library(binanceRapi) var.code <- 'code_example' # character | Binance Code var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.external.uid <- 'external.uid_example' # character | Each external unique ID represents a unique user on the partner platform. The function helps you to identify the redemption behavior of different users, such as redemption frequency and amount. It also helps risk and limit control of a single account, such as daily limit on redemption volume, frequency, and incorrect number of entries. This will also prevent a single user account reach the partner's daily redemption limits. We strongly recommend you to use this feature and transfer us the User ID of your users if you have different users redeeming Binance codes on your platform. To protect user data privacy, you may choose to transfer the user id in any desired format (max. 400 characters). var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Redeem a Binance Code (USER_DATA) api.instance <- GiftCardApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1GiftcardRedeemCodePost(var.code, var.timestamp, var.signature, external.uid=var.external.uid, recv.window=var.recv.window) #################### SapiV1GiftcardVerifyGet #################### library(binanceRapi) var.reference.no <- 'reference.no_example' # character | reference number var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Verify a Binance Code (USER_DATA) api.instance <- GiftCardApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1GiftcardVerifyGet(var.reference.no, var.timestamp, var.signature, recv.window=var.recv.window) ## End(Not run)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.