Gift Card¶

Gift card sales, balances, and adjustments.

6 endpoints All API groups

Gift Card Sale¶

POST /api/GiftCard/Sale

Process a sale using a gift card.

Request body¶

Field	Type	Requirement	Description
`Amount`	number (double)	Required	Transaction amount
`ZipCode`	string	Optional	Cardholder’s zip code. Not required if credit card is swiped.
`Street`	string	Optional	—
`CVN`	string	Optional	Credit card verification number (security code). Not required if credit card is swiped.
`CardNumber`	string	Optional	Credit card number. Not required if credit card isswiped.
`ExpDate`	string	Optional	Credit card expiration date (MMYY). Not required if credit card is swiped.
`NameOnCard`	string	Optional	Cardholder Name. Not required if credit card is swiped.
`Track2`	string	Optional	Credit card track data. Not required if using the No Swipe method.
`EmvData`	string	Optional	—
`UserTransactionNumber`	string	Required	The transaction identifier used for reference purposes only; must be unique.
`TransactionType`	integer (int32)	Required	Transaction Type \| Name \| Value \| Description \| \|---\|---\|---\| \| CREDIT \| 1 \| Credit transaction \| \| CREDIT_WITH_TOKEN \| 2 \| Credit with token transaction \| \| Pre_Authorization \| 3 \| Credit preauthorization request \| \| Pre_Authorization_Completion \| 4 \| Credit preauthorization completion \| \| SaleDebit \| 5 \| Debit Card Sale transaction \| \| EBT \| 6 \| EBT Transaction \| \| GIFTCARD \| 7 \| Blackstone Gift Card transaction \|
`SURI`	string	Optional	—
`SurchargeAmount`	number (double)	Optional	—
`CardDifferenceAmount`	number (double)	Optional	—
`TaxAmount`	number (double)	Optional	—
`TipAmount`	number (double)	Optional	—
`SecureData`	string	Optional	—
`SecureTransactionId`	string	Optional	—
`SaveToken`	boolean	Optional	—
`CurrencyCode`	string	Optional	—
`SaveCustomer`	boolean	Optional	—
`CustomerId`	integer (int32)	Optional	—
`CustomerPhone`	string	Optional	—
`CustomerEmail`	string	Optional	—
`CustomerCountry`	string	Optional	—
`CustomerState`	string	Optional	—
`CustomerCity`	string	Optional	—
`CustomerAddress`	string	Optional	—
`OrderReference`	string	Optional	—
`PaymentLinkId`	string	Optional	—
`InvoiceNumber`	string	Optional	—
`PurchaseCardLevel2`	PurchaseCardLevel2Data	Optional	—
`DigWltProgType`	string	Optional	—
`DigWltToken`	string	Optional	—
`PosCode`	string — `ECommerce`, `Moto`, `RecurringBilling`, `Retail`	Optional	—
`PosEntryMode`	string — `KeyEntered`, `AmexContactless`, `CredentialOnFile`, `Contactless`, `Swiped`, `AmexDigitalWallet`, `Chip`, `ChipFallbackSwipe`, `ChipFallbackManual`	Optional	—
`ForceDuplication`	boolean	Optional	—
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/GiftCard/Sale' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "Amount": 10.0,
  "UserTransactionNumber": "unique-transaction-id",
  "TransactionType": 1,
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "Amount": 10.0,
  "UserTransactionNumber": "unique-transaction-id",
  "TransactionType": 1,
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	SaleResponse

Example response

{
  "avs": "<avs>",
  "ServiceReferenceNumber": "<service-reference-number>",
  "msoft_code": "<msoft-code>",
  "phard_code": "<phard-code>",
  "cv": "<cv>",
  "AuthorizationNumber": "<authorization-number>",
  "PaymentPlanInfo": {
    "PlanId": 1,
    "SwipeDiscount": 1.0,
    "SwipeTransactionFee": 1.0,
    "NonSwipeDiscount": 1.0,
    "NonSwipeTransactionFee": 1.0,
    "MonthlyFee": 1.0,
    "Description": "<description>",
    "PlanName": "<plan-name>",
    "DisplayName": false
  },
  "CardType": "<card-type>",
  "LastFour": "<last-four>",
  "Balance": "<balance>",
  "Token": "<token>",
  "EmvData": "<emv-data>",
  "CustomerId": 1,
  "AppliedSurchargeAmount": 10.0,
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ]
}

