Schemas¶
136 request and response models generated from the API contract.
AchReportRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Parameters |
AchReportParameters | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
AchReportParameters¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MerchantId |
integer (int32) | Optional | — |
RoutingNumber |
string | Optional | — |
AccountNumber |
string | Optional | — |
CheckNumber |
string | Optional | — |
Amount |
number (double) | Optional | — |
BeginAchDate |
string (date-time) | Optional | — |
EndAchDate |
string (date-time) | Optional | — |
Id |
integer (int32) | Optional | — |
AchReportResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Transactions |
array of AchTransaction | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
AchTransaction¶
| Field | Type | Requirement | Description |
|---|---|---|---|
id |
integer (int32) | Optional | — |
userId |
integer (int32) | Optional | — |
mid |
integer (int32) | Optional | — |
TerminalId |
string | Optional | — |
TransactionId |
string | Optional | — |
RoutingNumber |
string | Optional | — |
AccountNumber |
string | Optional | — |
CheckNumber |
string | Optional | — |
AccountType |
string | Optional | — |
PacketIdentifier |
string | Optional | — |
CheckAmount |
number (double) | Optional | — |
ResponseType |
string | Optional | — |
ResponseTypeText |
string | Optional | — |
ResultCode |
string | Optional | — |
TypeCode |
string | Optional | — |
Code |
string | Optional | — |
Message |
string | Optional | — |
MadeOn |
string (date-time) | Optional | — |
TransactionVoided |
boolean | Optional | — |
TransactionVoidedOn |
string (date-time) | Optional | — |
ResponseFromHostReceived |
boolean | Optional | — |
TransactionReverted |
boolean | Optional | — |
TransactionRevertedOn |
string (date-time) | Optional | — |
AchRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
TerminalID |
string | Optional | — |
ROUTING_NUMBER |
string | Optional | — |
ACCOUNT_NUMBER |
string | Optional | — |
ACCOUNT_TYPE |
string | Optional | — |
CHECK_NUMBER |
string | Optional | — |
FIRST_NAME |
string | Optional | — |
LAST_NAME |
string | Optional | — |
ADDRESS1 |
string | Optional | — |
ADDRESS2 |
string | Optional | — |
CITY |
string | Optional | — |
STATE |
string | Optional | — |
ZIP |
string | Optional | — |
PHONE_NUMBER |
string | Optional | — |
DL_STATE |
string | Optional | — |
DL_NUMBER |
string | Optional | — |
COURTESY_CARD_ID |
string | Optional | — |
SSN4 |
string | Optional | — |
DOB_YEAR |
string | Optional | — |
CHECK_AMOUNT |
string | Optional | — |
Method |
integer (int32) | Optional | — |
COMPANY_NAME |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
AchResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ResultCodeMsg |
array of string | Optional | — |
CodeTypeMsg |
array of string | Optional | — |
ErrorMessages |
array of string | Optional | — |
ResponseType |
string | Optional | — |
ResponseTypeText |
string | Optional | — |
ResultCode |
string | Optional | — |
TypeCode |
string | Optional | — |
Code |
string | Optional | — |
Message |
string | Optional | — |
TransactionInfo |
AchTransactionInfo | Optional | — |
ValidationMessage |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
AchTransactionInfo¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AccountNumber |
string | Optional | — |
RoutingNumber |
string | Optional | — |
CheckAmount |
string | Optional | — |
ServiceTransactionNumber |
string | Optional | — |
AchId |
integer (int32) | Optional | — |
AchVoidRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AchId |
integer (int32) | Optional | — |
AbaRouting |
string | Optional | — |
AccountNumber |
string | Optional | — |
AchAmount |
number (double) | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
AchVoidResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ResultCodeMsg |
array of string | Optional | — |
CodeTypeMsg |
array of string | Optional | — |
ResponseType |
string | Optional | — |
ResponseTypeText |
string | Optional | — |
ResultCode |
string | Optional | — |
TypeCode |
string | Optional | — |
Code |
string | Optional | — |
Message |
string | Optional | — |
ValidationMessage |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
AutomaticBatchCloseRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Time |
string (date-time) | Optional | The time of day for the automatic batch closing to occur.If the merchant was not enrolled in automatic batch closing, the Automatic Batch Close option is set to the specified time.If the merchant already had a closing time specified, no action is taken. |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
Response¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
Request¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
MerchantSubAccountsResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
SubAccounts |
array of Cashier | Optional | List of cashiers (subaccounts). |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
Cashier¶
| Field | Type | Requirement | Description |
|---|---|---|---|
id |
integer (int32) | Optional | — |
mid |
integer (int32) | Optional | — |
user_name |
string | Optional | — |
user_pass |
string | Optional | — |
in_black_list |
boolean | Optional | — |
is_enable |
boolean | Optional | — |
host_user |
string | Optional | — |
host_pass |
string | Optional | — |
description |
string | Optional | — |
first_name |
string | Optional | — |
last_name |
string | Optional | — |
picture_link |
string | Optional | — |
createdOn |
string (date-time) | Optional | — |
CanSale |
boolean | Optional | — |
DataWireId |
string | Optional | — |
DataWireIdBackUp |
string | Optional | — |
isDemo |
boolean | Optional | — |
WebsitePaymentsCount |
integer (int32) | Optional | — |
UserRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
IndustryCode |
string — A, AE, AF, E, F, FE, G, GE, H, M, R, RS |
Optional | — |
Processor |
string — FirstDataOmaha, FirsDataGift, FirstDataSouth, FirstDataNashville, AmexAuth, AmexPIP, BuyPass, CardNet, Certegy, CertegyEcc, CertegyImgRepo, ChochStone, Echk, Elavon, ElavonDirectnet, ElavonClearingFile, FifthThirdBank510, FifthThirdBank610, Gers, Givex, GlobalPaymentsEast, GlobalPaymentsBigBatch, Heartland, Litle, Loopback, Mercury, MonetraGift, Nova, BankOfAmerica, ChaseTampa, RBSLynk, ChaseSalem, SecureNet, Svs, FirstDataTelecheck, FirstDataTelecheckImgRepo, Valutec, Vital, IntuitImgRepo, RapidConnect |
Optional | — |
ProcessorExtraFields |
ProcessorExtraFields | Optional | — |
CardTypes |
string | Optional | — |
FraudAutodenyOptions |
string | Optional | — |
ProcessorId |
integer (int32) | Optional | — |
NewUser |
string | Optional | — |
NewPass |
string | Optional | — |
ExtraFielsKeys |
string | Optional | — |
ExtraFielsValues |
string | Optional | — |
ExtraData |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ProcessorExtraFields¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AGENTID |
string | Optional | — |
ALTMERCHID |
string | Optional | — |
ALTTERMID |
string | Optional | — |
AMEXDIVDEFAULT |
string | Optional | — |
AMEXL2 |
string | Optional | — |
AMEXSE |
string | Optional | — |
AMOUNTCHECKS |
string | Optional | — |
AUDDIV |
string | Optional | — |
AUTHPASS |
string | Optional | — |
AUTHUSER |
string | Optional | — |
BANKID |
string | Optional | — |
BIGBATCHID |
string | Optional | — |
BINRANGE |
string | Optional | — |
BMLMERCHID |
string | Optional | — |
CADAUTHPASS |
string | Optional | — |
CADDIV |
string | Optional | — |
CADPROFILEID |
string | Optional | — |
CADSELLERPROFILEID |
string | Optional | — |
CBSE |
string | Optional | — |
CHAINID |
string | Optional | — |
CHECKREADERCODE |
string | Optional | — |
CHFDIV |
string | Optional | — |
CLIENTNUM |
string | Optional | — |
CLOSETYPE |
string | Optional | — |
COPDIV |
string | Optional | — |
COUNTRY |
string | Optional | — |
COUNTRYCODE |
string | Optional | — |
CUSTOMECHO |
string | Optional | — |
CUSTOMERKEY |
string | Optional | — |
DATAWIREID |
string | Optional | — |
DEBITDIV |
string | Optional | — |
DEFAULTNSF |
string | Optional | — |
DESTID |
string | Optional | — |
DEVICEID |
string | Optional | — |
DINERSSE |
string | Optional | — |
DISCSE |
string | Optional | — |
DIVNUM |
string | Optional | — |
DKKDIV |
string | Optional | — |
DLCMERCHID |
string | Optional | — |
DLCMERCHIDBIZ |
string | Optional | — |
DOMAIN |
string | Optional | — |
ECCMERCHID |
string | Optional | — |
EMAILBANNER |
string | Optional | — |
EURDIV |
string | Optional | — |
FCSID |
string | Optional | — |
FM1MERCHID |
string | Optional | — |
FM2MERCHID |
string | Optional | — |
FM2MERCHIDBIZ |
string | Optional | — |
FTPAPPID |
string | Optional | — |
FTPUSERID |
string | Optional | — |
GBPDIV |
string | Optional | — |
GIFTBANKID |
string | Optional | — |
GIFTBINRANGE |
string | Optional | — |
GIFTTERMID |
string | Optional | — |
HKDDIV |
string | Optional | — |
IIASDIV |
string | Optional | — |
ILSDIV |
string | Optional | — |
INDCODE |
string | Optional | — |
INRDIV |
string | Optional | — |
JCBSE |
string | Optional | — |
JPYDIV |
string | Optional | — |
LEVEL2 |
string | Optional | — |
LKRDIV |
string | Optional | — |
MERCHABA |
string | Optional | — |
MERCHCAT |
string | Optional | — |
MERCHID |
string | Optional | — |
MERCHLOC |
string | Optional | — |
MERCHSETTLE |
string | Optional | — |
MERNAME |
string | Optional | — |
MVV |
string | Optional | — |
MXNDIV |
string | Optional | — |
NETWORKID |
string | Optional | — |
NOKDIV |
string | Optional | — |
NZDDIV |
string | Optional | — |
PID |
string | Optional | — |
PIDPWD |
string | Optional | — |
PPROPERTY |
string | Optional | — |
PROCESSMODE |
string | Optional | — |
REIMBATTR |
string | Optional | — |
RFIDCAPABLE |
string | Optional | — |
ROUTINGID |
string | Optional | — |
SEKDIV |
string | Optional | — |
SENUMBER |
string | Optional | — |
SERVICEPHONE |
string | Optional | — |
SETTLEDELAY |
string | Optional | — |
SETTLESPEC |
string | Optional | — |
SGDDIV |
string | Optional | — |
SHARINGGROUP |
string | Optional | — |
SMID |
string | Optional | — |
SMIDPWD |
string | Optional | — |
STATECODE |
string | Optional | — |
STOREID |
string | Optional | — |
STOREKEY |
string | Optional | — |
TAXID |
string | Optional | — |
TERMID |
string | Optional | — |
TERMTYPE |
string | Optional | — |
TIMEZONE |
string | Optional | — |
UAT |
string | Optional | — |
USDAUTHPASS |
string | Optional | — |
USDDIV |
string | Optional | — |
USDPROFILEID |
string | Optional | — |
USDSELLERPROFILEID |
string | Optional | — |
VFYMERCHID |
string | Optional | — |
VNUMBER |
string | Optional | — |
ZARDIV |
string | Optional | — |
ZIPCODE |
string | Optional | — |
GROUPID |
string | Optional | — |
AddUserResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MonetraResponse |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
GetCredentialsRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ProcessorId |
integer (int32) | Optional | — |
ExtraData |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
GetCredentialsResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
UserName |
string | Optional | — |
Password |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
DeleteUserRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ProcessorId |
integer (int32) | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
DeleteUserResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ProcessorResponse |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
ATHMobileTransactionRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Merchantid |
integer (int32) | Optional | — |
EcommerceId |
string | Optional | — |
EcommerceStatus |
string — Open, Completed, Cancel, Confirm |
Optional | — |
BusinessCustomerId |
string | Optional | — |
ReferenceNumber |
string | Optional | — |
DailyTransactionId |
integer (int32) | Optional | — |
TransactionDate |
string (date-time) | Optional | — |
SubTotal |
number (double) | Optional | — |
Tax |
number (double) | Optional | — |
Total |
number (double) | Optional | — |
Fee |
number (double) | Optional | — |
NetAmount |
number (double) | Optional | — |
TotalRefundedAmount |
number (double) | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ATHMobileTransactionResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Transactions |
array of ATHMobileTransaction | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
ATHMobileTransaction¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Id |
string (uuid) | Optional | — |
Mid |
integer (int32) | Optional | — |
EcommerceId |
string | Optional | — |
EcommerceStatus |
string — Open, Completed, Cancel, Confirm |
Optional | — |
BusinessCustomerId |
string | Optional | — |
ReferenceNumber |
string | Optional | — |
DailyTransactionId |
integer (int32) | Optional | — |
TransactionDate |
string (date-time) | Optional | — |
SubTotal |
number (double) | Optional | — |
Tax |
number (double) | Optional | — |
Total |
number (double) | Optional | — |
Fee |
number (double) | Optional | — |
NetAmount |
number (double) | Optional | — |
TotalRefundedAmount |
number (double) | Optional | — |
TokenThreeDSModel¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ApiKey |
string | Optional | — |
Token |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
BusinessSettingResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
SurchargeEnabled |
boolean | Optional | — |
SurchargePercent |
number (double) | Optional | — |
CardDifferenceEnabled |
boolean | Optional | — |
CardDifferencePercent |
number (double) | Optional | — |
ThreeDSecureEnabled |
boolean | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
CheckReportResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Transactions |
array of CheckTransactionReport | Optional | Transactions |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
CheckTransactionReport¶
| Field | Type | Requirement | Description |
|---|---|---|---|
mid |
integer (int32) | Optional | — |
RoutingNumber |
string | Optional | — |
AccountNumber |
string | Optional | — |
AccountType |
string | Optional | — |
PacketIdentifier |
string | Optional | — |
CheckAmount |
number (double) | Optional | — |
ResponseType |
string | Optional | — |
ResponseTypeText |
string | Optional | — |
ResultCode |
string | Optional | — |
TypeCode |
string | Optional | — |
Code |
string | Optional | — |
Message |
string | Optional | — |
CheckNumber |
string | Optional | — |
MadeOn |
string (date-time) | Optional | — |
TransactionVoided |
boolean | Optional | — |
TransactionVoidedOn |
string (date-time) | Optional | — |
ServiceTransactionNumber |
string | Optional | — |
CheckRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
TerminalID |
string | Optional | Identify the device which is doing the transaction. |
PacketIdentifier |
string | Optional | Packet Identifier | Value | Description | |---|---| | A | This is used in schemas for ARC, BOC, POP, TEL, WEB, and Check 21 to indicate that an authorization is requested for the XML Data Packet being sent. | | O | This is used in schemas for ARC, BOC, POP, TEL, WEB, and Check 21 when the host system receives a manager needed message to void the previous transaction and input a new transaction in its place. | | V | This is used in schemas for ARC, BOC, POP, TEL, WEB, and Check 21 to void a previously authorized transaction.However, it should be noted that transactions can only be voided on the same calendar day they were authorized. | |
ROUTING_NUMBER |
string | Optional | Bank routing number |
ACCOUNT_NUMBER |
string | Optional | Check Account Number |
CHECK_NUMBER |
string | Optional | Check number |
ACCOUNT_TYPE |
string | Optional | Account Type | Name | Value | Description | |---|---|---| | CHECKING | Checking | Checking Account | | SAVING | Saving | Savings Account | |
FIRST_NAME |
string | Optional | First Name on check. |
LAST_NAME |
string | Optional | Last Name on check. |
ADDRESS1 |
string | Optional | Address line 1 |
ADDRESS2 |
string | Optional | Address line 2 |
CITY |
string | Optional | Address City |
STATE |
string | Optional | State | Name | Value | Description | |---|---|---| | AB | 0 | Alberta | | AK | 1 | Alaska | | AL | 2 | Alabama | | AR | 3 | Arkansas | | AS | 4 | American Samoa | | AZ | 5 | Arizona | | BC | 6 | British Columbia | | CA | 7 | California | | CO | 8 | Colorado | | CT | 9 |Connecticut| | DC | 10 | District of Columbia | | DE | 11 | Delaware | | FL | 12 | Florida | | GA | 13 | Georgia | | GU | 14 | Guam | | HI | 15 | Hawaii | | IA | 16 | Iowa | | ID | 17 | Idaho | | IL | 18 | Illinois | | IN | 19 | Indiana | | KS | 20 | Kansas | | KY | 21 | Kentucky | | LA | 22 | Louisiana | | MA | 23 | Massachusetts | | MB | 24 | Manitoba | | MD | 25 | Maryland | | ME | 26 | Maine | | MI | 27 | Michigan | | MN | 28 | Minnesota | | MO | 29 | Missouri | | MS | 30 | Mississippi | | MT | 31 | Montana | | NB | 32 | New Brunswick | | NC | 33 | North Carolina | | ND | 34 | North Dakota | | NE | 35 | Nebraska | | NF | 36 | Newfoundland | | NH | 37 | New Hampshire | | NJ | 38 | New Jersey | | NM | 39 | New Mexico | | NS | 40 | Nova Scotia | | NT | 41 | Northwest Territories | | NU | 42 | Nunavut | | NV | 43 | Nevada | | NY | 44 | New York | | OH | 45 | Ohio | | OK | 46 | Oklahoma | | ON | 47 | Ontario | | OR | 48 | Oregon | | PA | 49 | Pennsylvania | | PE | 50 | Prince Edward Island | | PR | 51 | Puerto Rico | | QC | 52 | Quebec | | RI | 53 | Rhode Island | | SC | 54 | South Carolina | | SD | 55 | South Dakota | | SK | 56 | Saskatchewan | | TN | 57 | Tennessee | | TX | 58 | Texas | | UT | 59 | Utah | | VA | 60 | Virginia | | VI | 61 | Virgin Islands | | VT | 62 | Vermont | | WA | 63 | Washington | | WI | 64 | Wisconsin | | WV | 65 | West Virginia | | WY | 66 | Wyoming | | YT | 67 | Yukon | |
ZIP |
string | Optional | Address Zip Code |
PHONE_NUMBER |
string | Optional | Phone Number |
DL_STATE |
string | Optional | State | Name | Value | Description | |---|---|---| | AB | 0 | Alberta | | AK | 1 | Alaska | | AL | 2 | Alabama | | AR | 3 | Arkansas | | AS | 4 | American Samoa | | AZ | 5 | Arizona | | BC | 6 | British Columbia | | CA | 7 | California | | CO | 8 | Colorado | | CT | 9 |Connecticut| | DC | 10 | District of Columbia | | DE | 11 | Delaware | | FL | 12 | Florida | | GA | 13 | Georgia | | GU | 14 | Guam | | HI | 15 | Hawaii | | IA | 16 | Iowa | | ID | 17 | Idaho | | IL | 18 | Illinois | | IN | 19 | Indiana | | KS | 20 | Kansas | | KY | 21 | Kentucky | | LA | 22 | Louisiana | | MA | 23 | Massachusetts | | MB | 24 | Manitoba | | MD | 25 | Maryland | | ME | 26 | Maine | | MI | 27 | Michigan | | MN | 28 | Minnesota | | MO | 29 | Missouri | | MS | 30 | Mississippi | | MT | 31 | Montana | | NB | 32 | New Brunswick | | NC | 33 | North Carolina | | ND | 34 | North Dakota | | NE | 35 | Nebraska | | NF | 36 | Newfoundland | | NH | 37 | New Hampshire | | NJ | 38 | New Jersey | | NM | 39 | New Mexico | | NS | 40 | Nova Scotia | | NT | 41 | Northwest Territories | | NU | 42 | Nunavut | | NV | 43 | Nevada | | NY | 44 | New York | | OH | 45 | Ohio | | OK | 46 | Oklahoma | | ON | 47 | Ontario | | OR | 48 | Oregon | | PA | 49 | Pennsylvania | | PE | 50 | Prince Edward Island | | PR | 51 | Puerto Rico | | QC | 52 | Quebec | | RI | 53 | Rhode Island | | SC | 54 | South Carolina | | SD | 55 | South Dakota | | SK | 56 | Saskatchewan | | TN | 57 | Tennessee | | TX | 58 | Texas | | UT | 59 | Utah | | VA | 60 | Virginia | | VI | 61 | Virgin Islands | | VT | 62 | Vermont | | WA | 63 | Washington | | WI | 64 | Wisconsin | | WV | 65 | West Virginia | | WY | 66 | Wyoming | | YT | 67 | Yukon | |
DL_NUMBER |
string | Optional | Driver’s License Number |
COURTESY_CARD_ID |
string | Optional | Courtesy Card ID |
SSN4 |
string | Optional | Last 4 digits of the Social Security number |
DOB_YEAR |
string | Optional | Birthdate's year |
CHECK_AMOUNT |
string | Optional | Check Amount |
Method |
integer (int32) | Optional | | Name | Value | Description | |---|---|---| | CheckNoVerificationDLOptional | 0 | Using this method:
| CheckNoVerificationDLRequired | 1 | Using this method:
| CheckVerificationIdentityVerificationDLOptional | 3 | Using this method:
| CheckVerificationIdentityVerificationDLRequired | 4 | Using this method:
| CheckVerificationOnlyDLOptional | 5 | Using this method:
| CheckVerificationOnlyDLRequired | 6 | Using this method:
| IdentityVerificationOnlyDLOptional | 7 | Using this method:
| IdentityVerificationOnlyDLRequired | 8 | Using this method:
|
COMPANY_NAME |
string | Optional | Company Name |
CheckTransactionId |
integer (int32) | Optional | — |
SaveToken |
boolean | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
CheckResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ResultCodeMsg |
array of string | Optional | — |
CodeTypeMsg |
array of string | Optional | — |
ErrorMessages |
array of string | Optional | — |
ResponseType |
string | Optional | Check Processor ResponseType fieLd, ONLY FOR REFERENCE |
ResponseTypeText |
string | Optional | Check Processor ResponseTypeText field, ONLY FOR REFERENCE |
ResultCode |
string | Optional | Check Processor ResultCode field, ONLY FOR REFERENCE |
TypeCode |
string | Optional | Check Processor TypeCode field, ONLY FOR REFERENCE |
Code |
string | Optional | — |
Message |
string | Optional | Check Processor Message filed, ONLY FOR REFERENCE |
TransactionInfo |
CheckTransactionInfo | Optional | Transaction information that should be stored for future reference. |
Token |
string | Optional | — |
ValidationMessage |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
CheckTransactionInfo¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AccountNumber |
string | Optional | Check account number |
RoutingNumber |
string | Optional | Bank routing number |
CheckNumber |
string | Optional | Check Number |
CheckAmount |
string | Optional | Amount |
ServiceTransactionNumber |
string | Optional | — |
CheckTokenRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Token |
string | Required | — |
CHECK_AMOUNT |
string | Required | — |
CHECK_NUMBER |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
CustomersReponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Customers |
array of Customer | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
Customer¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Id |
integer (int32) | Optional | — |
CustomerId |
string | Optional | — |
MID |
integer (int32) | Optional | — |
Street |
string | Optional | — |
City |
string | Optional | — |
State |
string | Optional | — |
Zip |
string | Optional | — |
Country |
string | Optional | — |
Phone |
string | Optional | — |
Email |
string | Optional | — |
FirstName |
string | Optional | — |
LastName |
string | Optional | — |
Status |
integer (int32) | Optional | — |
AddedOn |
string (date-time) | Optional | — |
CustomerSource |
string — Gateway, Quickbooks, API |
Optional | — |
CreateDate |
string (date-time) | Optional | — |
PO |
string | Optional | — |
Invoice |
string | Optional | — |
SaleDebitRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
KSN |
string | Optional | Pin pad data. |
PinBlock |
string | Optional | Pin pad block. |
CashBackAmount |
number (double) | Optional | Cash back amount. |
Amount |
number (double) | Required | Transaction amount |
ZipCode |
string | Optional | Cardholder’s zip code. Not required if credit card is swiped. |
Street |
string | Optional | — |
CVN |
string | Optional | Credit card verification number (security code). Not required if credit card is swiped. |
CardNumber |
string | Optional | Credit card number. Not required if credit card isswiped. |
ExpDate |
string | Optional | Credit card expiration date (MMYY). Not required if credit card is swiped. |
NameOnCard |
string | Optional | Cardholder Name. Not required if credit card is swiped. |
Track2 |
string | Optional | Credit card track data. Not required if using the No Swipe method. |
EmvData |
string | Optional | — |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
TransactionType |
integer (int32) | Required | Transaction Type | Name | Value | Description | |---|---|---| | CREDIT | 1 | Credit transaction | | CREDIT_WITH_TOKEN | 2 | Credit with token transaction | | Pre_Authorization | 3 | Credit preauthorization request | | Pre_Authorization_Completion | 4 | Credit preauthorization completion | | SaleDebit | 5 | Debit Card Sale transaction | | EBT | 6 | EBT Transaction | | GIFTCARD | 7 | Blackstone Gift Card transaction | |
SURI |
string | Optional | — |
SurchargeAmount |
number (double) | Optional | — |
CardDifferenceAmount |
number (double) | Optional | — |
TaxAmount |
number (double) | Optional | — |
TipAmount |
number (double) | Optional | — |
SecureData |
string | Optional | — |
SecureTransactionId |
string | Optional | — |
SaveToken |
boolean | Optional | — |
CurrencyCode |
string | Optional | — |
SaveCustomer |
boolean | Optional | — |
CustomerId |
integer (int32) | Optional | — |
CustomerPhone |
string | Optional | — |
CustomerEmail |
string | Optional | — |
CustomerCountry |
string | Optional | — |
CustomerState |
string | Optional | — |
CustomerCity |
string | Optional | — |
CustomerAddress |
string | Optional | — |
OrderReference |
string | Optional | — |
PaymentLinkId |
string | Optional | — |
InvoiceNumber |
string | Optional | — |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | — |
DigWltProgType |
string | Optional | — |
DigWltToken |
string | Optional | — |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | — |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | — |
ForceDuplication |
boolean | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
PurchaseCardLevel2Data¶
| Field | Type | Requirement | Description |
|---|---|---|---|
TaxAmount |
string | Optional | — |
TaxIndicator |
string | Optional | — |
VatTaxAmount |
string | Optional | — |
VatTaxRate |
string | Optional | — |
PurchaseIdentifier |
string | Optional | — |
OrderNumber |
string | Optional | — |
DiscountAmount |
string | Optional | — |
FreightAmount |
string | Optional | — |
DutyAmount |
string | Optional | — |
DestinationPostalCode |
string | Optional | — |
ShipFromPostalCode |
string | Optional | — |
DestinationCountryCode |
string | Optional | — |
MerchantTaxId |
string | Optional | — |
ProductDescription |
string | Optional | — |
MerchantReferenceNumber |
string | Optional | — |
MerchantType |
string | Optional | — |
DestinationStateCode |
string | Optional | — |
CommercialCardType |
string | Optional | — |
RequesterName |
string | Optional | — |
RequesterAddress |
string | Optional | — |
SaleResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
avs |
string | Optional | Street verification message |
ServiceReferenceNumber |
string | Optional | Transaction identifier |
msoft_code |
string | Optional | Processor response message |
phard_code |
string | Optional | Bank response message |
cv |
string | Optional | CV verification message |
AuthorizationNumber |
string | Optional | Bank’s authorization number. Null if transaction was not successful. |
PaymentPlanInfo |
PaymentPlan | Optional | Reference to the merchant plan being used and the related rates. |
CardType |
string | Optional | Credit Card Type |
LastFour |
string | Optional | — |
Balance |
string | Optional | Balance - Original transaction amount minus refund(s). |
Token |
string | Optional | — |
EmvData |
string | Optional | — |
CustomerId |
integer (int32) | Optional | — |
AppliedSurchargeAmount |
number (double) | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
PaymentPlan¶
| Field | Type | Requirement | Description |
|---|---|---|---|
PlanId |
integer (int32) | Optional | — |
SwipeDiscount |
number (double) | Optional | — |
SwipeTransactionFee |
number (double) | Optional | — |
NonSwipeDiscount |
number (double) | Optional | — |
NonSwipeTransactionFee |
number (double) | Optional | — |
MonthlyFee |
number (double) | Optional | — |
Description |
string | Optional | — |
PlanName |
string | Optional | — |
DisplayName |
boolean | Optional | — |
EtbFoodStampRefundRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
KSN |
string | Optional | Pin pad data. |
PinBlock |
string | Optional | Pin pad block. |
Amount |
number (double) | Required | Amount to be refunded. The amount to be refunded can be less than the original transaction amount.Multiple refunds can be applied to the same transaction as long as the total amount of all refunds does not exceed the original transaction amount. |
ExpDate |
string | Optional | Card expiration date (MMYY). |
Account |
string | Optional | Card number. Optional if using swipe method. Otherwise required. |
TrackData |
string | Optional | Card track data. Optional if using the No Swipe method. |
UserTransactionNumber |
string | Required | The transaction identifier used for referencepurposes only; must be unique. |
ServiceTransactionNumber |
string | Required | The transaction identifier provided by the Blackstone system at the time of the original transaction. |
SURI |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
SaleRequest¶
Required data to process a sale
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | Transaction amount |
ZipCode |
string | Optional | Cardholder’s zip code. Not required if credit card is swiped. |
Street |
string | Optional | — |
CVN |
string | Optional | Credit card verification number (security code). Not required if credit card is swiped. |
CardNumber |
string | Optional | Credit card number. Not required if credit card isswiped. |
ExpDate |
string | Optional | Credit card expiration date (MMYY). Not required if credit card is swiped. |
NameOnCard |
string | Optional | Cardholder Name. Not required if credit card is swiped. |
Track2 |
string | Optional | Credit card track data. Not required if using the No Swipe method. |
EmvData |
string | Optional | — |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
TransactionType |
integer (int32) | Required | Transaction Type | Name | Value | Description | |---|---|---| | CREDIT | 1 | Credit transaction | | CREDIT_WITH_TOKEN | 2 | Credit with token transaction | | Pre_Authorization | 3 | Credit preauthorization request | | Pre_Authorization_Completion | 4 | Credit preauthorization completion | | SaleDebit | 5 | Debit Card Sale transaction | | EBT | 6 | EBT Transaction | | GIFTCARD | 7 | Blackstone Gift Card transaction | |
SURI |
string | Optional | — |
SurchargeAmount |
number (double) | Optional | — |
CardDifferenceAmount |
number (double) | Optional | — |
TaxAmount |
number (double) | Optional | — |
TipAmount |
number (double) | Optional | — |
SecureData |
string | Optional | — |
SecureTransactionId |
string | Optional | — |
SaveToken |
boolean | Optional | — |
CurrencyCode |
string | Optional | — |
SaveCustomer |
boolean | Optional | — |
CustomerId |
integer (int32) | Optional | — |
CustomerPhone |
string | Optional | — |
CustomerEmail |
string | Optional | — |
CustomerCountry |
string | Optional | — |
CustomerState |
string | Optional | — |
CustomerCity |
string | Optional | — |
CustomerAddress |
string | Optional | — |
OrderReference |
string | Optional | — |
PaymentLinkId |
string | Optional | — |
InvoiceNumber |
string | Optional | — |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | — |
DigWltProgType |
string | Optional | — |
DigWltToken |
string | Optional | — |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | — |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | — |
ForceDuplication |
boolean | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
RefundRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | Amount to be refunded. The amount to be refunded can be less than the original transaction amount.Multiple refunds can be applied to the same transaction as long as the total amount of all refunds does not exceed the original transaction amount. |
ExpDate |
string | Optional | Card expiration date (MMYY). |
Account |
string | Optional | Card number. Optional if using swipe method. Otherwise required. |
TrackData |
string | Optional | Card track data. Optional if using the No Swipe method. |
UserTransactionNumber |
string | Required | The transaction identifier used for referencepurposes only; must be unique. |
ServiceTransactionNumber |
string | Required | The transaction identifier provided by the Blackstone system at the time of the original transaction. |
SURI |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ReversalRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
UserTransactionNumber |
string | Required | The user transaction number that was sent by the client at the time of the transaction. |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
MonetraChangeDataWireIdRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
DataWireID |
string | Optional | — |
ProcessorMid |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ChangeMonetraUserResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MonetraResponse |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
DoesUserExistResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
DoesUserExist |
boolean | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
GetTokenForCardRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Account |
string | Optional | Card Number |
expDate |
string | Optional | Card expiration date |
NameOnCard |
string | Optional | Name on card |
Street |
string | Optional | Cardholder street address |
zipCode |
string | Optional | Cardholder zip code |
cv |
string | Optional | Card verification code |
clientRef |
string | Optional | — |
description |
string | Optional | Token / Card description |
ExistingToken |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
GetTokenForCardResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Token |
string | Optional | The token which identifies the credit card information. |
Identifier |
string | Optional | — |
msoft_code |
string | Optional | Processor response message |
PhardCode |
string | Optional | Bank response message |
AuthCode |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
TokensRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Identifier |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
TokensResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Tokens |
array of StoredAccount | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
StoredAccount¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Token |
string | Optional | — |
Type |
string | Optional | — |
Active |
string | Optional | — |
CardType |
string — Visa, MasterCard, AmericanExpress, Discover, Diners, CarteBlanche, Jcb, Switch, BillMeLater, Check, Gift, Other, VisaDebit, McDebit, OtherDebit, AllCredit, AllDebit, AllGift, AllEbt, All, Ebt, VisaDs, UNKNOWN |
Optional | — |
ABARoute |
string | Optional | — |
Account |
string | Optional | — |
ExpirationDate |
string | Optional | — |
CardHolderName |
string | Optional | — |
Street |
string | Optional | — |
Zip |
string | Optional | — |
Description |
string | Optional | — |
ClientRef |
string | Optional | — |
Amount |
string | Optional | — |
Frequency |
string | Optional | — |
BeginDate |
string | Optional | — |
EndDate |
string | Optional | — |
InstallementNum |
string | Optional | — |
InstallmentTotal |
string | Optional | — |
LastRunId |
string | Optional | — |
LastSuccessDate |
string | Optional | — |
LastRunDate |
string | Optional | — |
NextRunDate |
string | Optional | — |
NextRunAmount |
string | Optional | — |
FraudAutoDenyOptionsRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Options |
string | Optional | array of int separated by comma. |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
GetUserAutodenyOptionsResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Options |
array of integer (int32) | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
PaymentLinkRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
PaymentLink |
PaymentLinkModel | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
PaymentLinkModel¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Id |
string | Optional | — |
MerchantId |
integer (int32) | Optional | — |
Amount |
string | Optional | — |
Description |
string | Optional | — |
Type |
string — Open, Fixed |
Optional | — |
CreatedOn |
string (date-time) | Optional | — |
PaidOn |
string (date-time) | Optional | — |
DisabledOn |
string (date-time) | Optional | — |
Status |
string — UnPaid, Paid |
Optional | — |
Active |
boolean | Optional | — |
ServiceReferenceNumber |
string | Optional | — |
InvoiceNumber |
string | Optional | — |
ForcedPaymentMethod |
string — Credit, Check, ATHMobile, GooglePay, ApplePay, Debit |
Optional | — |
Link |
string | Optional | — |
AllowRecurringPayment |
boolean | Optional | — |
AllowedPaymentSchedule |
string — OnlySingle, OnlyRecurringOrInstallment, SingleAndRecurringOrInstallment, SingleAndRecurringOnly, SingleAndInstallmentOnly, OnlyRecurring, OnlyInstallment |
Optional | — |
PaymentSchedule |
string — Single, Recurring, Installment |
Optional | — |
IsOpenPaymentSchedule |
boolean | Optional | — |
FrequencyId |
integer (int32) | Optional | — |
StartDate |
string (date-time) | Optional | — |
EndDate |
string (date-time) | Optional | — |
RecurringDescription |
string | Optional | — |
InstallmentTotal |
integer (int32) | Optional | — |
PaymentLinksResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
PaymentLinks |
array of PaymentLinkModel | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
PaymentLinkResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
PaymentLink |
PaymentLinkModel | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
RecurringBillingGetRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
BillingId |
integer (int32) | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
RecurringBillingGetResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Billing |
BillingInfoDisplayable | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
BillingInfoDisplayable¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Id |
integer (int32) | Optional | — |
MerchantId |
integer (int32) | Optional | — |
Token |
string | Optional | — |
Frequency |
string | Optional | — |
AddedOn |
string (date-time) | Optional | — |
LastModifiedOn |
string (date-time) | Optional | — |
StartDate |
string (date-time) | Optional | — |
EndDate |
string (date-time) | Optional | — |
IsInstallment |
boolean | Optional | — |
InstallmentTotal |
integer (int32) | Optional | — |
Amount |
number (double) | Optional | — |
PaymentsCountsSoFar |
integer (int32) | Optional | — |
AmountCollectedSoFar |
number (double) | Optional | — |
LastPaymentDate |
string (date-time) | Optional | — |
NextPaymentDate |
string (date-time) | Optional | — |
FirstName |
string | Optional | — |
LastName |
string | Optional | — |
Street |
string | Optional | — |
City |
string | Optional | — |
State |
string | Optional | — |
ZipCode |
string | Optional | — |
Phone |
string | Optional | — |
Email |
string | Optional | — |
LastFour |
string | Optional | — |
CardType |
string | Optional | — |
Description |
string | Optional | — |
CustomerId |
integer (int32) | Optional | — |
RecurringBillingGetAllResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Billings |
array of BillingInfoDisplayable | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
RecurringBillingRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
IsInstallment |
boolean | Required | — |
InstallmentTotal |
integer (int32) | Required | — |
FrequencyId |
integer (int32) | Required | — |
Amount |
number (double) | Required | — |
StartDate |
string (date-time) | Required | — |
EndDate |
string (date-time) | Optional | — |
Description |
string | Optional | — |
Account |
string | Optional | — |
ExpDate |
string | Optional | — |
Cv |
string | Optional | — |
CardHolderName |
string | Optional | — |
FirstName |
string | Optional | — |
LastName |
string | Optional | — |
Street |
string | Optional | — |
City |
string | Optional | — |
State |
string | Optional | — |
ZipCode |
string | Optional | — |
Phone |
string | Optional | — |
Email |
string | Optional | — |
CardTokenId |
integer (int32) | Optional | — |
SelectedCustomerId |
integer (int32) | Optional | — |
CustomerId |
string | Optional | — |
CustomerZipCode |
string | Optional | — |
TransactionId |
string | Optional | — |
MerchantId |
integer (int32) | Optional | — |
SurchargePercent |
number (double) | Optional | — |
CardDifferencePercent |
number (double) | Optional | — |
TaxPercent |
number (double) | Optional | — |
SecureData |
string | Optional | — |
SecureTransactionId |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
RecurringBillingResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
RecurringBillingEditRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Id |
integer (int32) | Optional | — |
RecurringStart |
string (date-time) | Optional | — |
RecurringEnd |
string (date-time) | Optional | — |
NextPaymentDate |
string (date-time) | Optional | — |
Amount |
number (double) | Optional | — |
FrequencyId |
integer (int32) | Optional | — |
Description |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
RecurringBillingEditResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
RecurringBillingDeactivateRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
BillingId |
integer (int32) | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
RecurringBillingDeactivateResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
SaleReportResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Transactions |
array of Transaction | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
Transaction¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ID |
integer (int32) | Optional | — |
MID |
integer (int32) | Optional | — |
CID |
integer (int32) | Optional | — |
SaleType |
integer (int32) | Optional | — |
UserTransactionNumber |
string | Optional | — |
ServiceTransactionNumber |
string | Optional | — |
Amount |
number (double) | Optional | — |
CurrencyCode |
string | Optional | — |
AuthCode |
string | Optional | — |
LastFour |
string | Optional | — |
CardWasSwiped |
integer (int32) | Optional | — |
CardType |
string | Optional | — |
MadeOn |
string (date-time) | Optional | — |
TransactionRefunded |
integer (int32) | Optional | — |
RefundedAmount |
number (double) | Optional | — |
RefundedOn |
string (date-time) | Optional | — |
TransactionVoided |
integer (int32) | Optional | — |
VoidedOn |
string (date-time) | Optional | — |
MonetraMsg |
string | Optional | — |
BankMsg |
string | Optional | — |
StreetVerificationResult |
string | Optional | — |
CV_VerificationResult |
string | Optional | — |
verbiage |
string | Optional | — |
PlanId |
integer (int32) | Optional | — |
UserId |
integer (int32) | Optional | — |
Token |
string | Optional | — |
BankAuthorizationNumber |
string | Optional | — |
UnsettledTransactionResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
UnsettledTransactions |
array of UnsettledTransaction | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
UnsettledTransaction¶
| Field | Type | Requirement | Description |
|---|---|---|---|
id |
integer (int32) | Optional | — |
mid |
integer (int32) | Optional | — |
cid |
integer (int32) | Optional | — |
batch_number |
string | Optional | — |
UserReferenceNumber |
string | Optional | — |
ServiceReferenceNumber |
string | Optional | — |
SettlementResult |
integer (int32) | Optional | — |
TimeSpan |
string (date-time) | Optional | — |
UsedTransactionNumbers¶
| Field | Type | Requirement | Description |
|---|---|---|---|
UserReferenceNumbers |
array of string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
SettlementReportResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
SettlementReports |
array of SettlementReport | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
SettlementReport¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AmountSettled |
number (double) | Optional | — |
CompletedOn |
string (date-time) | Optional | — |
Batches |
array of BatchReport | Optional | — |
BatchReport¶
| Field | Type | Requirement | Description |
|---|---|---|---|
BatchNumber |
string | Optional | — |
Transactions |
array of SettlementTransaction | Optional | — |
SettlementTransaction¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CashierId |
integer (int32) | Optional | — |
SaleType |
string — CASH, CREDIT, DEBIT, NONE |
Optional | — |
AuthorizationCode |
string | Optional | — |
CardWasSwiped |
boolean | Optional | — |
CardType |
string | Optional | — |
TransactionStatus |
string — SUCCESS, PENDING, DECLINE, PREAUTH_FINAL_NO_PROCESSED |
Optional | — |
TransactionCompletitionStatus |
string — COMPLETED, OPEN |
Optional | — |
CompletedOn |
string (date-time) | Optional | — |
Refunded |
boolean | Optional | — |
RefundedAmount |
number (double) | Optional | — |
RefundedOn |
string (date-time) | Optional | — |
Voided |
boolean | Optional | — |
VoidedOn |
string (date-time) | Optional | — |
MsoftCode |
string | Optional | — |
PhardCode |
string | Optional | — |
Verbiage |
string | Optional | — |
UserTransactionNumber |
string | Optional | — |
ServiceReferenceNumber |
string | Optional | — |
Amount |
number (double) | Optional | — |
Settled |
boolean | Optional | — |
BatchNumber |
string | Optional | — |
Date |
string (date-time) | Optional | — |
ReportRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
StartDate |
string (date-time) | Optional | — |
EndDate |
string (date-time) | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
SummaryRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
HierarchyFilterMode |
integer (int32) | Optional | — |
HierarchyFilterValue |
string | Optional | — |
ViewLevel |
integer (int32) | Optional | — |
CurrentPageIndex |
integer (int32) | Optional | — |
PageSize |
integer (int32) | Optional | — |
FromDate |
string | Optional | — |
ToDate |
string | Optional | — |
GetAuthorizationLogSummaryResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of AuthorizationLogSummary | Optional | — |
Total |
AuthorizationLogSummary | Optional | — |
Paging |
PagingInfo | Optional | — |
ErrorMessages |
object | Optional | — |
AuthorizationLogSummary¶
| Field | Type | Requirement | Description |
|---|---|---|---|
EntityType |
string | Optional | — |
PlatformId |
string | Optional | — |
EntityId |
string | Optional | — |
EntityName |
string | Optional | — |
AuthorizationCount |
integer (int64) | Optional | — |
AuthorizationAmount |
number (double) | Optional | — |
PagingInfo¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CurrentPageIndex |
integer (int32) | Optional | — |
PageSize |
integer (int32) | Optional | — |
NumberOfRecords |
integer (int32) | Optional | — |
GetCardSummaryRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
BatchNumber |
string | Optional | — |
HierarchyFilterMode |
integer (int32) | Optional | — |
HierarchyFilterValue |
string | Optional | — |
ViewLevel |
integer (int32) | Optional | — |
CurrentPageIndex |
integer (int32) | Optional | — |
PageSize |
integer (int32) | Optional | — |
FromDate |
string | Optional | — |
ToDate |
string | Optional | — |
GetCardSummaryResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of CardSummary | Optional | — |
Total |
CardSummary | Optional | — |
Paging |
PagingInfo | Optional | — |
ErrorMessages |
object | Optional | — |
CardSummary¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CardType |
string | Optional | — |
CardDescription |
string | Optional | — |
SaleCount |
integer (int64) | Optional | — |
SaleAmount |
number (double) | Optional | — |
ReturnCount |
integer (int64) | Optional | — |
ReturnAmount |
number (double) | Optional | — |
NetAmount |
number (double) | Optional | — |
GetChargebacksSummaryRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MerchantNumber |
string | Optional | — |
CurrentPageIndex |
integer (int32) | Optional | — |
PageSize |
integer (int32) | Optional | — |
FromDate |
string | Optional | — |
ToDate |
string | Optional | — |
GetChargebacksSummaryResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of Chargeback | Optional | — |
Total |
Chargeback | Optional | — |
Paging |
PagingInfo | Optional | — |
ErrorMessages |
object | Optional | — |
Chargeback¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ReportDate |
string (date-time) | Optional | — |
RecordID |
integer (int64) | Optional | — |
TransactionDate |
string (date-time) | Optional | — |
CardType |
string | Optional | — |
CardTypeDescription |
string | Optional | — |
CardNumber |
string | Optional | — |
ReferenceNumber |
string | Optional | — |
ReasonCode |
string | Optional | — |
ReasonCodeDescription |
string | Optional | — |
ReasonText |
string | Optional | — |
CBType |
string | Optional | — |
CBTypeDescription |
string | Optional | — |
Disposition |
string | Optional | — |
CaseNumber |
string | Optional | — |
RepresentedCBAmount |
number (double) | Optional | — |
TransactionAmount |
number (double) | Optional | — |
AuthorizationCode |
string | Optional | — |
PreDispute |
string | Optional | — |
GetByMerchantRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MerchantNumber |
string | Optional | — |
CurrentPageIndex |
integer (int32) | Optional | — |
PageSize |
integer (int32) | Optional | — |
FromDate |
string | Optional | — |
ToDate |
string | Optional | — |
GetChargebacksDetailResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of Chargeback | Optional | — |
Total |
Chargeback | Optional | — |
Paging |
PagingInfo | Optional | — |
ErrorMessages |
object | Optional | — |
GetDepositsSummaryRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MerchantNumber |
string | Optional | — |
CurrentPageIndex |
integer (int32) | Optional | — |
PageSize |
integer (int32) | Optional | — |
FromDate |
string | Optional | — |
ToDate |
string | Optional | — |
GetDepositsSummaryResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of Deposit | Optional | — |
Total |
Deposit | Optional | — |
Paging |
PagingInfo | Optional | — |
ErrorMessages |
object | Optional | — |
Deposit¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ReportDate |
string (date-time) | Optional | — |
RoutingNumber |
string | Optional | — |
DDANumber |
string | Optional | — |
TraceNumber |
string | Optional | — |
TransmissionDate |
string (date-time) | Optional | — |
TransactionType |
string | Optional | — |
TransactionTypeDescription |
string | Optional | — |
TransactionCode |
string | Optional | — |
TransactionCodeDescription |
string | Optional | — |
DepositAmount |
number (double) | Optional | — |
GetBatchSummaryByMerchantResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of BatchSummaryItem | Optional | — |
Total |
BatchSummaryItem | Optional | — |
Paging |
PagingInfo | Optional | — |
ErrorMessages |
object | Optional | — |
BatchSummaryItem¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ReportDate |
string (date-time) | Optional | — |
TerminalNumber |
string | Optional | — |
FileSource |
string | Optional | — |
BatchNumber |
string | Optional | — |
KeyedPercent |
number (double) | Optional | — |
AvgTrans |
number (double) | Optional | — |
TransactionCount |
integer (int32) | Optional | — |
SaleAmount |
number (double) | Optional | — |
ReturnAmount |
number (double) | Optional | — |
PrepaidDiscount |
number (double) | Optional | — |
NetAmount |
number (double) | Optional | — |
KeyedCount |
integer (int32) | Optional | — |
GetBatchSummaryByEntityResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of BatchSummaryByEntityItem | Optional | — |
Total |
BatchSummaryByEntityItem | Optional | — |
Paging |
PagingInfo | Optional | — |
ErrorMessages |
object | Optional | — |
BatchSummaryByEntityItem¶
| Field | Type | Requirement | Description |
|---|---|---|---|
EntityType |
string | Optional | — |
PlatformId |
string | Optional | — |
EntityId |
string | Optional | — |
EntityName |
string | Optional | — |
PrepaidDiscount |
number (double) | Optional | — |
KeyedPercent |
number (double) | Optional | — |
AvgTrans |
number (double) | Optional | — |
TransactionCount |
integer (int32) | Optional | — |
SaleAmount |
number (double) | Optional | — |
ReturnAmount |
number (double) | Optional | — |
NetAmount |
number (double) | Optional | — |
KeyedCount |
integer (int32) | Optional | — |
GetBatchDetailRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
BatchNumber |
string | Optional | — |
MerchantNumber |
string | Optional | — |
ReportDate |
string | Optional | — |
CurrentPageIndex |
integer (int32) | Optional | — |
PageSize |
integer (int32) | Optional | — |
GetBatchDetailResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of BatchDetailItem | Optional | — |
Total |
BatchDetailItem | Optional | — |
Paging |
PagingInfo | Optional | — |
ErrorMessages |
object | Optional | — |
BatchDetailItem¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ReportDate |
string (date-time) | Optional | — |
TransactionID |
string | Optional | — |
TransactionDate |
string (date-time) | Optional | — |
TransactionTime |
string | Optional | — |
TransactionCode |
string | Optional | — |
TransactionDescription |
string | Optional | — |
Keyed |
string | Optional | — |
EntryModeDescription |
string | Optional | — |
CardType |
string | Optional | — |
CardDescription |
string | Optional | — |
CardNumber |
string | Optional | — |
AuthorizationNumber |
string | Optional | — |
TransactionAmount |
number (double) | Optional | — |
RegulatedID |
integer (int32) | Optional | — |
DebitRoutingMethodID |
integer (int32) | Optional | — |
RegulatedIDDescription |
string | Optional | — |
InvoiceNumber |
string | Optional | — |
GetRetrievalsDetailResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of Retrieval | Optional | — |
Total |
Retrieval | Optional | — |
Paging |
PagingInfo | Optional | — |
ErrorMessages |
object | Optional | — |
Retrieval¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ReportDate |
string (date-time) | Optional | — |
TransactionDate |
string (date-time) | Optional | — |
DateReceived |
string (date-time) | Optional | — |
DueDate |
string (date-time) | Optional | — |
CardType |
string | Optional | — |
CardTypeDescription |
string | Optional | — |
CardNumber |
string | Optional | — |
ReferenceNumber |
string | Optional | — |
ReasonCode |
string | Optional | — |
ReasonCodeDescription |
string | Optional | — |
RequestType |
string | Optional | — |
TransactionAmount |
number (double) | Optional | — |
FilterByMerchantRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MerchantNumber |
string | Optional | — |
GetMerchantStatementListWithZones¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of StatementListItemWithZones | Optional | — |
StatementListItemWithZones¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Zones |
array of string | Optional | — |
MerchantNumber |
string | Optional | — |
StatementDate |
string | Optional | — |
StatementId |
string | Optional | — |
GetMerchantStatementByZoneRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Zone |
string | Optional | — |
StatementId |
string | Optional | — |
MerchantNumber |
string | Optional | — |
GetMerchantStatementResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
Statement | Optional | — |
ErrorMessages |
array of string | Optional | — |
Statement¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MerchantNumber |
string | Optional | — |
StatementId |
string | Optional | — |
StatementData |
string | Optional | — |
SignatureCaptureAddRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
SignatureData |
string | Optional | — |
ServiceTransactionNumber |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
SignatureCaptureGetRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ServiceTransactionNumber |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
SupportedCurrenciesRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CurrencyCode |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
SupportedCurrenciesResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
SupportedCurrencies |
array of Currency | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
Currency¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Name |
string | Optional | — |
Code |
string | Optional | — |
AlphaCode |
string | Optional | — |
GetTransactionRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
UserTransactionNumber |
string | Required | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
SaleRecurringRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
UniqueId |
string | Optional | — |
Frecuency |
string — Daily, Weekly, Biweekl, Monthly, Quarterly, Biannually, Annually, Unscheduled |
Optional | — |
Type |
string — Registration, Subsequent |
Optional | — |
Token |
string | Optional | The Token which identifies the credit card information. |
Comments |
string | Optional | Transaction comments |
Amount |
number (double) | Required | Transaction amount |
ZipCode |
string | Optional | Cardholder’s zip code. Not required if credit card is swiped. |
Street |
string | Optional | — |
CVN |
string | Optional | Credit card verification number (security code). Not required if credit card is swiped. |
CardNumber |
string | Optional | Credit card number. Not required if credit card isswiped. |
ExpDate |
string | Optional | Credit card expiration date (MMYY). Not required if credit card is swiped. |
NameOnCard |
string | Optional | Cardholder Name. Not required if credit card is swiped. |
Track2 |
string | Optional | Credit card track data. Not required if using the No Swipe method. |
EmvData |
string | Optional | — |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
TransactionType |
integer (int32) | Required | Transaction Type | Name | Value | Description | |---|---|---| | CREDIT | 1 | Credit transaction | | CREDIT_WITH_TOKEN | 2 | Credit with token transaction | | Pre_Authorization | 3 | Credit preauthorization request | | Pre_Authorization_Completion | 4 | Credit preauthorization completion | | SaleDebit | 5 | Debit Card Sale transaction | | EBT | 6 | EBT Transaction | | GIFTCARD | 7 | Blackstone Gift Card transaction | |
SURI |
string | Optional | — |
SurchargeAmount |
number (double) | Optional | — |
CardDifferenceAmount |
number (double) | Optional | — |
TaxAmount |
number (double) | Optional | — |
TipAmount |
number (double) | Optional | — |
SecureData |
string | Optional | — |
SecureTransactionId |
string | Optional | — |
SaveToken |
boolean | Optional | — |
CurrencyCode |
string | Optional | — |
SaveCustomer |
boolean | Optional | — |
CustomerId |
integer (int32) | Optional | — |
CustomerPhone |
string | Optional | — |
CustomerEmail |
string | Optional | — |
CustomerCountry |
string | Optional | — |
CustomerState |
string | Optional | — |
CustomerCity |
string | Optional | — |
CustomerAddress |
string | Optional | — |
OrderReference |
string | Optional | — |
PaymentLinkId |
string | Optional | — |
InvoiceNumber |
string | Optional | — |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | — |
DigWltProgType |
string | Optional | — |
DigWltToken |
string | Optional | — |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | — |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | — |
ForceDuplication |
boolean | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ApplePayRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | — |
SurchargeAmount |
number (double) | Optional | — |
CardDifferenceAmount |
number (double) | Optional | — |
TaxAmount |
number (double) | Optional | — |
TipAmount |
number (double) | Optional | — |
CurrencyCode |
string | Optional | — |
SURI |
string | Optional | — |
Token |
string | Required | — |
UserTransactionNumber |
string | Required | — |
CustomerId |
integer (int32) | Optional | — |
CustomerEmail |
string | Optional | — |
OrderReference |
string | Optional | — |
PaymentLinkId |
string | Optional | — |
InvoiceNumber |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ApplePayValidateMerchantRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ValidationUrl |
string | Required | — |
Initiative |
string | Required | — |
InitiativeContext |
string | Required | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
GooglePayRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | — |
SurchargeAmount |
number (double) | Optional | — |
CardDifferenceAmount |
number (double) | Optional | — |
TaxAmount |
number (double) | Optional | — |
TipAmount |
number (double) | Optional | — |
CurrencyCode |
string | Optional | — |
SURI |
string | Optional | — |
Token |
string | Optional | — |
UserTransactionNumber |
string | Required | — |
CustomerId |
integer (int32) | Optional | — |
CustomerEmail |
string | Optional | — |
OrderReference |
string | Optional | — |
PaymentLinkId |
string | Optional | — |
InvoiceNumber |
string | Optional | — |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | — |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ForceRetailSaleRequest¶
Required data to process a Force retail sale
| Field | Type | Requirement | Description |
|---|---|---|---|
AuthNumber |
integer (int32) | Optional | — |
ApprovalCode |
string | Optional | — |
Amount |
number (double) | Required | Transaction amount |
ZipCode |
string | Optional | Cardholder’s zip code. Not required if credit card is swiped. |
Street |
string | Optional | — |
CVN |
string | Optional | Credit card verification number (security code). Not required if credit card is swiped. |
CardNumber |
string | Optional | Credit card number. Not required if credit card isswiped. |
ExpDate |
string | Optional | Credit card expiration date (MMYY). Not required if credit card is swiped. |
NameOnCard |
string | Optional | Cardholder Name. Not required if credit card is swiped. |
Track2 |
string | Optional | Credit card track data. Not required if using the No Swipe method. |
EmvData |
string | Optional | — |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
TransactionType |
integer (int32) | Required | Transaction Type | Name | Value | Description | |---|---|---| | CREDIT | 1 | Credit transaction | | CREDIT_WITH_TOKEN | 2 | Credit with token transaction | | Pre_Authorization | 3 | Credit preauthorization request | | Pre_Authorization_Completion | 4 | Credit preauthorization completion | | SaleDebit | 5 | Debit Card Sale transaction | | EBT | 6 | EBT Transaction | | GIFTCARD | 7 | Blackstone Gift Card transaction | |
SURI |
string | Optional | — |
SurchargeAmount |
number (double) | Optional | — |
CardDifferenceAmount |
number (double) | Optional | — |
TaxAmount |
number (double) | Optional | — |
TipAmount |
number (double) | Optional | — |
SecureData |
string | Optional | — |
SecureTransactionId |
string | Optional | — |
SaveToken |
boolean | Optional | — |
CurrencyCode |
string | Optional | — |
SaveCustomer |
boolean | Optional | — |
CustomerId |
integer (int32) | Optional | — |
CustomerPhone |
string | Optional | — |
CustomerEmail |
string | Optional | — |
CustomerCountry |
string | Optional | — |
CustomerState |
string | Optional | — |
CustomerCity |
string | Optional | — |
CustomerAddress |
string | Optional | — |
OrderReference |
string | Optional | — |
PaymentLinkId |
string | Optional | — |
InvoiceNumber |
string | Optional | — |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | — |
DigWltProgType |
string | Optional | — |
DigWltToken |
string | Optional | — |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | — |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | — |
ForceDuplication |
boolean | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ForceRetailSaleResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
avs |
string | Optional | Street verification message |
ServiceReferenceNumber |
string | Optional | Transaction identifier |
msoft_code |
string | Optional | Processor response message |
phard_code |
string | Optional | Bank response message |
cv |
string | Optional | CV verification message |
AuthorizationNumber |
string | Optional | Bank’s authorization number. Null if transaction was not successful. |
PaymentPlanInfo |
PaymentPlan | Optional | — |
CardType |
string | Optional | Credit Card Type |
LastFour |
string | Optional | — |
Balance |
string | Optional | — |
AcsUrl |
string | Optional | — |
Is3DSecureNeeded |
boolean | Optional | — |
AppliedSurchargeAmount |
number (double) | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
VerificationOnlyRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Account |
string | Optional | — |
ExpDate |
string | Optional | — |
Street |
string | Optional | — |
Zip |
string | Optional | Cardholder’s zip code. Not required if credit card is swiped. |
Cv |
string | Optional | CV verification message |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
VerificationOnlyResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
avs |
string | Optional | Street verification message |
ServiceReferenceNumber |
string | Optional | Transaction identifier |
msoft_code |
string | Optional | Processor response message |
phard_code |
string | Optional | Bank response message |
cv |
string | Optional | CV verification message |
AuthorizationNumber |
string | Optional | Bank’s authorization number. Null if transaction was not successful. |
PaymentPlanInfo |
PaymentPlan | Optional | — |
CardType |
string | Optional | Credit Card Type |
LastFour |
string | Optional | — |
Balance |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
BinDataRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Bin |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
BinDataResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Scheme |
string | Optional | — |
Type |
string | Optional | — |
Brand |
string | Optional | — |
Country |
CountryInfo | Optional | — |
Bank |
BankInfo | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
CountryInfo¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Name |
string | Optional | — |
Emoji |
string | Optional | — |
Alpha2 |
string | Optional | — |
BankInfo¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Name |
string | Optional | — |
Url |
string | Optional | — |
Phone |
string | Optional | — |
SaleWithTokenRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Token |
string | Optional | The Token which identifies the credit card information. |
Comments |
string | Optional | Transaction comments |
Amount |
number (double) | Required | Transaction amount |
ZipCode |
string | Optional | Cardholder’s zip code. Not required if credit card is swiped. |
Street |
string | Optional | — |
CVN |
string | Optional | Credit card verification number (security code). Not required if credit card is swiped. |
CardNumber |
string | Optional | Credit card number. Not required if credit card isswiped. |
ExpDate |
string | Optional | Credit card expiration date (MMYY). Not required if credit card is swiped. |
NameOnCard |
string | Optional | Cardholder Name. Not required if credit card is swiped. |
Track2 |
string | Optional | Credit card track data. Not required if using the No Swipe method. |
EmvData |
string | Optional | — |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
TransactionType |
integer (int32) | Required | Transaction Type | Name | Value | Description | |---|---|---| | CREDIT | 1 | Credit transaction | | CREDIT_WITH_TOKEN | 2 | Credit with token transaction | | Pre_Authorization | 3 | Credit preauthorization request | | Pre_Authorization_Completion | 4 | Credit preauthorization completion | | SaleDebit | 5 | Debit Card Sale transaction | | EBT | 6 | EBT Transaction | | GIFTCARD | 7 | Blackstone Gift Card transaction | |
SURI |
string | Optional | — |
SurchargeAmount |
number (double) | Optional | — |
CardDifferenceAmount |
number (double) | Optional | — |
TaxAmount |
number (double) | Optional | — |
TipAmount |
number (double) | Optional | — |
SecureData |
string | Optional | — |
SecureTransactionId |
string | Optional | — |
SaveToken |
boolean | Optional | — |
CurrencyCode |
string | Optional | — |
SaveCustomer |
boolean | Optional | — |
CustomerId |
integer (int32) | Optional | — |
CustomerPhone |
string | Optional | — |
CustomerEmail |
string | Optional | — |
CustomerCountry |
string | Optional | — |
CustomerState |
string | Optional | — |
CustomerCity |
string | Optional | — |
CustomerAddress |
string | Optional | — |
OrderReference |
string | Optional | — |
PaymentLinkId |
string | Optional | — |
InvoiceNumber |
string | Optional | — |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | — |
DigWltProgType |
string | Optional | — |
DigWltToken |
string | Optional | — |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | — |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | — |
ForceDuplication |
boolean | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
SettlementRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
SettlementResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AmountSettled |
number (double) | Optional | — |
Batches |
array of SettlementBatch | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
SettlementBatch¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ID |
string | Optional | — |
Items |
array of SettlementItem | Optional | — |
AuthCode |
string | Optional | — |
Verbiage |
string | Optional | — |
SettlementItem¶
| Field | Type | Requirement | Description |
|---|---|---|---|
UserTransactionNumber |
string | Optional | — |
ServiceReferenceNumber |
string | Optional | — |
Amount |
number (double) | Optional | — |
Settled |
boolean | Optional | — |
BatchNumber |
string | Optional | — |
Date |
string (date-time) | Optional | — |
DoFullRefundResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
RefundedAmount |
number (double) | Optional | Amount refunded. |
avs |
string | Optional | Street verification message |
ServiceReferenceNumber |
string | Optional | Transaction identifier |
msoft_code |
string | Optional | Processor response message |
phard_code |
string | Optional | Bank response message |
cv |
string | Optional | CV verification message |
AuthorizationNumber |
string | Optional | Bank’s authorization number. Null if transaction was not successful. |
PaymentPlanInfo |
PaymentPlan | Optional | Reference to the merchant plan being used and the related rates. |
CardType |
string | Optional | Credit Card Type |
LastFour |
string | Optional | — |
Balance |
string | Optional | Balance - Original transaction amount minus refund(s). |
Token |
string | Optional | — |
EmvData |
string | Optional | — |
CustomerId |
integer (int32) | Optional | — |
AppliedSurchargeAmount |
number (double) | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |
VoidRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
UserTransactionNumber |
string | Required | The transaction identifier provided by the Blackstone system at the time of the transaction. |
ServiceTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ProcessPreauthRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Account |
string | Optional | Credit card number |
Amount |
number (double) | Required | Preauthorization amount |
expDate |
string | Optional | Credit card expiration date (MMYY) |
NameOnCard |
string | Optional | Cardholder name as it appears on the credit card |
Street |
string | Optional | Cardholder street address |
zipCode |
string | Optional | Cardholder zip code |
cv |
string | Optional | Card Verification |
comments |
string | Optional | Comments |
IsClosable |
boolean | Required | Must be ‘True’ to be able to close the preauthorization request. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
TrackData |
string | Optional | — |
SecureData |
string | Optional | — |
SecureTransactionId |
string | Optional | — |
CurrencyCode |
string | Optional | — |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | — |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ProcessPreauthWithTokenRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Token |
string | Optional | — |
Account |
string | Optional | Credit card number |
Amount |
number (double) | Required | Preauthorization amount |
expDate |
string | Optional | Credit card expiration date (MMYY) |
NameOnCard |
string | Optional | Cardholder name as it appears on the credit card |
Street |
string | Optional | Cardholder street address |
zipCode |
string | Optional | Cardholder zip code |
cv |
string | Optional | Card Verification |
comments |
string | Optional | Comments |
IsClosable |
boolean | Required | Must be ‘True’ to be able to close the preauthorization request. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
TrackData |
string | Optional | — |
SecureData |
string | Optional | — |
SecureTransactionId |
string | Optional | — |
CurrencyCode |
string | Optional | — |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | — |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
ClosePreauthRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ServiceReferenceNumber |
string | Required | The transaction identifier provided by the Blackstone system at the time of the transaction. |
Amount |
number (double) | Required | Transaction Amount |
AdditionalTip |
number (double) | Optional | Additional Tip Amount |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
CurrencyCode |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
GetCardPANRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Token |
string | Optional | — |
AppKey |
string | Required | Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) | Required | Application Type as provided by the Blackstone system. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string | Required | User credential of the client on the host. |
Password |
string | Required | Password of the client on the host. |
IpAddress |
string | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | — |
AppInfo |
string | Optional | — |
IsTest |
boolean | Optional | — |
GetCardPANResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CardHolderName |
string | Optional | — |
CardNumber |
string | Optional | — |
CVV |
string | Optional | — |
ExpDate |
string | Optional | — |
ResponseCode |
integer (int32) | Optional | The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Check the Response Codes section for more details. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
verbiage |
string | Optional | — |
displayMessage |
string | Optional | — |