Payment Links
Create, manage, and inspect hosted payment links.
Get Payment Links
GET
/api/PaymentLinks/GetPaymentLinks
Parameters
| Name |
Location |
Type |
Required |
Description |
request.paymentLink.id |
query |
string |
Optional |
— |
request.paymentLink.merchantId |
query |
integer (int32) |
Optional |
— |
request.paymentLink.amount |
query |
string |
Optional |
— |
request.paymentLink.description |
query |
string |
Optional |
— |
request.paymentLink.type |
query |
string — Open, Fixed |
Optional |
— |
request.paymentLink.createdOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.paidOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.disabledOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.status |
query |
string — UnPaid, Paid |
Optional |
— |
request.paymentLink.active |
query |
boolean |
Optional |
— |
request.paymentLink.serviceReferenceNumber |
query |
string |
Optional |
— |
request.paymentLink.invoiceNumber |
query |
string |
Optional |
— |
request.paymentLink.forcedPaymentMethod |
query |
string — Credit, Check, ATHMobile, GooglePay, ApplePay, Debit |
Optional |
— |
request.paymentLink.link |
query |
string |
Optional |
— |
request.paymentLink.allowRecurringPayment |
query |
boolean |
Optional |
— |
request.paymentLink.allowedPaymentSchedule |
query |
string — OnlySingle, OnlyRecurringOrInstallment, SingleAndRecurringOrInstallment, SingleAndRecurringOnly, SingleAndInstallmentOnly, OnlyRecurring, OnlyInstallment |
Optional |
— |
request.paymentLink.paymentSchedule |
query |
string — Single, Recurring, Installment |
Optional |
— |
request.paymentLink.isOpenPaymentSchedule |
query |
boolean |
Optional |
— |
request.paymentLink.frequencyId |
query |
integer (int32) |
Optional |
— |
request.paymentLink.startDate |
query |
string (date-time) |
Optional |
— |
request.paymentLink.endDate |
query |
string (date-time) |
Optional |
— |
request.paymentLink.recurringDescription |
query |
string |
Optional |
— |
request.paymentLink.installmentTotal |
query |
integer (int32) |
Optional |
— |
request.appKey |
query |
string |
Required |
Application Key which uniquely identifies your application as provided by the Blackstone system. |
request.appType |
query |
integer (int32) |
Required |
Application Type as provided by the Blackstone system. |
request.mid |
query |
integer (int32) |
Required |
Merchant ID – A number used to identify the merchant. |
request.cid |
query |
integer (int32) |
Required |
Cashier ID – A number used to identify the merchant’s subclient. |
request.userName |
query |
string |
Required |
User credential of the client on the host. |
request.password |
query |
string |
Required |
Password of the client on the host. |
request.ipAddress |
query |
string |
Optional |
— |
request.source |
query |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional |
— |
request.appInfo |
query |
string |
Optional |
— |
request.isTest |
query |
boolean |
Optional |
— |
Responses
Example response
{
"PaymentLinks": [
{
"Id": "<id>",
"MerchantId": 1,
"Amount": "<amount>",
"Description": "<description>",
"Type": "Open",
"CreatedOn": "2026-01-31T12:00:00Z",
"PaidOn": "2026-01-31T12:00:00Z",
"DisabledOn": "2026-01-31T12:00:00Z",
"Status": "UnPaid",
"Active": false,
"ServiceReferenceNumber": "<service-reference-number>",
"InvoiceNumber": "<invoice-number>",
"ForcedPaymentMethod": "Credit",
"Link": "<link>",
"AllowRecurringPayment": false,
"AllowedPaymentSchedule": "OnlySingle"
}
],
"ResponseCode": 200,
"Msg": [
"<msg>"
],
"verbiage": "<verbiage>",
"displayMessage": "<display-message>"
}
Get Payment Link
GET
/api/PaymentLinks/GetPaymentLink
Parameters
| Name |
Location |
Type |
Required |
Description |
id |
query |
string |
Required |
— |
request.paymentLink.id |
query |
string |
Optional |
— |
request.paymentLink.merchantId |
query |
integer (int32) |
Optional |
— |
request.paymentLink.amount |
query |
string |
Optional |
— |
request.paymentLink.description |
query |
string |
Optional |
— |
request.paymentLink.type |
query |
string — Open, Fixed |
Optional |
— |
request.paymentLink.createdOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.paidOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.disabledOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.status |
query |
string — UnPaid, Paid |
Optional |
— |
request.paymentLink.active |
query |
boolean |
Optional |
— |
request.paymentLink.serviceReferenceNumber |
query |
string |
Optional |
— |
request.paymentLink.invoiceNumber |
query |
string |
Optional |
— |
request.paymentLink.forcedPaymentMethod |
query |
string — Credit, Check, ATHMobile, GooglePay, ApplePay, Debit |
Optional |
— |
request.paymentLink.link |
query |
string |
Optional |
— |
request.paymentLink.allowRecurringPayment |
query |
boolean |
Optional |
— |
request.paymentLink.allowedPaymentSchedule |
query |
string — OnlySingle, OnlyRecurringOrInstallment, SingleAndRecurringOrInstallment, SingleAndRecurringOnly, SingleAndInstallmentOnly, OnlyRecurring, OnlyInstallment |
Optional |
— |
request.paymentLink.paymentSchedule |
query |
string — Single, Recurring, Installment |
Optional |
— |
request.paymentLink.isOpenPaymentSchedule |
query |
boolean |
Optional |
— |
request.paymentLink.frequencyId |
query |
integer (int32) |
Optional |
— |
request.paymentLink.startDate |
query |
string (date-time) |
Optional |
— |
request.paymentLink.endDate |
query |
string (date-time) |
Optional |
— |
request.paymentLink.recurringDescription |
query |
string |
Optional |
— |
request.paymentLink.installmentTotal |
query |
integer (int32) |
Optional |
— |
request.appKey |
query |
string |
Required |
Application Key which uniquely identifies your application as provided by the Blackstone system. |
request.appType |
query |
integer (int32) |
Required |
Application Type as provided by the Blackstone system. |
request.mid |
query |
integer (int32) |
Required |
Merchant ID – A number used to identify the merchant. |
request.cid |
query |
integer (int32) |
Required |
Cashier ID – A number used to identify the merchant’s subclient. |
request.userName |
query |
string |
Required |
User credential of the client on the host. |
request.password |
query |
string |
Required |
Password of the client on the host. |
request.ipAddress |
query |
string |
Optional |
— |
request.source |
query |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional |
— |
request.appInfo |
query |
string |
Optional |
— |
request.isTest |
query |
boolean |
Optional |
— |
Responses
Example response
{
"PaymentLink": {
"Id": "<id>",
"MerchantId": 1,
"Amount": "<amount>",
"Description": "<description>",
"Type": "Open",
"CreatedOn": "2026-01-31T12:00:00Z",
"PaidOn": "2026-01-31T12:00:00Z",
"DisabledOn": "2026-01-31T12:00:00Z",
"Status": "UnPaid",
"Active": false,
"ServiceReferenceNumber": "<service-reference-number>",
"InvoiceNumber": "<invoice-number>",
"ForcedPaymentMethod": "Credit",
"Link": "<link>",
"AllowRecurringPayment": false,
"AllowedPaymentSchedule": "OnlySingle"
},
"ResponseCode": 200,
"Msg": [
"<msg>"
],
"verbiage": "<verbiage>",
"displayMessage": "<display-message>"
}
Add Payment Link
POST
/api/PaymentLinks/AddPaymentLink
Request body
Schema: PaymentLinkRequest
| Field |
Type |
Requirement |
Description |
PaymentLink |
PaymentLinkModel |
Optional |
— |
AppKey |
string |
Required |
Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) |
Required |
Application Type as provided by the Blackstone system. |
mid |
integer (int32) |
Required |
Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) |
Required |
Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string |
Required |
User credential of the client on the host. |
Password |
string |
Required |
Password of the client on the host. |
IpAddress |
string |
Optional |
— |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional |
— |
AppInfo |
string |
Optional |
— |
IsTest |
boolean |
Optional |
— |
curl --request POST \
--url 'https://services.bmspay.com/api/PaymentLinks/AddPaymentLink' \
--header 'Content-Type: application/json' \
--data-binary @- <<'JSON'
{
"AppKey": "your-app-key",
"AppType": 1,
"mid": 1,
"cid": 1,
"UserName": "your-username",
"Password": "your-password",
"IsTest": true
}
JSON
{
"AppKey": "your-app-key",
"AppType": 1,
"mid": 1,
"cid": 1,
"UserName": "your-username",
"Password": "your-password",
"IsTest": true
}
Responses
Example response
{
"PaymentLink": {
"Id": "<id>",
"MerchantId": 1,
"Amount": "<amount>",
"Description": "<description>",
"Type": "Open",
"CreatedOn": "2026-01-31T12:00:00Z",
"PaidOn": "2026-01-31T12:00:00Z",
"DisabledOn": "2026-01-31T12:00:00Z",
"Status": "UnPaid",
"Active": false,
"ServiceReferenceNumber": "<service-reference-number>",
"InvoiceNumber": "<invoice-number>",
"ForcedPaymentMethod": "Credit",
"Link": "<link>",
"AllowRecurringPayment": false,
"AllowedPaymentSchedule": "OnlySingle"
},
"ResponseCode": 200,
"Msg": [
"<msg>"
],
"verbiage": "<verbiage>",
"displayMessage": "<display-message>"
}
Edit Payment Link
PUT
/api/PaymentLinks/EditPaymentLink
Request body
Schema: PaymentLinkRequest
| Field |
Type |
Requirement |
Description |
PaymentLink |
PaymentLinkModel |
Optional |
— |
AppKey |
string |
Required |
Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) |
Required |
Application Type as provided by the Blackstone system. |
mid |
integer (int32) |
Required |
Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) |
Required |
Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string |
Required |
User credential of the client on the host. |
Password |
string |
Required |
Password of the client on the host. |
IpAddress |
string |
Optional |
— |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional |
— |
AppInfo |
string |
Optional |
— |
IsTest |
boolean |
Optional |
— |
curl --request PUT \
--url 'https://services.bmspay.com/api/PaymentLinks/EditPaymentLink' \
--header 'Content-Type: application/json' \
--data-binary @- <<'JSON'
{
"AppKey": "your-app-key",
"AppType": 1,
"mid": 1,
"cid": 1,
"UserName": "your-username",
"Password": "your-password",
"IsTest": true
}
JSON
{
"AppKey": "your-app-key",
"AppType": 1,
"mid": 1,
"cid": 1,
"UserName": "your-username",
"Password": "your-password",
"IsTest": true
}
Responses
Example response
{
"PaymentLink": {
"Id": "<id>",
"MerchantId": 1,
"Amount": "<amount>",
"Description": "<description>",
"Type": "Open",
"CreatedOn": "2026-01-31T12:00:00Z",
"PaidOn": "2026-01-31T12:00:00Z",
"DisabledOn": "2026-01-31T12:00:00Z",
"Status": "UnPaid",
"Active": false,
"ServiceReferenceNumber": "<service-reference-number>",
"InvoiceNumber": "<invoice-number>",
"ForcedPaymentMethod": "Credit",
"Link": "<link>",
"AllowRecurringPayment": false,
"AllowedPaymentSchedule": "OnlySingle"
},
"ResponseCode": 200,
"Msg": [
"<msg>"
],
"verbiage": "<verbiage>",
"displayMessage": "<display-message>"
}
Disable Payment Link
PUT
/api/PaymentLinks/DisablePaymentLink
Request body
Schema: PaymentLinkRequest
| Field |
Type |
Requirement |
Description |
PaymentLink |
PaymentLinkModel |
Optional |
— |
AppKey |
string |
Required |
Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) |
Required |
Application Type as provided by the Blackstone system. |
mid |
integer (int32) |
Required |
Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) |
Required |
Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string |
Required |
User credential of the client on the host. |
Password |
string |
Required |
Password of the client on the host. |
IpAddress |
string |
Optional |
— |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional |
— |
AppInfo |
string |
Optional |
— |
IsTest |
boolean |
Optional |
— |
curl --request PUT \
--url 'https://services.bmspay.com/api/PaymentLinks/DisablePaymentLink' \
--header 'Content-Type: application/json' \
--data-binary @- <<'JSON'
{
"AppKey": "your-app-key",
"AppType": 1,
"mid": 1,
"cid": 1,
"UserName": "your-username",
"Password": "your-password",
"IsTest": true
}
JSON
{
"AppKey": "your-app-key",
"AppType": 1,
"mid": 1,
"cid": 1,
"UserName": "your-username",
"Password": "your-password",
"IsTest": true
}
Responses
Example response
{
"PaymentLink": {
"Id": "<id>",
"MerchantId": 1,
"Amount": "<amount>",
"Description": "<description>",
"Type": "Open",
"CreatedOn": "2026-01-31T12:00:00Z",
"PaidOn": "2026-01-31T12:00:00Z",
"DisabledOn": "2026-01-31T12:00:00Z",
"Status": "UnPaid",
"Active": false,
"ServiceReferenceNumber": "<service-reference-number>",
"InvoiceNumber": "<invoice-number>",
"ForcedPaymentMethod": "Credit",
"Link": "<link>",
"AllowRecurringPayment": false,
"AllowedPaymentSchedule": "OnlySingle"
},
"ResponseCode": 200,
"Msg": [
"<msg>"
],
"verbiage": "<verbiage>",
"displayMessage": "<display-message>"
}
Payment Links
GET
/api/PaymentLinks
Parameters
| Name |
Location |
Type |
Required |
Description |
request.paymentLink.id |
query |
string |
Optional |
— |
request.paymentLink.merchantId |
query |
integer (int32) |
Optional |
— |
request.paymentLink.amount |
query |
string |
Optional |
— |
request.paymentLink.description |
query |
string |
Optional |
— |
request.paymentLink.type |
query |
string — Open, Fixed |
Optional |
— |
request.paymentLink.createdOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.paidOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.disabledOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.status |
query |
string — UnPaid, Paid |
Optional |
— |
request.paymentLink.active |
query |
boolean |
Optional |
— |
request.paymentLink.serviceReferenceNumber |
query |
string |
Optional |
— |
request.paymentLink.invoiceNumber |
query |
string |
Optional |
— |
request.paymentLink.forcedPaymentMethod |
query |
string — Credit, Check, ATHMobile, GooglePay, ApplePay, Debit |
Optional |
— |
request.paymentLink.link |
query |
string |
Optional |
— |
request.paymentLink.allowRecurringPayment |
query |
boolean |
Optional |
— |
request.paymentLink.allowedPaymentSchedule |
query |
string — OnlySingle, OnlyRecurringOrInstallment, SingleAndRecurringOrInstallment, SingleAndRecurringOnly, SingleAndInstallmentOnly, OnlyRecurring, OnlyInstallment |
Optional |
— |
request.paymentLink.paymentSchedule |
query |
string — Single, Recurring, Installment |
Optional |
— |
request.paymentLink.isOpenPaymentSchedule |
query |
boolean |
Optional |
— |
request.paymentLink.frequencyId |
query |
integer (int32) |
Optional |
— |
request.paymentLink.startDate |
query |
string (date-time) |
Optional |
— |
request.paymentLink.endDate |
query |
string (date-time) |
Optional |
— |
request.paymentLink.recurringDescription |
query |
string |
Optional |
— |
request.paymentLink.installmentTotal |
query |
integer (int32) |
Optional |
— |
request.appKey |
query |
string |
Required |
Application Key which uniquely identifies your application as provided by the Blackstone system. |
request.appType |
query |
integer (int32) |
Required |
Application Type as provided by the Blackstone system. |
request.mid |
query |
integer (int32) |
Required |
Merchant ID – A number used to identify the merchant. |
request.cid |
query |
integer (int32) |
Required |
Cashier ID – A number used to identify the merchant’s subclient. |
request.userName |
query |
string |
Required |
User credential of the client on the host. |
request.password |
query |
string |
Required |
Password of the client on the host. |
request.ipAddress |
query |
string |
Optional |
— |
request.source |
query |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional |
— |
request.appInfo |
query |
string |
Optional |
— |
request.isTest |
query |
boolean |
Optional |
— |
Responses
Example response
{
"PaymentLinks": [
{
"Id": "<id>",
"MerchantId": 1,
"Amount": "<amount>",
"Description": "<description>",
"Type": "Open",
"CreatedOn": "2026-01-31T12:00:00Z",
"PaidOn": "2026-01-31T12:00:00Z",
"DisabledOn": "2026-01-31T12:00:00Z",
"Status": "UnPaid",
"Active": false,
"ServiceReferenceNumber": "<service-reference-number>",
"InvoiceNumber": "<invoice-number>",
"ForcedPaymentMethod": "Credit",
"Link": "<link>",
"AllowRecurringPayment": false,
"AllowedPaymentSchedule": "OnlySingle"
}
],
"ResponseCode": 200,
"Msg": [
"<msg>"
],
"verbiage": "<verbiage>",
"displayMessage": "<display-message>"
}
Payment Links
POST
/api/PaymentLinks
Request body
Schema: PaymentLinkRequest
| Field |
Type |
Requirement |
Description |
PaymentLink |
PaymentLinkModel |
Optional |
— |
AppKey |
string |
Required |
Application Key which uniquely identifies your application as provided by the Blackstone system. |
AppType |
integer (int32) |
Required |
Application Type as provided by the Blackstone system. |
mid |
integer (int32) |
Required |
Merchant ID – A number used to identify the merchant. |
cid |
integer (int32) |
Required |
Cashier ID – A number used to identify the merchant’s subclient. |
UserName |
string |
Required |
User credential of the client on the host. |
Password |
string |
Required |
Password of the client on the host. |
IpAddress |
string |
Optional |
— |
Source |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional |
— |
AppInfo |
string |
Optional |
— |
IsTest |
boolean |
Optional |
— |
curl --request POST \
--url 'https://services.bmspay.com/api/PaymentLinks' \
--header 'Content-Type: application/json' \
--data-binary @- <<'JSON'
{
"AppKey": "your-app-key",
"AppType": 1,
"mid": 1,
"cid": 1,
"UserName": "your-username",
"Password": "your-password",
"IsTest": true
}
JSON
{
"AppKey": "your-app-key",
"AppType": 1,
"mid": 1,
"cid": 1,
"UserName": "your-username",
"Password": "your-password",
"IsTest": true
}
Responses
Example response
{
"PaymentLink": {
"Id": "<id>",
"MerchantId": 1,
"Amount": "<amount>",
"Description": "<description>",
"Type": "Open",
"CreatedOn": "2026-01-31T12:00:00Z",
"PaidOn": "2026-01-31T12:00:00Z",
"DisabledOn": "2026-01-31T12:00:00Z",
"Status": "UnPaid",
"Active": false,
"ServiceReferenceNumber": "<service-reference-number>",
"InvoiceNumber": "<invoice-number>",
"ForcedPaymentMethod": "Credit",
"Link": "<link>",
"AllowRecurringPayment": false,
"AllowedPaymentSchedule": "OnlySingle"
},
"ResponseCode": 200,
"Msg": [
"<msg>"
],
"verbiage": "<verbiage>",
"displayMessage": "<display-message>"
}
{id}
GET
/api/PaymentLinks/{id}
Parameters
| Name |
Location |
Type |
Required |
Description |
id |
path |
string |
Required |
— |
request.paymentLink.id |
query |
string |
Optional |
— |
request.paymentLink.merchantId |
query |
integer (int32) |
Optional |
— |
request.paymentLink.amount |
query |
string |
Optional |
— |
request.paymentLink.description |
query |
string |
Optional |
— |
request.paymentLink.type |
query |
string — Open, Fixed |
Optional |
— |
request.paymentLink.createdOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.paidOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.disabledOn |
query |
string (date-time) |
Optional |
— |
request.paymentLink.status |
query |
string — UnPaid, Paid |
Optional |
— |
request.paymentLink.active |
query |
boolean |
Optional |
— |
request.paymentLink.serviceReferenceNumber |
query |
string |
Optional |
— |
request.paymentLink.invoiceNumber |
query |
string |
Optional |
— |
request.paymentLink.forcedPaymentMethod |
query |
string — Credit, Check, ATHMobile, GooglePay, ApplePay, Debit |
Optional |
— |
request.paymentLink.link |
query |
string |
Optional |
— |
request.paymentLink.allowRecurringPayment |
query |
boolean |
Optional |
— |
request.paymentLink.allowedPaymentSchedule |
query |
string — OnlySingle, OnlyRecurringOrInstallment, SingleAndRecurringOrInstallment, SingleAndRecurringOnly, SingleAndInstallmentOnly, OnlyRecurring, OnlyInstallment |
Optional |
— |
request.paymentLink.paymentSchedule |
query |
string — Single, Recurring, Installment |
Optional |
— |
request.paymentLink.isOpenPaymentSchedule |
query |
boolean |
Optional |
— |
request.paymentLink.frequencyId |
query |
integer (int32) |
Optional |
— |
request.paymentLink.startDate |
query |
string (date-time) |
Optional |
— |
request.paymentLink.endDate |
query |
string (date-time) |
Optional |
— |
request.paymentLink.recurringDescription |
query |
string |
Optional |
— |
request.paymentLink.installmentTotal |
query |
integer (int32) |
Optional |
— |
request.appKey |
query |
string |
Required |
Application Key which uniquely identifies your application as provided by the Blackstone system. |
request.appType |
query |
integer (int32) |
Required |
Application Type as provided by the Blackstone system. |
request.mid |
query |
integer (int32) |
Required |
Merchant ID – A number used to identify the merchant. |
request.cid |
query |
integer (int32) |
Required |
Cashier ID – A number used to identify the merchant’s subclient. |
request.userName |
query |
string |
Required |
User credential of the client on the host. |
request.password |
query |
string |
Required |
Password of the client on the host. |
request.ipAddress |
query |
string |
Optional |
— |
request.source |
query |
string — ApiClient, BpaydPortal, BPaydApp, BatchCloser, RecurringBillingTask, BPaydPlugin, PaymentFrame, VirtualTerminal, PaymentLink, Recurring, Invoice, QuickPayment, TakePayment, QuickPaymentMobileApp, WordPress, Zoho, Xero, Odoo, GoHighLevel, TakePaymentMobileApp |
Optional |
— |
request.appInfo |
query |
string |
Optional |
— |
request.isTest |
query |
boolean |
Optional |
— |
Responses
Example response
{
"PaymentLink": {
"Id": "<id>",
"MerchantId": 1,
"Amount": "<amount>",
"Description": "<description>",
"Type": "Open",
"CreatedOn": "2026-01-31T12:00:00Z",
"PaidOn": "2026-01-31T12:00:00Z",
"DisabledOn": "2026-01-31T12:00:00Z",
"Status": "UnPaid",
"Active": false,
"ServiceReferenceNumber": "<service-reference-number>",
"InvoiceNumber": "<invoice-number>",
"ForcedPaymentMethod": "Credit",
"Link": "<link>",
"AllowRecurringPayment": false,
"AllowedPaymentSchedule": "OnlySingle"
},
"ResponseCode": 200,
"Msg": [
"<msg>"
],
"verbiage": "<verbiage>",
"displayMessage": "<display-message>"
}