Schemas¶
136 request and response models generated from the API contract.
ATHMobileTransaction¶
| Field | Type | Requirement | Description |
|---|---|---|---|
BusinessCustomerId |
string | Optional | — |
DailyTransactionId |
integer (int32) | Optional | — |
EcommerceId |
string | Optional | — |
EcommerceStatus |
string — Open, Completed, Cancel, Confirm |
Optional | — |
Fee |
number (double) | Optional | — |
Id |
string (uuid) | Optional | — |
Mid |
integer (int32) | Optional | — |
NetAmount |
number (double) | Optional | — |
ReferenceNumber |
string | Optional | — |
SubTotal |
number (double) | Optional | — |
Tax |
number (double) | Optional | — |
Total |
number (double) | Optional | — |
TotalRefundedAmount |
number (double) | Optional | — |
TransactionDate |
string (date-time) | Optional | — |
ATHMobileTransactionRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
BusinessCustomerId |
string | Optional | — |
DailyTransactionId |
integer (int32) | Optional | — |
EcommerceId |
string | Optional | — |
EcommerceStatus |
string — Open, Completed, Cancel, Confirm |
Optional | — |
Fee |
number (double) | Optional | — |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Merchantid |
integer (int32) | Optional | — |
NetAmount |
number (double) | Optional | — |
Password |
string | Required | Password of the client on the host. |
ReferenceNumber |
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 | The source of the request |
SubTotal |
number (double) | Optional | — |
Tax |
number (double) | Optional | — |
Total |
number (double) | Optional | — |
TotalRefundedAmount |
number (double) | Optional | — |
TransactionDate |
string (date-time) | Optional | — |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
ATHMobileTransactionResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
Transactions |
array of ATHMobileTransaction | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
AchReportParameters¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AccountNumber |
string | Optional | — |
Amount |
number (double) | Optional | — |
BeginAchDate |
string (date-time) | Optional | — |
CheckNumber |
string | Optional | — |
EndAchDate |
string (date-time) | Optional | — |
Id |
integer (int32) | Optional | — |
MerchantId |
integer (int32) | Optional | — |
RoutingNumber |
string | Optional | — |
AchReportRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Parameters |
AchReportParameters | Optional | Parameters. |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
AchReportResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
Transactions |
array of AchTransaction | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
AchRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ACCOUNT_NUMBER |
string | Optional | Account Number. |
ACCOUNT_TYPE |
string | Optional | Account Type. |
ADDRESS1 |
string | Optional | Address 1. |
ADDRESS2 |
string | Optional | Address 2. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CHECK_AMOUNT |
string | Optional | Check Amount. |
CHECK_NUMBER |
string | Optional | Check Number. |
CITY |
string | Optional | City. |
COMPANY_NAME |
string | Optional | Company Name. |
COURTESY_CARD_ID |
string | Optional | Courtesy Card Identifier. |
DL_NUMBER |
string | Optional | DL Number. |
DL_STATE |
string | Optional | DL State. |
DOB_YEAR |
string | Optional | DOB Year. |
FIRST_NAME |
string | Optional | First Name. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
LAST_NAME |
string | Optional | Last Name. |
Method |
integer (int32) | Optional | Method. |
PHONE_NUMBER |
string | Optional | Phone Number. |
Password |
string | Required | Password of the client on the host. |
ROUTING_NUMBER |
string | Optional | Routing Number. |
SSN4 |
string | Optional | SSN4. |
STATE |
string | Optional | State. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
TerminalID |
string | Optional | Terminal Identifier. |
UserName |
string | Required | User credential of the client on the host. |
ZIP |
string | Optional | Zip. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
AchResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Code |
string | Optional | — |
CodeTypeMsg |
array of string | Optional | — |
ErrorMessages |
array of string | Optional | — |
Message |
string | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
ResponseType |
string | Optional | — |
ResponseTypeText |
string | Optional | — |
ResultCode |
string | Optional | — |
ResultCodeMsg |
array of string | Optional | — |
TransactionInfo |
AchTransactionInfo | Optional | — |
TypeCode |
string | Optional | — |
ValidationMessage |
string | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
AchTransaction¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AccountNumber |
string | Optional | — |
AccountType |
string | Optional | — |
CheckAmount |
number (double) | Optional | — |
CheckNumber |
string | Optional | — |
Code |
string | Optional | — |
MadeOn |
string (date-time) | Optional | — |
Message |
string | Optional | — |
PacketIdentifier |
string | Optional | — |
ResponseFromHostReceived |
boolean | Optional | — |
ResponseType |
string | Optional | — |
ResponseTypeText |
string | Optional | — |
ResultCode |
string | Optional | — |
RoutingNumber |
string | Optional | — |
TerminalId |
string | Optional | — |
TransactionId |
string | Optional | — |
TransactionReverted |
boolean | Optional | — |
TransactionRevertedOn |
string (date-time) | Optional | — |
TransactionVoided |
boolean | Optional | — |
TransactionVoidedOn |
string (date-time) | Optional | — |
TypeCode |
string | Optional | — |
id |
integer (int32) | Optional | — |
mid |
integer (int32) | Optional | — |
userId |
integer (int32) | Optional | — |
AchTransactionInfo¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AccountNumber |
string | Optional | — |
AchId |
integer (int32) | Optional | — |
CheckAmount |
string | Optional | — |
RoutingNumber |
string | Optional | — |
ServiceTransactionNumber |
string | Optional | — |
AchVoidRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AbaRouting |
string | Optional | ABA Routing. |
AccountNumber |
string | Optional | Account Number. |
AchAmount |
number (double) | Optional | ACH Amount. |
AchId |
integer (int32) | Optional | Ach Identifier. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
AchVoidResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Code |
string | Optional | — |
CodeTypeMsg |
array of string | Optional | — |
Message |
string | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
ResponseType |
string | Optional | — |
ResponseTypeText |
string | Optional | — |
ResultCode |
string | Optional | — |
ResultCodeMsg |
array of string | Optional | — |
TypeCode |
string | Optional | — |
ValidationMessage |
string | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
AddUserResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MonetraResponse |
string | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
ApplePayRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | Transaction amount |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CardDifferenceAmount |
number (double) | Optional | The amount dedicated to the card difference (this is an optional charge passed on to the user) |
CurrencyCode |
string | Optional | The Code of the currency to process the transaction. By default, USD dollar is used. |
CustomerEmail |
string | Optional | The email for the customer in the e-commerce transaction (optional) |
CustomerId |
integer (int32) | Optional | The ID of the merchant's customer |
InvoiceNumber |
string | Optional | Optional invoice number associated with the transaction. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
OrderReference |
string | Optional | Optional reference for the order in case it applies |
Password |
string | Required | Password of the client on the host. |
PaymentLinkId |
string | Optional | Optional Payment Link identifier when the transaction is paid from a payment link. |
SURI |
string | Optional | SURI number |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
SurchargeAmount |
number (double) | Optional | The amount dedicated to the surcharge (this is an optional charge passed on to the user) |
TaxAmount |
number (double) | Optional | The amount dedicated to the tax (this is an optional charge configurable by the merchant) |
TipAmount |
number (double) | Optional | The amount dedicated to the tip (this is an optional charge for the client with a default value configurable by the merchant) |
Token |
string | Required | Base64 encoded Apple Pay token used for payment authorization. The decoded JSON payload supports: { paymentData: { ... } }, { token: { ... } }, direct paymentData object { data, signature, version, header }, and also paymentData/token values as JSON strings. |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
ApplePayValidateMerchantRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
Initiative |
string | Required | — |
InitiativeContext |
string | Required | — |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
ValidationUrl |
string | Required | — |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
AuthorizationLogSummary¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AuthorizationAmount |
number (double) | Optional | — |
AuthorizationCount |
integer (int64) | Optional | — |
EntityId |
string | Optional | — |
EntityName |
string | Optional | — |
EntityType |
string | Optional | — |
PlatformId |
string | Optional | — |
AutomaticBatchCloseRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
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. |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
BankInfo¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Name |
string | Optional | — |
Phone |
string | Optional | — |
Url |
string | Optional | — |
BatchDetailItem¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AuthorizationNumber |
string | Optional | — |
CardDescription |
string | Optional | — |
CardNumber |
string | Optional | — |
CardType |
string | Optional | — |
DebitRoutingMethodID |
integer (int32) | Optional | — |
EntryModeDescription |
string | Optional | — |
InvoiceNumber |
string | Optional | — |
Keyed |
string | Optional | — |
RegulatedID |
integer (int32) | Optional | — |
RegulatedIDDescription |
string | Optional | — |
ReportDate |
string (date-time) | Optional | — |
TransactionAmount |
number (double) | Optional | — |
TransactionCode |
string | Optional | — |
TransactionDate |
string (date-time) | Optional | — |
TransactionDescription |
string | Optional | — |
TransactionID |
string | Optional | — |
TransactionTime |
string | Optional | — |
BatchReport¶
| Field | Type | Requirement | Description |
|---|---|---|---|
BatchNumber |
string | Optional | — |
Transactions |
array of SettlementTransaction | Optional | — |
BatchSummaryByEntityItem¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AvgTrans |
number (double) | Optional | — |
EntityId |
string | Optional | — |
EntityName |
string | Optional | — |
EntityType |
string | Optional | — |
KeyedCount |
integer (int32) | Optional | — |
KeyedPercent |
number (double) | Optional | — |
NetAmount |
number (double) | Optional | — |
PlatformId |
string | Optional | — |
PrepaidDiscount |
number (double) | Optional | — |
ReturnAmount |
number (double) | Optional | — |
SaleAmount |
number (double) | Optional | — |
TransactionCount |
integer (int32) | Optional | — |
BatchSummaryItem¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AvgTrans |
number (double) | Optional | — |
BatchNumber |
string | Optional | — |
FileSource |
string | Optional | — |
KeyedCount |
integer (int32) | Optional | — |
KeyedPercent |
number (double) | Optional | — |
NetAmount |
number (double) | Optional | — |
PrepaidDiscount |
number (double) | Optional | — |
ReportDate |
string (date-time) | Optional | — |
ReturnAmount |
number (double) | Optional | — |
SaleAmount |
number (double) | Optional | — |
TerminalNumber |
string | Optional | — |
TransactionCount |
integer (int32) | Optional | — |
BillingInfoDisplayable¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AddedOn |
string (date-time) | Optional | — |
Amount |
number (double) | Optional | — |
AmountCollectedSoFar |
number (double) | Optional | — |
CardType |
string | Optional | — |
City |
string | Optional | — |
CustomerId |
integer (int32) | Optional | — |
Description |
string | Optional | — |
Email |
string | Optional | — |
EndDate |
string (date-time) | Optional | — |
FirstName |
string | Optional | — |
Frequency |
string | Optional | — |
Id |
integer (int32) | Optional | — |
InstallmentTotal |
integer (int32) | Optional | — |
IsInstallment |
boolean | Optional | — |
LastFour |
string | Optional | — |
LastModifiedOn |
string (date-time) | Optional | — |
LastName |
string | Optional | — |
LastPaymentDate |
string (date-time) | Optional | — |
MerchantId |
integer (int32) | Optional | — |
NextPaymentDate |
string (date-time) | Optional | — |
PaymentsCountsSoFar |
integer (int32) | Optional | — |
Phone |
string | Optional | — |
StartDate |
string (date-time) | Optional | — |
State |
string | Optional | — |
Street |
string | Optional | — |
Token |
string | Optional | — |
ZipCode |
string | Optional | — |
BinDataRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
Bin |
string | Required | Bank Identification Number to look up. The JSON property name is Bin; BinNumber is not an alias. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
BinDataResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Bank |
BankInfo | Optional | — |
Brand |
string | Optional | — |
Country |
CountryInfo | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
Scheme |
string | Optional | — |
Type |
string | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
BusinessSettingResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CardDifferenceEnabled |
boolean | Optional | — |
CardDifferencePercent |
number (double) | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
SurchargeEnabled |
boolean | Optional | — |
SurchargePercent |
number (double) | Optional | — |
ThreeDSecureEnabled |
boolean | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
CardSummary¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CardDescription |
string | Optional | — |
CardType |
string | Optional | — |
NetAmount |
number (double) | Optional | — |
ReturnAmount |
number (double) | Optional | — |
ReturnCount |
integer (int64) | Optional | — |
SaleAmount |
number (double) | Optional | — |
SaleCount |
integer (int64) | Optional | — |
Cashier¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CanSale |
boolean | Optional | — |
DataWireId |
string | Optional | — |
DataWireIdBackUp |
string | Optional | — |
WebsitePaymentsCount |
integer (int32) | Optional | — |
createdOn |
string (date-time) | Optional | — |
description |
string | Optional | — |
first_name |
string | Optional | — |
host_pass |
string | Optional | — |
host_user |
string | Optional | — |
id |
integer (int32) | Optional | — |
in_black_list |
boolean | Optional | — |
isDemo |
boolean | Optional | — |
is_enable |
boolean | Optional | — |
last_name |
string | Optional | — |
mid |
integer (int32) | Optional | — |
picture_link |
string | Optional | — |
user_name |
string | Optional | — |
user_pass |
string | Optional | — |
ChangeMonetraUserResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MonetraResponse |
string | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
Chargeback¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AuthorizationCode |
string | Optional | — |
CBType |
string | Optional | — |
CBTypeDescription |
string | Optional | — |
CardNumber |
string | Optional | — |
CardType |
string | Optional | — |
CardTypeDescription |
string | Optional | — |
CaseNumber |
string | Optional | — |
Disposition |
string | Optional | — |
PreDispute |
string | Optional | — |
ReasonCode |
string | Optional | — |
ReasonCodeDescription |
string | Optional | — |
ReasonText |
string | Optional | — |
RecordID |
integer (int64) | Optional | — |
ReferenceNumber |
string | Optional | — |
ReportDate |
string (date-time) | Optional | — |
RepresentedCBAmount |
number (double) | Optional | — |
TransactionAmount |
number (double) | Optional | — |
TransactionDate |
string (date-time) | Optional | — |
CheckReportResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
Transactions |
array of CheckTransactionReport | Optional | Transactions |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
CheckRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ACCOUNT_NUMBER |
string | Optional | Check Account Number |
ACCOUNT_TYPE |
string | Optional | Account Type | Name | Value | Description | |---|---|---| | CHECKING | Checking | Checking Account | | SAVING | Saving | Savings Account | |
ADDRESS1 |
string | Optional | Address line 1 |
ADDRESS2 |
string | Optional | Address line 2 |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CHECK_AMOUNT |
string | Optional | Check Amount |
CHECK_NUMBER |
string | Optional | Check number |
CITY |
string | Optional | Address City |
COMPANY_NAME |
string | Optional | Company Name |
COURTESY_CARD_ID |
string | Optional | Courtesy Card ID |
CheckTransactionId |
integer (int32) | Optional | Prior transaction id - for void / refund |
DL_NUMBER |
string | Optional | Driver’s License 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 | |
DOB_YEAR |
string | Optional | Birthdate's year |
FIRST_NAME |
string | Optional | First Name on check. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
LAST_NAME |
string | Optional | Last Name on check. |
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:
|
PHONE_NUMBER |
string | Optional | Phone Number |
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. | |
Password |
string | Required | Password of the client on the host. |
ROUTING_NUMBER |
string | Optional | Bank routing number |
SSN4 |
string | Optional | Last 4 digits of the Social Security number |
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 | |
SaveToken |
boolean | Optional | Indicates whether to enable saving of payment information for future use. When true, the payment details will be securely stored and a reusable token will be generated. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
TerminalID |
string | Optional | Identify the device which is doing the transaction. |
UserName |
string | Required | User credential of the client on the host. |
ZIP |
string | Optional | Address Zip Code |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
CheckResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Code |
string | Optional | — |
CodeTypeMsg |
array of string | Optional | — |
ErrorMessages |
array of string | Optional | — |
Message |
string | Optional | Check Processor Message filed, ONLY FOR REFERENCE |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
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 |
ResultCodeMsg |
array of string | Optional | — |
Token |
string | Optional | Token generated when SaveToken = true in request. Contains the UUIDv4 token that can be used for future transactions. |
TransactionInfo |
CheckTransactionInfo | Optional | Transaction information that should be stored for future reference. |
TypeCode |
string | Optional | Check Processor TypeCode field, ONLY FOR REFERENCE |
ValidationMessage |
string | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
CheckTokenRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CHECK_AMOUNT |
string | Required | Check Amount for this transaction |
CHECK_NUMBER |
string | Optional | Check number for this transaction (optional) |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
Token |
string | Required | UUIDv4 token that identifies the saved CheckToken |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
CheckTransactionInfo¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AccountNumber |
string | Optional | Check account number |
CheckAmount |
string | Optional | Amount |
CheckNumber |
string | Optional | Check Number |
RoutingNumber |
string | Optional | Bank routing number |
ServiceTransactionNumber |
string | Optional | — |
CheckTransactionReport¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AccountNumber |
string | Optional | — |
AccountType |
string | Optional | — |
CheckAmount |
number (double) | Optional | — |
CheckNumber |
string | Optional | — |
Code |
string | Optional | — |
MadeOn |
string (date-time) | Optional | — |
Message |
string | Optional | — |
PacketIdentifier |
string | Optional | — |
ResponseType |
string | Optional | — |
ResponseTypeText |
string | Optional | — |
ResultCode |
string | Optional | — |
RoutingNumber |
string | Optional | — |
ServiceTransactionNumber |
string | Optional | — |
TransactionVoided |
boolean | Optional | — |
TransactionVoidedOn |
string (date-time) | Optional | — |
TypeCode |
string | Optional | — |
mid |
integer (int32) | Optional | — |
ClosePreauthRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AdditionalTip |
number (double) | Optional | Additional Tip Amount |
Amount |
number (double) | Required | Transaction Amount |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CurrencyCode |
string | Optional | — |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
ServiceReferenceNumber |
string | Required | The transaction identifier provided by the Blackstone system at the time of the transaction. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
CountryInfo¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Alpha2 |
string | Optional | — |
Emoji |
string | Optional | — |
Name |
string | Optional | — |
Currency¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AlphaCode |
string | Optional | — |
Code |
string | Optional | — |
Name |
string | Optional | — |
Customer¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AddedOn |
string (date-time) | Optional | — |
City |
string | Optional | — |
Country |
string | Optional | — |
CreateDate |
string (date-time) | Optional | — |
CustomerId |
string | Optional | — |
CustomerSource |
string — Gateway, Quickbooks, API |
Optional | — |
Email |
string | Optional | — |
FirstName |
string | Optional | — |
Id |
integer (int32) | Optional | — |
Invoice |
string | Optional | — |
LastName |
string | Optional | — |
MID |
integer (int32) | Optional | — |
PO |
string | Optional | — |
Phone |
string | Optional | — |
State |
string | Optional | — |
Status |
integer (int32) | Optional | — |
Street |
string | Optional | — |
Zip |
string | Optional | — |
CustomersReponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Customers |
array of Customer | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
DeleteUserRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
ProcessorId |
integer (int32) | Optional | Processor Identifier. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
DeleteUserResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
Deposit¶
| Field | Type | Requirement | Description |
|---|---|---|---|
DDANumber |
string | Optional | — |
DepositAmount |
number (double) | Optional | — |
ReportDate |
string (date-time) | Optional | — |
RoutingNumber |
string | Optional | — |
TraceNumber |
string | Optional | — |
TransactionCode |
string | Optional | — |
TransactionCodeDescription |
string | Optional | — |
TransactionType |
string | Optional | — |
TransactionTypeDescription |
string | Optional | — |
TransmissionDate |
string (date-time) | Optional | — |
DoFullRefundResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Optional | Recorded base transaction amount; null when no transaction amounts are available. |
AppliedSurchargeAmount |
number (double) | Optional | Surcharge amount that was actually applied after server-side rules, including debit-card BIN detection. |
AuthorizationNumber |
string | Optional | Bank�s authorization number. Null if transaction was not successful. |
Balance |
string | Optional | Balance - Original transaction amount minus refund(s). |
CardDifferenceAmount |
number (double) | Optional | Recorded CardDifferenceAmount component; null when not recorded. |
CardType |
string | Optional | Credit Card Type |
CustomerId |
integer (int32) | Optional | — |
EmvData |
string | Optional | — |
LastFour |
string | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
PaymentPlanInfo |
PaymentPlan | Optional | Reference to the merchant plan being used and the related rates. |
RefundedAmount |
number (double) | Optional | Amount refunded. |
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. |
ServiceReferenceNumber |
string | Optional | Transaction identifier |
SurchargeAmount |
number (double) | Optional | Recorded SurchargeAmount component; null when not recorded. |
TaxAmount |
number (double) | Optional | Recorded TaxAmount component; null when not recorded. |
TipAmount |
number (double) | Optional | Recorded TipAmount component; null when not recorded. |
Token |
string | Optional | — |
TotalAmount |
number (double) | Optional | Recorded total: Amount + TaxAmount + SurchargeAmount + CardDifferenceAmount + TipAmount; excludes CashbackAmount. Not confirmation of capture or settlement. |
avs |
string | Optional | Street verification message |
cv |
string | Optional | CV verification message |
displayMessage |
string | Optional | Transaction processing user-friendly message |
msoft_code |
string | Optional | Processor response message |
phard_code |
string | Optional | Bank response message |
verbiage |
string | Optional | Transaction processing informational message |
DoesUserExistResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
DoesUserExist |
boolean | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
EtbFoodStampRefundRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Account |
string | Optional | Card number. Optional if using swipe method. Otherwise required. |
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. The API refunds this exact amount and does not automatically prorate a surcharge into a separate refund component. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
ExpDate |
string | Optional | Card expiration date (MMYY). |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
KSN |
string | Optional | Pin pad data. |
Password |
string | Required | Password of the client on the host. |
PinBlock |
string | Optional | Pin pad block. |
SURI |
string | Optional | SURI number |
ServiceTransactionNumber |
string | Required | The transaction identifier provided by the Blackstone system at the time of the original transaction. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
TrackData |
string | Optional | Card track data. Optional if using the No Swipe method. |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for referencepurposes only; must be unique. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
FilterByMerchantRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MerchantNumber |
string | Optional | — |
ForceRetailSaleRequest¶
Required data to process a Force retail sale
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | Transaction amount as a JSON number. Quoted numeric strings are not part of the public contract. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
ApprovalCode |
string | Optional | The approval code received from the bank |
AuthNumber |
integer (int32) | Optional | Auth Number. |
CVN |
string | Optional | Credit card verification number (security code). Not required if credit card is swiped. |
CardDifferenceAmount |
number (double) | Optional | The amount dedicated to the card difference (this is an optional charge passed on to the user) |
CardNumber |
string | Optional | Credit card number. Not required if credit card isswiped. |
CurrencyCode |
string | Optional | The Code of the currency to process the transaction. By default, USD dollar is used. |
CustomerAddress |
string | Optional | Optional address for the customer |
CustomerCity |
string | Optional | Optional city for the customer |
CustomerCountry |
string | Optional | Optional country for the customer |
CustomerEmail |
string | Optional | The email for the customer in the e-commerce transaction (optional) |
CustomerId |
integer (int32) | Optional | The merchant customer ID as a JSON integer. Quoted strings are not part of the public contract. |
CustomerPhone |
string | Optional | The phone number for the customer in the e-commerce transaction (optional) |
CustomerState |
string | Optional | Optional state for the customer |
DigWltProgType |
string | Optional | — |
DigWltToken |
string | Optional | — |
EmvData |
string | Optional | Contactless data. |
ExpDate |
string | Optional | Credit card expiration date. SaleWithToken accepts MMYY or MM/YY; other sale flows require MMYY. Not required if credit card is swiped. Rapid Connect token sales use the valid stored token expiration when available and otherwise require this field. |
ForceDuplication |
boolean | Optional | Indicates whether the payment should be executed even if a recent payment exists with the same signature. |
InvoiceNumber |
string | Optional | Optional invoice number associated with the transaction. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
NameOnCard |
string | Optional | Cardholder Name. Not required if credit card is swiped. |
OrderReference |
string | Optional | Optional reference for the order in case it applies |
Password |
string | Required | Password of the client on the host. |
PaymentLinkId |
string | Optional | Optional Payment Link identifier when the transaction is paid from a payment link. |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | The condition in which the payment was captured |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | The entry mode in which the payment was captured |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | Optional Purchase Card Level 2 data sent to Rapid Connect for commercial card processing. |
SURI |
string | Optional | SURI number |
SaveCustomer |
boolean | Optional | This optional parameter indicates if the merchant wants to save the customer |
SaveToken |
boolean | Optional | Indicates to return a token for the card in case the transaction was successful |
SecureData |
string | Optional | The 3D secure data present once the 3D secure flow has been triggered for the transaction |
SecureTransactionId |
string | Optional | ID of the secure transaction |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
Street |
string | Optional | Cardholder�s billing street. Not required if credit card is swiped. |
SurchargeAmount |
number (double) | Optional | Optional surcharge amount as a JSON number. Direct API callers calculate and supply this value; the API does not derive it from the merchant's configured surcharge percentage. |
TaxAmount |
number (double) | Optional | The amount dedicated to the tax (this is an optional charge configurable by the merchant) |
TipAmount |
number (double) | Optional | The amount dedicated to the tip (this is an optional charge for the client with a default value configurable by the merchant) |
Track2 |
string | Optional | Credit card track data. Not required if using the No Swipe method. |
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 | |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
ZipCode |
string | Optional | Cardholder�s zip code. Not required if credit card is swiped. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
ForceRetailSaleResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AcsUrl |
string | Optional | — |
AppliedSurchargeAmount |
number (double) | Optional | Surcharge amount that was actually applied after server-side rules. |
AuthorizationNumber |
string | Optional | Bank’s authorization number. Null if transaction was not successful. |
Balance |
string | Optional | — |
CardType |
string | Optional | Credit Card Type |
Is3DSecureNeeded |
boolean | Optional | — |
LastFour |
string | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
PaymentPlanInfo |
PaymentPlan | 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. |
ServiceReferenceNumber |
string | Optional | Transaction identifier |
avs |
string | Optional | Street verification message |
cv |
string | Optional | CV verification message |
displayMessage |
string | Optional | Transaction processing user-friendly message |
msoft_code |
string | Optional | Processor response message |
phard_code |
string | Optional | Bank response message |
verbiage |
string | Optional | Transaction processing informational message |
FraudAutoDenyOptionsRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Options |
string | Optional | Options to add: Array of int separated by comma. |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
GetAuthorizationLogSummaryResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ErrorMessages |
object | Optional | — |
Paging |
PagingInfo | Optional | — |
Result |
array of AuthorizationLogSummary | Optional | — |
Total |
AuthorizationLogSummary | Optional | — |
GetBatchDetailRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
BatchNumber |
string | Optional | — |
CurrentPageIndex |
integer (int32) | Optional | — |
MerchantNumber |
string | Optional | — |
PageSize |
integer (int32) | Optional | — |
ReportDate |
string | Optional | — |
GetBatchDetailResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ErrorMessages |
object | Optional | — |
Paging |
PagingInfo | Optional | — |
Result |
array of BatchDetailItem | Optional | — |
Total |
BatchDetailItem | Optional | — |
GetBatchSummaryByEntityResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ErrorMessages |
object | Optional | — |
Paging |
PagingInfo | Optional | — |
Result |
array of BatchSummaryByEntityItem | Optional | — |
Total |
BatchSummaryByEntityItem | Optional | — |
GetBatchSummaryByMerchantResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ErrorMessages |
object | Optional | — |
Paging |
PagingInfo | Optional | — |
Result |
array of BatchSummaryItem | Optional | — |
Total |
BatchSummaryItem | Optional | — |
GetByMerchantRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CurrentPageIndex |
integer (int32) | Optional | — |
FromDate |
string | Optional | — |
MerchantNumber |
string | Optional | — |
PageSize |
integer (int32) | Optional | — |
ToDate |
string | Optional | — |
GetCardPANRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
Token |
string | Optional | — |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
GetCardPANResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CVV |
string | Optional | — |
CardHolderName |
string | Optional | — |
CardNumber |
string | Optional | — |
ExpDate |
string | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
GetCardSummaryRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
BatchNumber |
string | Optional | — |
CurrentPageIndex |
integer (int32) | Optional | — |
FromDate |
string | Optional | — |
HierarchyFilterMode |
integer (int32) | Optional | — |
HierarchyFilterValue |
string | Optional | — |
PageSize |
integer (int32) | Optional | — |
ToDate |
string | Optional | — |
ViewLevel |
integer (int32) | Optional | — |
GetCardSummaryResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ErrorMessages |
object | Optional | — |
Paging |
PagingInfo | Optional | — |
Result |
array of CardSummary | Optional | — |
Total |
CardSummary | Optional | — |
GetChargebacksDetailResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ErrorMessages |
object | Optional | — |
Paging |
PagingInfo | Optional | — |
Result |
array of Chargeback | Optional | — |
Total |
Chargeback | Optional | — |
GetChargebacksSummaryRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CurrentPageIndex |
integer (int32) | Optional | — |
FromDate |
string | Optional | — |
MerchantNumber |
string | Optional | — |
PageSize |
integer (int32) | Optional | — |
ToDate |
string | Optional | — |
GetChargebacksSummaryResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ErrorMessages |
object | Optional | — |
Paging |
PagingInfo | Optional | — |
Result |
array of Chargeback | Optional | — |
Total |
Chargeback | Optional | — |
GetCredentialsRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
ExtraData |
string | Optional | Extra Data. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
ProcessorId |
integer (int32) | Optional | Processor Identifier. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
GetCredentialsResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
UserName |
string | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
GetDepositsSummaryRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CurrentPageIndex |
integer (int32) | Optional | — |
FromDate |
string | Optional | — |
MerchantNumber |
string | Optional | — |
PageSize |
integer (int32) | Optional | — |
ToDate |
string | Optional | — |
GetDepositsSummaryResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ErrorMessages |
object | Optional | — |
Paging |
PagingInfo | Optional | — |
Result |
array of Deposit | Optional | — |
Total |
Deposit | Optional | — |
GetMerchantStatementByZoneRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MerchantNumber |
string | Optional | — |
StatementId |
string | Optional | — |
Zone |
string | Optional | — |
GetMerchantStatementListWithZones¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Result |
array of StatementListItemWithZones | Optional | — |
GetMerchantStatementResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ErrorMessages |
array of string | Optional | — |
Result |
Statement | Optional | — |
GetRetrievalsDetailResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ErrorMessages |
object | Optional | — |
Paging |
PagingInfo | Optional | — |
Result |
array of Retrieval | Optional | — |
Total |
Retrieval | Optional | — |
GetTokenForCardRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Account |
string | Required | Card PAN. The JSON property name is Account; CardNumber is not an alias for this endpoint. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
ExistingToken |
string | Optional | If existing token only store the token, don't recreated it |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
NameOnCard |
string | Optional | Name on card |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
Street |
string | Optional | Cardholder street address |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
clientRef |
string | Optional | — |
cv |
string | Optional | Card verification code |
description |
string | Optional | Token / Card description |
expDate |
string | Optional | Card expiration date |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
zipCode |
string | Optional | Cardholder zip code |
GetTokenForCardResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AuthCode |
string | Optional | Processor auth code |
Identifier |
string | Optional | Identifier for this stored token record. A later tokenization request for the same physical card is not guaranteed to return or reuse this identifier. |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
PhardCode |
string | Optional | Bank response message |
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. |
Token |
string | Optional | The token which identifies the credit card information. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
msoft_code |
string | Optional | Processor response message |
verbiage |
string | Optional | Transaction processing informational message |
GetTransactionRequest¶
Required data to process a sale
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The original UserTransactionNumber supplied by the integrator when the transaction was created. This endpoint does not search by ServiceReferenceNumber or ServiceTransactionNumber. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
GetUserAutodenyOptionsResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
GooglePayRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | Transaction amount |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CardDifferenceAmount |
number (double) | Optional | The amount dedicated to the card difference (this is an optional charge passed on to the user) |
CurrencyCode |
string | Optional | The Code of the currency to process the transaction. By default, USD dollar is used. |
CustomerEmail |
string | Optional | The email for the customer in the e-commerce transaction (optional) |
CustomerId |
integer (int32) | Optional | The ID of the merchant's customer |
InvoiceNumber |
string | Optional | Optional invoice number associated with the transaction. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
OrderReference |
string | Optional | Optional reference for the order in case it applies |
Password |
string | Required | Password of the client on the host. |
PaymentLinkId |
string | Optional | Optional Payment Link identifier when the transaction is paid from a payment link. |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | The condition in which the payment was captured |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | The entry mode in which the payment was captured |
SURI |
string | Optional | SURI number |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
SurchargeAmount |
number (double) | Optional | The amount dedicated to the surcharge (this is an optional charge passed on to the user) |
TaxAmount |
number (double) | Optional | The amount dedicated to the tax (this is an optional charge configurable by the merchant) |
TipAmount |
number (double) | Optional | The amount dedicated to the tip (this is an optional charge for the client with a default value configurable by the merchant) |
Token |
string | Optional | The encrypted Google Pay token used for payment authorization, not a plain credit card number. |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
MerchantSubAccountsResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
SubAccounts |
array of Cashier | Optional | List of cashiers (subaccounts). |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
MonetraChangeDataWireIdRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
DataWireID |
string | Optional | Data Wire Identifier. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
ProcessorMid |
string | Optional | Processor Merchant Identifier. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
PagingInfo¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CurrentPageIndex |
integer (int32) | Optional | — |
NumberOfRecords |
integer (int32) | Optional | — |
PageSize |
integer (int32) | Optional | — |
PaymentLinkModel¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Active |
boolean | Optional | — |
AllowRecurringPayment |
boolean | Optional | — |
AllowedPaymentSchedule |
string — OnlySingle, OnlyRecurringOrInstallment, SingleAndRecurringOrInstallment, SingleAndRecurringOnly, SingleAndInstallmentOnly, OnlyRecurring, OnlyInstallment |
Optional | — |
Amount |
string | Optional | Positive amount represented as an en-US currency string (for example, "10.00"). Omit or send an empty value to create an open-amount link. When present, AddPaymentLink creates a fixed-amount link. |
CreatedOn |
string (date-time) | Optional | — |
Description |
string | Optional | — |
DisabledOn |
string (date-time) | Optional | — |
EndDate |
string (date-time) | Optional | — |
ForcedPaymentMethod |
string — Credit, Check, ATHMobile, GooglePay, ApplePay, Debit |
Optional | — |
FrequencyId |
integer (int32) | Optional | — |
Id |
string | Optional | Payment Link UUID represented as a string. It is generated by AddPaymentLink and is required by EditPaymentLink and DisablePaymentLink. |
InstallmentTotal |
integer (int32) | Optional | — |
InvoiceNumber |
string | Optional | — |
IsOpenPaymentSchedule |
boolean | Optional | — |
Link |
string | Optional | Generated checkout URL returned by the API. The response property is Link, not Url. |
MerchantId |
integer (int32) | Optional | Merchant identifier returned with the Payment Link. Request authorization and ownership use the top-level mid. |
PaidOn |
string (date-time) | Optional | — |
PaymentSchedule |
string — Single, Recurring, Installment |
Optional | — |
RecurringDescription |
string | Optional | — |
ServiceReferenceNumber |
string | Optional | — |
StartDate |
string (date-time) | Optional | — |
Status |
string — UnPaid, Paid |
Optional | — |
Type |
string — Open, Fixed |
Optional | Payment Link type. AddPaymentLink derives this value from Amount: Open when Amount is empty, Fixed otherwise. An input Type value does not override that derivation. |
PaymentLinkRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
PaymentLink |
PaymentLinkModel | Required | Payment Link data. The request body is nested under this PaymentLink property. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
PaymentLinkResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
PaymentLinksResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
PaymentPlan¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Description |
string | Optional | — |
DisplayName |
boolean | Optional | — |
MonthlyFee |
number (double) | Optional | — |
NonSwipeDiscount |
number (double) | Optional | — |
NonSwipeTransactionFee |
number (double) | Optional | — |
PlanId |
integer (int32) | Optional | — |
PlanName |
string | Optional | — |
SwipeDiscount |
number (double) | Optional | — |
SwipeTransactionFee |
number (double) | Optional | — |
ProcessPreauthRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Account |
string | Optional | Credit card number |
Amount |
number (double) | Required | Preauthorization amount |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CurrencyCode |
string | Optional | — |
IpAddress |
string | Optional | The client's IP address. |
IsClosable |
boolean | Required | Must be �True� to be able to close the preauthorization request. |
IsTest |
boolean | Optional | True if is a test sale |
NameOnCard |
string | Optional | Cardholder name as it appears on the credit card |
Password |
string | Required | Password of the client on the host. |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | The condition in which the payment was captured |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | Optional Purchase Card Level 2 data persisted with the preauthorization. |
SecureData |
string | Optional | The 3D secure data present once the 3D secure flow has been triggered for the transaction |
SecureTransactionId |
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 | The source of the request |
Street |
string | Optional | Cardholder street address |
TrackData |
string | Optional | — |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
comments |
string | Optional | Comments |
cv |
string | Optional | Card Verification |
expDate |
string | Optional | Credit card expiration date (MMYY) |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
zipCode |
string | Optional | Cardholder zip code |
ProcessPreauthWithTokenRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Account |
string | Optional | Credit card number |
Amount |
number (double) | Required | Preauthorization amount |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CurrencyCode |
string | Optional | — |
IpAddress |
string | Optional | The client's IP address. |
IsClosable |
boolean | Required | Must be �True� to be able to close the preauthorization request. |
IsTest |
boolean | Optional | True if is a test sale |
NameOnCard |
string | Optional | Cardholder name as it appears on the credit card |
Password |
string | Required | Password of the client on the host. |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | The condition in which the payment was captured |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | Optional Purchase Card Level 2 data persisted with the preauthorization. |
SecureData |
string | Optional | The 3D secure data present once the 3D secure flow has been triggered for the transaction |
SecureTransactionId |
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 | The source of the request |
Street |
string | Optional | Cardholder street address |
Token |
string | Optional | Token. |
TrackData |
string | Optional | — |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
comments |
string | Optional | Comments |
cv |
string | Optional | Card Verification |
expDate |
string | Optional | Credit card expiration date (MMYY) |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
zipCode |
string | Optional | Cardholder zip code |
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 | — |
GROUPID |
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 | — |
PurchaseCardLevel2Data¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CommercialCardType |
string | Optional | — |
DestinationCountryCode |
string | Optional | — |
DestinationPostalCode |
string | Optional | — |
DestinationStateCode |
string | Optional | — |
DiscountAmount |
string | Optional | — |
DutyAmount |
string | Optional | — |
FreightAmount |
string | Optional | — |
MerchantReferenceNumber |
string | Optional | — |
MerchantTaxId |
string | Optional | — |
MerchantType |
string | Optional | — |
OrderNumber |
string | Optional | — |
ProductDescription |
string | Optional | — |
PurchaseIdentifier |
string | Optional | — |
RequesterAddress |
string | Optional | — |
RequesterName |
string | Optional | — |
ShipFromPostalCode |
string | Optional | — |
TaxAmount |
string | Optional | — |
TaxIndicator |
string | Optional | — |
VatTaxAmount |
string | Optional | — |
VatTaxRate |
string | Optional | — |
RecurringBillingDeactivateRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
BillingId |
integer (int32) | Optional | Billing Identifier. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
RecurringBillingDeactivateResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
RecurringBillingEditRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Optional | — |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
Description |
string | Optional | — |
FrequencyId |
integer (int32) | Optional | — |
Id |
integer (int32) | Optional | — |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
NextPaymentDate |
string (date-time) | Optional | — |
Password |
string | Required | Password of the client on the host. |
RecurringEnd |
string (date-time) | Optional | — |
RecurringStart |
string (date-time) | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
RecurringBillingEditResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
RecurringBillingGetAllResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Billings |
array of BillingInfoDisplayable | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
RecurringBillingGetRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
BillingId |
integer (int32) | Optional | Billings Identifier. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
RecurringBillingGetResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Billing |
BillingInfoDisplayable | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
RecurringBillingRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Account |
string | Optional | — |
Amount |
number (double) | Required | — |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CardDifferencePercent |
number (double) | Optional | — |
CardHolderName |
string | Optional | — |
CardTokenId |
integer (int32) | Optional | — |
City |
string | Optional | — |
CustomerId |
string | Optional | — |
CustomerZipCode |
string | Optional | — |
Cv |
string | Optional | — |
Description |
string | Optional | — |
Email |
string | Optional | — |
EndDate |
string (date-time) | Optional | — |
ExpDate |
string | Optional | — |
FirstName |
string | Optional | — |
FrequencyId |
integer (int32) | Required | — |
InstallmentTotal |
integer (int32) | Required | — |
IpAddress |
string | Optional | The client's IP address. |
IsInstallment |
boolean | Required | — |
IsTest |
boolean | Optional | True if is a test sale |
LastName |
string | Optional | — |
MerchantId |
integer (int32) | Optional | — |
Password |
string | Required | Password of the client on the host. |
Phone |
string | Optional | — |
SecureData |
string | Optional | — |
SecureTransactionId |
string | Optional | — |
SelectedCustomerId |
integer (int32) | Optional | — |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
StartDate |
string (date-time) | Required | — |
State |
string | Optional | — |
Street |
string | Optional | — |
SurchargePercent |
number (double) | Optional | — |
TaxPercent |
number (double) | Optional | — |
TransactionId |
string | Optional | — |
UserName |
string | Required | User credential of the client on the host. |
ZipCode |
string | Optional | — |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
RecurringBillingResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
RefundRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Account |
string | Optional | Card number. Optional if using swipe method. Otherwise required. |
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. The API refunds this exact amount and does not automatically prorate a surcharge into a separate refund component. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
ExpDate |
string | Optional | Card expiration date (MMYY). |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
SURI |
string | Optional | SURI number |
ServiceTransactionNumber |
string | Required | The transaction identifier provided by the Blackstone system at the time of the original transaction. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
TrackData |
string | Optional | Card track data. Optional if using the No Swipe method. |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for referencepurposes only; must be unique. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
ReportRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
EndDate |
string (date-time) | Optional | End Date to search. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
StartDate |
string (date-time) | Optional | Start Date to search. |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
Request¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
Response¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
Retrieval¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CardNumber |
string | Optional | — |
CardType |
string | Optional | — |
CardTypeDescription |
string | Optional | — |
DateReceived |
string (date-time) | Optional | — |
DueDate |
string (date-time) | Optional | — |
ReasonCode |
string | Optional | — |
ReasonCodeDescription |
string | Optional | — |
ReferenceNumber |
string | Optional | — |
ReportDate |
string (date-time) | Optional | — |
RequestType |
string | Optional | — |
TransactionAmount |
number (double) | Optional | — |
TransactionDate |
string (date-time) | Optional | — |
ReversalRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The user transaction number that was sent by the client at the time of the transaction. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
SaleDebitRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | Transaction amount as a JSON number. Quoted numeric strings are not part of the public contract. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CVN |
string | Optional | Credit card verification number (security code). Not required if credit card is swiped. |
CardDifferenceAmount |
number (double) | Optional | The amount dedicated to the card difference (this is an optional charge passed on to the user) |
CardNumber |
string | Optional | Credit card number. Not required if credit card isswiped. |
CashBackAmount |
number (double) | Optional | Cash back amount. |
CurrencyCode |
string | Optional | The Code of the currency to process the transaction. By default, USD dollar is used. |
CustomerAddress |
string | Optional | Optional address for the customer |
CustomerCity |
string | Optional | Optional city for the customer |
CustomerCountry |
string | Optional | Optional country for the customer |
CustomerEmail |
string | Optional | The email for the customer in the e-commerce transaction (optional) |
CustomerId |
integer (int32) | Optional | The merchant customer ID as a JSON integer. Quoted strings are not part of the public contract. |
CustomerPhone |
string | Optional | The phone number for the customer in the e-commerce transaction (optional) |
CustomerState |
string | Optional | Optional state for the customer |
DigWltProgType |
string | Optional | — |
DigWltToken |
string | Optional | — |
EmvData |
string | Optional | Contactless data. |
ExpDate |
string | Optional | Credit card expiration date. SaleWithToken accepts MMYY or MM/YY; other sale flows require MMYY. Not required if credit card is swiped. Rapid Connect token sales use the valid stored token expiration when available and otherwise require this field. |
ForceDuplication |
boolean | Optional | Indicates whether the payment should be executed even if a recent payment exists with the same signature. |
InvoiceNumber |
string | Optional | Optional invoice number associated with the transaction. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
KSN |
string | Optional | Pin pad data. |
NameOnCard |
string | Optional | Cardholder Name. Not required if credit card is swiped. |
OrderReference |
string | Optional | Optional reference for the order in case it applies |
Password |
string | Required | Password of the client on the host. |
PaymentLinkId |
string | Optional | Optional Payment Link identifier when the transaction is paid from a payment link. |
PinBlock |
string | Optional | Pin pad block. |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | The condition in which the payment was captured |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | The entry mode in which the payment was captured |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | Optional Purchase Card Level 2 data sent to Rapid Connect for commercial card processing. |
SURI |
string | Optional | SURI number |
SaveCustomer |
boolean | Optional | This optional parameter indicates if the merchant wants to save the customer |
SaveToken |
boolean | Optional | Indicates to return a token for the card in case the transaction was successful |
SecureData |
string | Optional | The 3D secure data present once the 3D secure flow has been triggered for the transaction |
SecureTransactionId |
string | Optional | ID of the secure transaction |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
Street |
string | Optional | Cardholder�s billing street. Not required if credit card is swiped. |
SurchargeAmount |
number (double) | Optional | Optional surcharge amount as a JSON number. Direct API callers calculate and supply this value; the API does not derive it from the merchant's configured surcharge percentage. |
TaxAmount |
number (double) | Optional | The amount dedicated to the tax (this is an optional charge configurable by the merchant) |
TipAmount |
number (double) | Optional | The amount dedicated to the tip (this is an optional charge for the client with a default value configurable by the merchant) |
Track2 |
string | Optional | Credit card track data. Not required if using the No Swipe method. |
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 | |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
ZipCode |
string | Optional | Cardholder�s zip code. Not required if credit card is swiped. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
SaleRecurringRequest¶
Model of recurring sales
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | Transaction amount as a JSON number. Quoted numeric strings are not part of the public contract. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CVN |
string | Optional | Credit card verification number (security code). Not required if credit card is swiped. |
CardDifferenceAmount |
number (double) | Optional | The amount dedicated to the card difference (this is an optional charge passed on to the user) |
CardNumber |
string | Optional | Credit card number. Not required if credit card isswiped. |
Comments |
string | Optional | Transaction comments |
CurrencyCode |
string | Optional | The Code of the currency to process the transaction. By default, USD dollar is used. |
CustomerAddress |
string | Optional | Optional address for the customer |
CustomerCity |
string | Optional | Optional city for the customer |
CustomerCountry |
string | Optional | Optional country for the customer |
CustomerEmail |
string | Optional | The email for the customer in the e-commerce transaction (optional) |
CustomerId |
integer (int32) | Optional | The merchant customer ID as a JSON integer. Quoted strings are not part of the public contract. |
CustomerPhone |
string | Optional | The phone number for the customer in the e-commerce transaction (optional) |
CustomerState |
string | Optional | Optional state for the customer |
DigWltProgType |
string | Optional | — |
DigWltToken |
string | Optional | — |
EmvData |
string | Optional | Contactless data. |
ExpDate |
string | Optional | Credit card expiration date. SaleWithToken accepts MMYY or MM/YY; other sale flows require MMYY. Not required if credit card is swiped. Rapid Connect token sales use the valid stored token expiration when available and otherwise require this field. |
ForceDuplication |
boolean | Optional | Indicates whether the payment should be executed even if a recent payment exists with the same signature. |
Frecuency |
string — Daily, Weekly, Biweekl, Monthly, Quarterly, Biannually, Annually, Unscheduled |
Optional | Frecuency of recurring |
InvoiceNumber |
string | Optional | Optional invoice number associated with the transaction. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
NameOnCard |
string | Optional | Cardholder Name. Not required if credit card is swiped. |
OrderReference |
string | Optional | Optional reference for the order in case it applies |
Password |
string | Required | Password of the client on the host. |
PaymentLinkId |
string | Optional | Optional Payment Link identifier when the transaction is paid from a payment link. |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | The condition in which the payment was captured |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | The entry mode in which the payment was captured |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | Optional Purchase Card Level 2 data sent to Rapid Connect for commercial card processing. |
SURI |
string | Optional | SURI number |
SaveCustomer |
boolean | Optional | This optional parameter indicates if the merchant wants to save the customer |
SaveToken |
boolean | Optional | Indicates to return a token for the card in case the transaction was successful |
SecureData |
string | Optional | The 3D secure data present once the 3D secure flow has been triggered for the transaction |
SecureTransactionId |
string | Optional | ID of the secure transaction |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
Street |
string | Optional | Cardholder�s billing street. Not required if credit card is swiped. |
SurchargeAmount |
number (double) | Optional | Optional surcharge amount as a JSON number. Direct API callers calculate and supply this value; the API does not derive it from the merchant's configured surcharge percentage. |
TaxAmount |
number (double) | Optional | The amount dedicated to the tax (this is an optional charge configurable by the merchant) |
TipAmount |
number (double) | Optional | The amount dedicated to the tip (this is an optional charge for the client with a default value configurable by the merchant) |
Token |
string | Optional | The Token which identifies the credit card information. |
Track2 |
string | Optional | Credit card track data. Not required if using the No Swipe method. |
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 | |
Type |
string — Registration, Subsequent |
Optional | Type of recurring |
UniqueId |
string | Optional | Unique id of recurring |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
ZipCode |
string | Optional | Cardholder�s zip code. Not required if credit card is swiped. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
SaleReportResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
Transactions |
array of Transaction | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
SaleRequest¶
Required data to process a sale
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | Transaction amount as a JSON number. Quoted numeric strings are not part of the public contract. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CVN |
string | Optional | Credit card verification number (security code). Not required if credit card is swiped. |
CardDifferenceAmount |
number (double) | Optional | The amount dedicated to the card difference (this is an optional charge passed on to the user) |
CardNumber |
string | Optional | Credit card number. Not required if credit card isswiped. |
CurrencyCode |
string | Optional | The Code of the currency to process the transaction. By default, USD dollar is used. |
CustomerAddress |
string | Optional | Optional address for the customer |
CustomerCity |
string | Optional | Optional city for the customer |
CustomerCountry |
string | Optional | Optional country for the customer |
CustomerEmail |
string | Optional | The email for the customer in the e-commerce transaction (optional) |
CustomerId |
integer (int32) | Optional | The merchant customer ID as a JSON integer. Quoted strings are not part of the public contract. |
CustomerPhone |
string | Optional | The phone number for the customer in the e-commerce transaction (optional) |
CustomerState |
string | Optional | Optional state for the customer |
DigWltProgType |
string | Optional | — |
DigWltToken |
string | Optional | — |
EmvData |
string | Optional | Contactless data. |
ExpDate |
string | Optional | Credit card expiration date. SaleWithToken accepts MMYY or MM/YY; other sale flows require MMYY. Not required if credit card is swiped. Rapid Connect token sales use the valid stored token expiration when available and otherwise require this field. |
ForceDuplication |
boolean | Optional | Indicates whether the payment should be executed even if a recent payment exists with the same signature. |
InvoiceNumber |
string | Optional | Optional invoice number associated with the transaction. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
NameOnCard |
string | Optional | Cardholder Name. Not required if credit card is swiped. |
OrderReference |
string | Optional | Optional reference for the order in case it applies |
Password |
string | Required | Password of the client on the host. |
PaymentLinkId |
string | Optional | Optional Payment Link identifier when the transaction is paid from a payment link. |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | The condition in which the payment was captured |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | The entry mode in which the payment was captured |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | Optional Purchase Card Level 2 data sent to Rapid Connect for commercial card processing. |
SURI |
string | Optional | SURI number |
SaveCustomer |
boolean | Optional | This optional parameter indicates if the merchant wants to save the customer |
SaveToken |
boolean | Optional | Indicates to return a token for the card in case the transaction was successful |
SecureData |
string | Optional | The 3D secure data present once the 3D secure flow has been triggered for the transaction |
SecureTransactionId |
string | Optional | ID of the secure transaction |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
Street |
string | Optional | Cardholder�s billing street. Not required if credit card is swiped. |
SurchargeAmount |
number (double) | Optional | Optional surcharge amount as a JSON number. Direct API callers calculate and supply this value; the API does not derive it from the merchant's configured surcharge percentage. |
TaxAmount |
number (double) | Optional | The amount dedicated to the tax (this is an optional charge configurable by the merchant) |
TipAmount |
number (double) | Optional | The amount dedicated to the tip (this is an optional charge for the client with a default value configurable by the merchant) |
Track2 |
string | Optional | Credit card track data. Not required if using the No Swipe method. |
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 | |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
ZipCode |
string | Optional | Cardholder�s zip code. Not required if credit card is swiped. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
SaleResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Optional | Recorded base transaction amount; null when no transaction amounts are available. |
AppliedSurchargeAmount |
number (double) | Optional | Surcharge amount that was actually applied after server-side rules, including debit-card BIN detection. |
AuthorizationNumber |
string | Optional | Bank�s authorization number. Null if transaction was not successful. |
Balance |
string | Optional | Balance - Original transaction amount minus refund(s). |
CardDifferenceAmount |
number (double) | Optional | Recorded CardDifferenceAmount component; null when not recorded. |
CardType |
string | Optional | Credit Card Type |
CustomerId |
integer (int32) | Optional | — |
EmvData |
string | Optional | — |
LastFour |
string | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
PaymentPlanInfo |
PaymentPlan | Optional | Reference to the merchant plan being used and the related rates. |
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. |
ServiceReferenceNumber |
string | Optional | Transaction identifier |
SurchargeAmount |
number (double) | Optional | Recorded SurchargeAmount component; null when not recorded. |
TaxAmount |
number (double) | Optional | Recorded TaxAmount component; null when not recorded. |
TipAmount |
number (double) | Optional | Recorded TipAmount component; null when not recorded. |
Token |
string | Optional | — |
TotalAmount |
number (double) | Optional | Recorded total: Amount + TaxAmount + SurchargeAmount + CardDifferenceAmount + TipAmount; excludes CashbackAmount. Not confirmation of capture or settlement. |
avs |
string | Optional | Street verification message |
cv |
string | Optional | CV verification message |
displayMessage |
string | Optional | Transaction processing user-friendly message |
msoft_code |
string | Optional | Processor response message |
phard_code |
string | Optional | Bank response message |
verbiage |
string | Optional | Transaction processing informational message |
SaleWithTokenRequest¶
Required data to process a token sale. TransactionType must be 2 (CREDIT_WITH_TOKEN). Amount and SurchargeAmount are inherited from SaleRequest and are JSON numbers. ExpDate accepts MMYY or MM/YY. Rapid Connect prefers a valid expiration stored with the token; the request value is used only when stored expiration data is unavailable or invalid.
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Required | Transaction amount as a JSON number. Quoted numeric strings are not part of the public contract. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CVN |
string | Optional | Credit card verification number (security code). Not required if credit card is swiped. |
CardDifferenceAmount |
number (double) | Optional | The amount dedicated to the card difference (this is an optional charge passed on to the user) |
CardNumber |
string | Optional | Credit card number. Not required if credit card isswiped. |
Comments |
string | Optional | Transaction comments |
CurrencyCode |
string | Optional | The Code of the currency to process the transaction. By default, USD dollar is used. |
CustomerAddress |
string | Optional | Optional address for the customer |
CustomerCity |
string | Optional | Optional city for the customer |
CustomerCountry |
string | Optional | Optional country for the customer |
CustomerEmail |
string | Optional | The email for the customer in the e-commerce transaction (optional) |
CustomerId |
integer (int32) | Optional | The merchant customer ID as a JSON integer. Quoted strings are not part of the public contract. |
CustomerPhone |
string | Optional | The phone number for the customer in the e-commerce transaction (optional) |
CustomerState |
string | Optional | Optional state for the customer |
DigWltProgType |
string | Optional | — |
DigWltToken |
string | Optional | — |
EmvData |
string | Optional | Contactless data. |
ExpDate |
string | Optional | Credit card expiration date. SaleWithToken accepts MMYY or MM/YY; other sale flows require MMYY. Not required if credit card is swiped. Rapid Connect token sales use the valid stored token expiration when available and otherwise require this field. |
ForceDuplication |
boolean | Optional | Indicates whether the payment should be executed even if a recent payment exists with the same signature. |
InvoiceNumber |
string | Optional | Optional invoice number associated with the transaction. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
NameOnCard |
string | Optional | Cardholder Name. Not required if credit card is swiped. |
OrderReference |
string | Optional | Optional reference for the order in case it applies |
Password |
string | Required | Password of the client on the host. |
PaymentLinkId |
string | Optional | Optional Payment Link identifier when the transaction is paid from a payment link. |
PosCode |
string — ECommerce, Moto, RecurringBilling, Retail |
Optional | The condition in which the payment was captured |
PosEntryMode |
string — KeyEntered, AmexContactless, CredentialOnFile, Contactless, Swiped, AmexDigitalWallet, Chip, ChipFallbackSwipe, ChipFallbackManual |
Optional | The entry mode in which the payment was captured |
PurchaseCardLevel2 |
PurchaseCardLevel2Data | Optional | Optional Purchase Card Level 2 data sent to Rapid Connect for commercial card processing. |
SURI |
string | Optional | SURI number |
SaveCustomer |
boolean | Optional | This optional parameter indicates if the merchant wants to save the customer |
SaveToken |
boolean | Optional | Indicates to return a token for the card in case the transaction was successful |
SecureData |
string | Optional | The 3D secure data present once the 3D secure flow has been triggered for the transaction |
SecureTransactionId |
string | Optional | ID of the secure transaction |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
Street |
string | Optional | Cardholder�s billing street. Not required if credit card is swiped. |
SurchargeAmount |
number (double) | Optional | Optional surcharge amount as a JSON number. Direct API callers calculate and supply this value; the API does not derive it from the merchant's configured surcharge percentage. |
TaxAmount |
number (double) | Optional | The amount dedicated to the tax (this is an optional charge configurable by the merchant) |
TipAmount |
number (double) | Optional | The amount dedicated to the tip (this is an optional charge for the client with a default value configurable by the merchant) |
Token |
string | Optional | The Token which identifies the credit card information. |
Track2 |
string | Optional | Credit card track data. Not required if using the No Swipe method. |
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 | |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
ZipCode |
string | Optional | Cardholder�s zip code. Not required if credit card is swiped. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
SettlementBatch¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AuthCode |
string | Optional | — |
ID |
string | Optional | — |
Items |
array of SettlementItem | Optional | — |
Verbiage |
string | Optional | — |
SettlementItem¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Optional | — |
BatchNumber |
string | Optional | — |
Date |
string (date-time) | Optional | — |
ServiceReferenceNumber |
string | Optional | — |
Settled |
boolean | Optional | — |
UserTransactionNumber |
string | Optional | — |
SettlementReport¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AmountSettled |
number (double) | Optional | — |
Batches |
array of BatchReport | Optional | — |
CompletedOn |
string (date-time) | Optional | — |
SettlementReportResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
SettlementReports |
array of SettlementReport | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
SettlementRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
SettlementResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AmountSettled |
number (double) | Optional | — |
Batches |
array of SettlementBatch | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
SettlementTransaction¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Optional | — |
AuthorizationCode |
string | Optional | — |
BatchNumber |
string | Optional | — |
CardDifferenceAmount |
number (double) | Optional | Recorded CardDifferenceAmount component; null when not recorded. |
CardType |
string | Optional | — |
CardWasSwiped |
boolean | Optional | — |
CashierId |
integer (int32) | Optional | — |
CompletedOn |
string (date-time) | Optional | — |
Date |
string (date-time) | Optional | — |
MsoftCode |
string | Optional | — |
PhardCode |
string | Optional | — |
Refunded |
boolean | Optional | — |
RefundedAmount |
number (double) | Optional | Remaining amount available to refund, not the cumulative amount already refunded. |
RefundedOn |
string (date-time) | Optional | — |
RemainingRefundableAmount |
number (double) | Optional | Amount that can still be refunded. Legacy RefundedAmount stores this balance after a refund and can be null before one. |
SaleType |
string — CASH, CREDIT, DEBIT, NONE |
Optional | — |
ServiceReferenceNumber |
string | Optional | — |
Settled |
boolean | Optional | — |
SurchargeAmount |
number (double) | Optional | Recorded SurchargeAmount component; null when not recorded. |
TaxAmount |
number (double) | Optional | Recorded TaxAmount component; null when not recorded. |
TipAmount |
number (double) | Optional | Recorded TipAmount component; null when not recorded. |
TotalAmount |
number (double) | Optional | Recorded total: Amount + TaxAmount + SurchargeAmount + CardDifferenceAmount + TipAmount; excludes CashbackAmount. Not confirmation of capture or settlement. |
TotalRefundedAmount |
number (double) | Optional | Cumulative amount already refunded from the original refundable transaction total. |
TransactionCompletitionStatus |
string — COMPLETED, OPEN |
Optional | — |
TransactionStatus |
string — SUCCESS, PENDING, DECLINE, PREAUTH_FINAL_NO_PROCESSED |
Optional | — |
UserTransactionNumber |
string | Optional | — |
Verbiage |
string | Optional | — |
Voided |
boolean | Optional | — |
VoidedOn |
string (date-time) | Optional | — |
SignatureCaptureAddRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
ServiceTransactionNumber |
string | Optional | Service Transaction Number. |
SignatureData |
string | Optional | Signature Data. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
SignatureCaptureGetRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
ServiceTransactionNumber |
string | Optional | Service Transaction Number. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
Statement¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MerchantNumber |
string | Optional | — |
StatementData |
string | Optional | — |
StatementId |
string | Optional | — |
StatementListItemWithZones¶
| Field | Type | Requirement | Description |
|---|---|---|---|
MerchantNumber |
string | Optional | — |
StatementDate |
string | Optional | — |
StatementId |
string | Optional | — |
Zones |
array of string | Optional | — |
StoredAccount¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ABARoute |
string | Optional | — |
Account |
string | Optional | — |
Active |
string | Optional | — |
Amount |
string | Optional | — |
BeginDate |
string | Optional | — |
CardHolderName |
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 | — |
ClientRef |
string | Optional | — |
Description |
string | Optional | — |
EndDate |
string | Optional | — |
ExpirationDate |
string | Optional | — |
Frequency |
string | Optional | — |
InstallementNum |
string | Optional | — |
InstallmentTotal |
string | Optional | — |
LastRunDate |
string | Optional | — |
LastRunId |
string | Optional | — |
LastSuccessDate |
string | Optional | — |
NextRunAmount |
string | Optional | — |
NextRunDate |
string | Optional | — |
Street |
string | Optional | — |
Token |
string | Optional | — |
Type |
string | Optional | — |
Zip |
string | Optional | — |
SummaryRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
CurrentPageIndex |
integer (int32) | Optional | — |
FromDate |
string | Optional | — |
HierarchyFilterMode |
integer (int32) | Optional | — |
HierarchyFilterValue |
string | Optional | — |
PageSize |
integer (int32) | Optional | — |
ToDate |
string | Optional | — |
ViewLevel |
integer (int32) | Optional | — |
SupportedCurrenciesRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CurrencyCode |
string | Optional | — |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
SupportedCurrenciesResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
SupportedCurrencies |
array of Currency | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
TokenThreeDSModel¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ApiKey |
string | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
Token |
string | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
TokensRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
Identifier |
string | Optional | Opaque identifier returned by GetTokenForCard for a stored token record. This value is not an email address, contact value, or token value. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
TokensResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
OperationCode |
string | Optional | OPERATION_NOT_SUPPORTED for an unsupported vault lookup; null for legacy outcomes. |
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. |
Supported |
boolean | Optional | False only when the processor explicitly reports that vault lookup is unsupported; null otherwise. |
Tokens |
array of StoredAccount | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
Transaction¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Amount |
number (double) | Optional | — |
AuthCode |
string | Optional | — |
BankAuthorizationNumber |
string | Optional | — |
BankMsg |
string | Optional | — |
CID |
integer (int32) | Optional | — |
CV_VerificationResult |
string | Optional | — |
CardDifferenceAmount |
number (double) | Optional | Recorded CardDifferenceAmount component; null when not recorded. |
CardType |
string | Optional | — |
CardWasSwiped |
integer (int32) | Optional | — |
CurrencyCode |
string | Optional | — |
ID |
integer (int32) | Optional | — |
LastFour |
string | Optional | — |
MID |
integer (int32) | Optional | — |
MadeOn |
string (date-time) | Optional | — |
MonetraMsg |
string | Optional | — |
PlanId |
integer (int32) | Optional | — |
RefundedAmount |
number (double) | Optional | Remaining amount available to refund. Despite the legacy property name, this is not the cumulative amount already refunded; it reaches zero after a full refund. |
RefundedOn |
string (date-time) | Optional | — |
RemainingRefundableAmount |
number (double) | Optional | Amount that can still be refunded. This is the unambiguous replacement for the legacy RefundedAmount property, which stores the remaining balance after a refund and can be null before one. |
SaleType |
integer (int32) | Optional | — |
ServiceTransactionNumber |
string | Optional | — |
StreetVerificationResult |
string | Optional | — |
SurchargeAmount |
number (double) | Optional | Recorded SurchargeAmount component; null when not recorded. |
TaxAmount |
number (double) | Optional | Recorded TaxAmount component; null when not recorded. |
TipAmount |
number (double) | Optional | Recorded TipAmount component; null when not recorded. |
Token |
string | Optional | — |
TotalAmount |
number (double) | Optional | Recorded total: Amount + TaxAmount + SurchargeAmount + CardDifferenceAmount + TipAmount; excludes CashbackAmount. Not confirmation of capture or settlement. |
TotalRefundedAmount |
number (double) | Optional | Cumulative amount already refunded from the original refundable transaction total. |
TransactionRefunded |
integer (int32) | Optional | — |
TransactionVoided |
integer (int32) | Optional | — |
UserId |
integer (int32) | Optional | — |
UserTransactionNumber |
string | Optional | — |
VoidedOn |
string (date-time) | Optional | — |
verbiage |
string | Optional | — |
UnsettledTransaction¶
| Field | Type | Requirement | Description |
|---|---|---|---|
ServiceReferenceNumber |
string | Optional | — |
SettlementResult |
integer (int32) | Optional | — |
TimeSpan |
string (date-time) | Optional | — |
UserReferenceNumber |
string | Optional | — |
batch_number |
string | Optional | — |
cid |
integer (int32) | Optional | — |
id |
integer (int32) | Optional | — |
mid |
integer (int32) | Optional | — |
UnsettledTransactionResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
UnsettledTransactions |
array of UnsettledTransaction | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
UsedTransactionNumbers¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
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. |
UserReferenceNumbers |
array of string | Optional | — |
displayMessage |
string | Optional | Transaction processing user-friendly message |
verbiage |
string | Optional | Transaction processing informational message |
UserRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
CardTypes |
string | Optional | Card Types. |
ExtraData |
string | Optional | Extra Data. |
ExtraFielsKeys |
string | Optional | Extra Fiels Keys. |
ExtraFielsValues |
string | Optional | Extra Fiels Values. |
FraudAutodenyOptions |
string | Optional | Fraud Auto Deny Options. |
IndustryCode |
string — A, AE, AF, E, F, FE, G, GE, H, M, R, RS |
Optional | Industry Code. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
NewPass |
string | Optional | New Password. |
NewUser |
string | Optional | New User. |
Password |
string | Required | Password of the client on the host. |
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 | Processor. |
ProcessorExtraFields |
ProcessorExtraFields | Optional | Processor Extra Fields. |
ProcessorId |
integer (int32) | Optional | Processor Identifier. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
VerificationOnlyRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
Account |
string | Optional | Account Number in the Card. |
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
Cv |
string | Optional | CV verification message. |
ExpDate |
string | Optional | Expiration Date in the Card. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
Street |
string | Optional | Cardholder’s Street. |
UserName |
string | Required | User credential of the client on the host. |
Zip |
string | Optional | Cardholder’s zip code. Not required if credit card is swiped. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |
VerificationOnlyResponse¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AuthorizationNumber |
string | Optional | Bank’s authorization number. Null if transaction was not successful. |
Balance |
string | Optional | — |
CardType |
string | Optional | Credit Card Type |
LastFour |
string | Optional | — |
Msg |
array of string | Optional | Supporting message when the transaction fails. Provides contextual information based on the code received. |
PaymentPlanInfo |
PaymentPlan | 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. |
ServiceReferenceNumber |
string | Optional | Transaction identifier |
avs |
string | Optional | Street verification message |
cv |
string | Optional | CV verification message |
displayMessage |
string | Optional | Transaction processing user-friendly message |
msoft_code |
string | Optional | Processor response message |
phard_code |
string | Optional | Bank response message |
verbiage |
string | Optional | Transaction processing informational message |
VoidRequest¶
| Field | Type | Requirement | Description |
|---|---|---|---|
AppInfo |
string | Optional | Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33" |
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. |
IpAddress |
string | Optional | The client's IP address. |
IsTest |
boolean | Optional | True if is a test sale |
Password |
string | Required | Password of the client on the host. |
ServiceTransactionNumber |
string | Required | The transaction identifier used for reference purposes only; must be unique. |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional | The source of the request |
UserName |
string | Required | User credential of the client on the host. |
UserTransactionNumber |
string | Required | The transaction identifier provided by the Blackstone system at the time of the transaction. |
cid |
integer (int32) | Required | Cashier ID – A number used to identify the merchant’s subclient. |
mid |
integer (int32) | Required | Merchant ID – A number used to identify the merchant. |