Gift Card Refund¶

POST /api/GiftCard/Refund

Process a gift card refund. The request will fail if the transaction was previously fully refunded.

Request body¶

Schema: RefundRequest

Field	Type	Requirement	Description
`Amount`	number (double)	Required	Amount to be refunded. The amount to be refunded can be less than the original transaction amount.Multiple refunds can be applied to the same transaction as long as the total amount of all refunds does not exceed the original transaction amount.
`ExpDate`	string	Optional	Card expiration date (MMYY).
`Account`	string	Optional	Card number. Optional if using swipe method. Otherwise required.
`TrackData`	string	Optional	Card track data. Optional if using the No Swipe method.
`UserTransactionNumber`	string	Required	The transaction identifier used for referencepurposes only; must be unique.
`ServiceTransactionNumber`	string	Required	The transaction identifier provided by the Blackstone system at the time of the original transaction.
`SURI`	string	Optional	—
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/GiftCard/Refund' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "Amount": 10.0,
  "UserTransactionNumber": "unique-transaction-id",
  "ServiceTransactionNumber": "<service-transaction-number>",
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "Amount": 10.0,
  "UserTransactionNumber": "unique-transaction-id",
  "ServiceTransactionNumber": "<service-transaction-number>",
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	SaleResponse

Example response

{
  "avs": "<avs>",
  "ServiceReferenceNumber": "<service-reference-number>",
  "msoft_code": "<msoft-code>",
  "phard_code": "<phard-code>",
  "cv": "<cv>",
  "AuthorizationNumber": "<authorization-number>",
  "PaymentPlanInfo": {
    "PlanId": 1,
    "SwipeDiscount": 1.0,
    "SwipeTransactionFee": 1.0,
    "NonSwipeDiscount": 1.0,
    "NonSwipeTransactionFee": 1.0,
    "MonthlyFee": 1.0,
    "Description": "<description>",
    "PlanName": "<plan-name>",
    "DisplayName": false
  },
  "CardType": "<card-type>",
  "LastFour": "<last-four>",
  "Balance": "<balance>",
  "Token": "<token>",
  "EmvData": "<emv-data>",
  "CustomerId": 1,
  "AppliedSurchargeAmount": 10.0,
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ]
}

Gift Card Reversal¶

POST /api/GiftCard/Reversal

Reverse a gift card transaction where the user did not receive a response from the system.

Request body¶

Schema: ReversalRequest

Field	Type	Requirement	Description
`UserTransactionNumber`	string	Required	The user transaction number that was sent by the client at the time of the transaction.
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/GiftCard/Reversal' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "UserTransactionNumber": "unique-transaction-id",
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "UserTransactionNumber": "unique-transaction-id",
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	SaleResponse

Example response

{
  "avs": "<avs>",
  "ServiceReferenceNumber": "<service-reference-number>",
  "msoft_code": "<msoft-code>",
  "phard_code": "<phard-code>",
  "cv": "<cv>",
  "AuthorizationNumber": "<authorization-number>",
  "PaymentPlanInfo": {
    "PlanId": 1,
    "SwipeDiscount": 1.0,
    "SwipeTransactionFee": 1.0,
    "NonSwipeDiscount": 1.0,
    "NonSwipeTransactionFee": 1.0,
    "MonthlyFee": 1.0,
    "Description": "<description>",
    "PlanName": "<plan-name>",
    "DisplayName": false
  },
  "CardType": "<card-type>",
  "LastFour": "<last-four>",
  "Balance": "<balance>",
  "Token": "<token>",
  "EmvData": "<emv-data>",
  "CustomerId": 1,
  "AppliedSurchargeAmount": 10.0,
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ]
}

Activate Gift Card¶

POST /api/GiftCard/Activate

Activate a gift card.

Request body¶

Schema: SaleRequest

