CreateTransaction

REST API Documentation

API access url

https://premium.black/service/rest/Pay.svc

Function overview

IsTransactionConfirmed (String publicKey, IsTransactionConfirmedRequest request)
CreateTransaction (String publicKey, CreateTransactionRequest request)
ActivateTransaction (String publicKey, ActivateTransactionRequest request)
GetTransactionDetails (String publicKey, GetTransactionDetailsRequest request)
GetTransactionByHash (String publicKey, GetTransactionByHashRequest request)
GetTransactionsByAddress (String publicKey, GetTransactionsByAddressRequest request)
GetRate (String publicKey, RateRequest request)
ReOpenTransaction (String publicKey, ReOpenTransactionRequest request)
CancelTransaction (String publicKey, CancelTransactionRequest request)
GetConfigurations (String publicKey, GetConfigurationsRequest request)

Custom types overview

Functions

CreateTransaction

(String publicKey, CreateTransactionRequest request)

Description: This function creates the initial transaction. There are some options for it, please check the described parameters.

Method: POST
Endpoint: https://premium.black/service/rest/Pay.svc/CreateTransaction
Request Body: Json
Response Body: Json

Request parameters:

Name

Datatype

Description

publicKey

String

request

CreateTransactionRequest

Name	Datatype	Max length	Is optional
Currency	String	-
Blockchain	String	-
Amount	String	-
PriceCurrency	String	-
IPN	String	-
CustomData	String	-
CustomUserId	String	-
CustomerMail	String	-
CustomOrderId	String	-
BlockAddress	String	-
ReturnQRCode	String	-
Hash	String	-
Error	String	-
Environment	String	-

Descriptions

Currency	The crypto currency which should be requested.
Blockchain	-
Amount	The amount to request in fiat currency (i.e. 100 for 100€)
PriceCurrency	The fiat currency which will be used to fix the price.
IPN	The callback url for the status changes.
CustomData	Custom data you want to add to this transaction.
CustomUserId	A custom user id you want to add to this transaction.
CustomerMail	Your customers mail address, if you want to add to this transaction. (good for researches)
CustomOrderId	A custom order id you want to add to this transaction.
BlockAddress	Set to true if the crypto address for the transaction should be linked/blocked right away. If false or null it will blocked on first user visit of the status page. (i.e. custom status pages)
ReturnQRCode	Should the QR Code be returned in base64 encoding ?
Hash	A SHA256 Bit lowercase Hash of all fields in ascending sort order (excluding the Hash field)
Error	-
Environment	-

Response parameters:

Name

Datatype

Description

CreateTransactionResponse

Name	Datatype
TransactionId	String
TransactionKey	String
Currency	String
PricingCurrency	String
Amount	String
OriginalAmount	String
Url	String
Status	String
StatusEnum	eStatus
AddressToReceive	String
AllowOverpay	Boolean
AllowUnderpay	Boolean
Exchange	ExchangeData
QRCode	String
System	String
Hash	String
Error	String
Environment	String

Descriptions

TransactionId	The ID of the transaction.
TransactionKey	The Key of the transaction.
Currency	The crypto currency which has been requested
PricingCurrency	The fiat currency which has been used to fix the price.
Amount	The requested crypto currency amount
OriginalAmount	The requested fiat currency amount
Url	On success, contains the url of the status page
Status	Contains the plain status text
StatusEnum	-
AddressToReceive	The address where the customer needs to sent the coins.
AllowOverpay	This transaction allows overpayment.
AllowUnderpay	This transaction allows underpayment.
Exchange	The used exchange to fix the price.
QRCode	The QR Code, Use: 'data:image/gif;base64,' + qrcode
System	-
Hash	A SHA256 Bit lowercase Hash of all fields in ascending sort order (excluding the Hash field)
Error	-
Environment	-