Field	Type	Requirement	Description
`Amount`	number (double)	Required	Transaction amount
`ZipCode`	string	Optional	Cardholder’s zip code. Not required if credit card is swiped.
`Street`	string	Optional	—
`CVN`	string	Optional	Credit card verification number (security code). Not required if credit card is swiped.
`CardNumber`	string	Optional	Credit card number. Not required if credit card isswiped.
`ExpDate`	string	Optional	Credit card expiration date (MMYY). Not required if credit card is swiped.
`NameOnCard`	string	Optional	Cardholder Name. Not required if credit card is swiped.
`Track2`	string	Optional	Credit card track data. Not required if using the No Swipe method.
`EmvData`	string	Optional	—
`UserTransactionNumber`	string	Required	The transaction identifier used for reference purposes only; must be unique.
`TransactionType`	integer (int32)	Required	Transaction Type \| Name \| Value \| Description \| \|---\|---\|---\| \| CREDIT \| 1 \| Credit transaction \| \| CREDIT_WITH_TOKEN \| 2 \| Credit with token transaction \| \| Pre_Authorization \| 3 \| Credit preauthorization request \| \| Pre_Authorization_Completion \| 4 \| Credit preauthorization completion \| \| SaleDebit \| 5 \| Debit Card Sale transaction \| \| EBT \| 6 \| EBT Transaction \| \| GIFTCARD \| 7 \| Blackstone Gift Card transaction \|
`SURI`	string	Optional	—
`SurchargeAmount`	number (double)	Optional	—
`CardDifferenceAmount`	number (double)	Optional	—
`TaxAmount`	number (double)	Optional	—
`TipAmount`	number (double)	Optional	—
`SecureData`	string	Optional	—
`SecureTransactionId`	string	Optional	—
`SaveToken`	boolean	Optional	—
`CurrencyCode`	string	Optional	—
`SaveCustomer`	boolean	Optional	—
`CustomerId`	integer (int32)	Optional	—
`CustomerPhone`	string	Optional	—
`CustomerEmail`	string	Optional	—
`CustomerCountry`	string	Optional	—
`CustomerState`	string	Optional	—
`CustomerCity`	string	Optional	—
`CustomerAddress`	string	Optional	—
`OrderReference`	string	Optional	—
`PaymentLinkId`	string	Optional	—
`InvoiceNumber`	string	Optional	—
`PurchaseCardLevel2`	PurchaseCardLevel2Data	Optional	—
`DigWltProgType`	string	Optional	—
`DigWltToken`	string	Optional	—
`PosCode`	string — `ECommerce`, `Moto`, `RecurringBilling`, `Retail`	Optional	—
`PosEntryMode`	string — `KeyEntered`, `AmexContactless`, `CredentialOnFile`, `Contactless`, `Swiped`, `AmexDigitalWallet`, `Chip`, `ChipFallbackSwipe`, `ChipFallbackManual`	Optional	—
`ForceDuplication`	boolean	Optional	—
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/GiftCard/Activate' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "Amount": 10.0,
  "UserTransactionNumber": "unique-transaction-id",
  "TransactionType": 1,
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "Amount": 10.0,
  "UserTransactionNumber": "unique-transaction-id",
  "TransactionType": 1,
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	SaleResponse

Example response

{
  "avs": "<avs>",
  "ServiceReferenceNumber": "<service-reference-number>",
  "msoft_code": "<msoft-code>",
  "phard_code": "<phard-code>",
  "cv": "<cv>",
  "AuthorizationNumber": "<authorization-number>",
  "PaymentPlanInfo": {
    "PlanId": 1,
    "SwipeDiscount": 1.0,
    "SwipeTransactionFee": 1.0,
    "NonSwipeDiscount": 1.0,
    "NonSwipeTransactionFee": 1.0,
    "MonthlyFee": 1.0,
    "Description": "<description>",
    "PlanName": "<plan-name>",
    "DisplayName": false
  },
  "CardType": "<card-type>",
  "LastFour": "<last-four>",
  "Balance": "<balance>",
  "Token": "<token>",
  "EmvData": "<emv-data>",
  "CustomerId": 1,
  "AppliedSurchargeAmount": 10.0,
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ]
}

Deactivate Gift Card¶

POST /api/GiftCard/Deactivate

Deactivate a gift card.

Request body¶

Schema: SaleRequest

Field	Type	Requirement	Description
`Amount`	number (double)	Required	Transaction amount
`ZipCode`	string	Optional	Cardholder’s zip code. Not required if credit card is swiped.
`Street`	string	Optional	—
`CVN`	string	Optional	Credit card verification number (security code). Not required if credit card is swiped.
`CardNumber`	string	Optional	Credit card number. Not required if credit card isswiped.
`ExpDate`	string	Optional	Credit card expiration date (MMYY). Not required if credit card is swiped.
`NameOnCard`	string	Optional	Cardholder Name. Not required if credit card is swiped.
`Track2`	string	Optional	Credit card track data. Not required if using the No Swipe method.
`EmvData`	string	Optional	—
`UserTransactionNumber`	string	Required	The transaction identifier used for reference purposes only; must be unique.
`TransactionType`	integer (int32)	Required	Transaction Type \| Name \| Value \| Description \| \|---\|---\|---\| \| CREDIT \| 1 \| Credit transaction \| \| CREDIT_WITH_TOKEN \| 2 \| Credit with token transaction \| \| Pre_Authorization \| 3 \| Credit preauthorization request \| \| Pre_Authorization_Completion \| 4 \| Credit preauthorization completion \| \| SaleDebit \| 5 \| Debit Card Sale transaction \| \| EBT \| 6 \| EBT Transaction \| \| GIFTCARD \| 7 \| Blackstone Gift Card transaction \|
`SURI`	string	Optional	—
`SurchargeAmount`	number (double)	Optional	—
`CardDifferenceAmount`	number (double)	Optional	—
`TaxAmount`	number (double)	Optional	—
`TipAmount`	number (double)	Optional	—
`SecureData`	string	Optional	—
`SecureTransactionId`	string	Optional	—
`SaveToken`	boolean	Optional	—
`CurrencyCode`	string	Optional	—
`SaveCustomer`	boolean	Optional	—
`CustomerId`	integer (int32)	Optional	—
`CustomerPhone`	string	Optional	—
`CustomerEmail`	string	Optional	—
`CustomerCountry`	string	Optional	—
`CustomerState`	string	Optional	—
`CustomerCity`	string	Optional	—
`CustomerAddress`	string	Optional	—
`OrderReference`	string	Optional	—
`PaymentLinkId`	string	Optional	—
`InvoiceNumber`	string	Optional	—
`PurchaseCardLevel2`	PurchaseCardLevel2Data	Optional	—
`DigWltProgType`	string	Optional	—
`DigWltToken`	string	Optional	—
`PosCode`	string — `ECommerce`, `Moto`, `RecurringBilling`, `Retail`	Optional	—
`PosEntryMode`	string — `KeyEntered`, `AmexContactless`, `CredentialOnFile`, `Contactless`, `Swiped`, `AmexDigitalWallet`, `Chip`, `ChipFallbackSwipe`, `ChipFallbackManual`	Optional	—
`ForceDuplication`	boolean	Optional	—
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/GiftCard/Deactivate' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "Amount": 10.0,
  "UserTransactionNumber": "unique-transaction-id",
  "TransactionType": 1,
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "Amount": 10.0,
  "UserTransactionNumber": "unique-transaction-id",
  "TransactionType": 1,
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	SaleResponse

Example response

{
  "avs": "<avs>",
  "ServiceReferenceNumber": "<service-reference-number>",
  "msoft_code": "<msoft-code>",
  "phard_code": "<phard-code>",
  "cv": "<cv>",
  "AuthorizationNumber": "<authorization-number>",
  "PaymentPlanInfo": {
    "PlanId": 1,
    "SwipeDiscount": 1.0,
    "SwipeTransactionFee": 1.0,
    "NonSwipeDiscount": 1.0,
    "NonSwipeTransactionFee": 1.0,
    "MonthlyFee": 1.0,
    "Description": "<description>",
    "PlanName": "<plan-name>",
    "DisplayName": false
  },
  "CardType": "<card-type>",
  "LastFour": "<last-four>",
  "Balance": "<balance>",
  "Token": "<token>",
  "EmvData": "<emv-data>",
  "CustomerId": 1,
  "AppliedSurchargeAmount": 10.0,
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ]
}

Get Gift Card Balance¶

POST /api/GiftCard/GetBalance

Get the balance on a gift card.

Request body¶

Schema: SaleRequest

Field	Type	Requirement	Description
`Amount`	number (double)	Required	Transaction amount
`ZipCode`	string	Optional	Cardholder’s zip code. Not required if credit card is swiped.
`Street`	string	Optional	—
`CVN`	string	Optional	Credit card verification number (security code). Not required if credit card is swiped.
`CardNumber`	string	Optional	Credit card number. Not required if credit card isswiped.
`ExpDate`	string	Optional	Credit card expiration date (MMYY). Not required if credit card is swiped.
`NameOnCard`	string	Optional	Cardholder Name. Not required if credit card is swiped.
`Track2`	string	Optional	Credit card track data. Not required if using the No Swipe method.
`EmvData`	string	Optional	—
`UserTransactionNumber`	string	Required	The transaction identifier used for reference purposes only; must be unique.
`TransactionType`	integer (int32)	Required	Transaction Type \| Name \| Value \| Description \| \|---\|---\|---\| \| CREDIT \| 1 \| Credit transaction \| \| CREDIT_WITH_TOKEN \| 2 \| Credit with token transaction \| \| Pre_Authorization \| 3 \| Credit preauthorization request \| \| Pre_Authorization_Completion \| 4 \| Credit preauthorization completion \| \| SaleDebit \| 5 \| Debit Card Sale transaction \| \| EBT \| 6 \| EBT Transaction \| \| GIFTCARD \| 7 \| Blackstone Gift Card transaction \|
`SURI`	string	Optional	—
`SurchargeAmount`	number (double)	Optional	—
`CardDifferenceAmount`	number (double)	Optional	—
`TaxAmount`	number (double)	Optional	—
`TipAmount`	number (double)	Optional	—
`SecureData`	string	Optional	—
`SecureTransactionId`	string	Optional	—
`SaveToken`	boolean	Optional	—
`CurrencyCode`	string	Optional	—
`SaveCustomer`	boolean	Optional	—
`CustomerId`	integer (int32)	Optional	—
`CustomerPhone`	string	Optional	—
`CustomerEmail`	string	Optional	—
`CustomerCountry`	string	Optional	—
`CustomerState`	string	Optional	—
`CustomerCity`	string	Optional	—
`CustomerAddress`	string	Optional	—
`OrderReference`	string	Optional	—
`PaymentLinkId`	string	Optional	—
`InvoiceNumber`	string	Optional	—
`PurchaseCardLevel2`	PurchaseCardLevel2Data	Optional	—
`DigWltProgType`	string	Optional	—
`DigWltToken`	string	Optional	—
`PosCode`	string — `ECommerce`, `Moto`, `RecurringBilling`, `Retail`	Optional	—
`PosEntryMode`	string — `KeyEntered`, `AmexContactless`, `CredentialOnFile`, `Contactless`, `Swiped`, `AmexDigitalWallet`, `Chip`, `ChipFallbackSwipe`, `ChipFallbackManual`	Optional	—
`ForceDuplication`	boolean	Optional	—
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/GiftCard/GetBalance' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "Amount": 10.0,
  "UserTransactionNumber": "unique-transaction-id",
  "TransactionType": 1,
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "Amount": 10.0,
  "UserTransactionNumber": "unique-transaction-id",
  "TransactionType": 1,
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	SaleResponse

Example response

{
  "avs": "<avs>",
  "ServiceReferenceNumber": "<service-reference-number>",
  "msoft_code": "<msoft-code>",
  "phard_code": "<phard-code>",
  "cv": "<cv>",
  "AuthorizationNumber": "<authorization-number>",
  "PaymentPlanInfo": {
    "PlanId": 1,
    "SwipeDiscount": 1.0,
    "SwipeTransactionFee": 1.0,
    "NonSwipeDiscount": 1.0,
    "NonSwipeTransactionFee": 1.0,
    "MonthlyFee": 1.0,
    "Description": "<description>",
    "PlanName": "<plan-name>",
    "DisplayName": false
  },
  "CardType": "<card-type>",
  "LastFour": "<last-four>",
  "Balance": "<balance>",
  "Token": "<token>",
  "EmvData": "<emv-data>",
  "CustomerId": 1,
  "AppliedSurchargeAmount": 10.0,
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ]
}