Open the Billpocket POS app from a native or mobile web app on Android using the custom URL schema Billpocket://.Service available in Mexico only.
Requirements#
Calling the POS app#
Send all required parameters as a query string in the URL. The POS app opens when a link with the schema Billpocket:// is triggered.Supported operations#
Request parameters#
| Parameter | Type | Sale | Refund | Description |
|---|
transaction | string | ✅ | ✅ | "venta" or "devolucion" |
userToken | string | ✅ | ✅ | Your user token |
identifier | string | ✅ | ✅ | Unique identifier for traceability. Max 256 chars |
amount | decimal | ✅ | — | Transaction amount. Two decimal places. Does not include tip |
urlScheme | string | ✅ | ✅ | App, webhook, or URL scheme called after the transaction. Max 50 chars |
transactionId | string | — | ✅ | Original transaction ID to refund |
tip | decimal | — | — | Tip amount. Two decimal places |
msi | integer | — | — | MSI installments: 0, 3, 6, 9, or 12 |
reference | string | — | — | Text reference. Max 256 chars |
email | string | — | — | Customer email. Max 150 chars |
phone | string | — | — | Customer phone. Max 14 chars |
showPhotoButton | boolean | — | — | Show photo attachment button. Default false |
mandatoryPhoto | boolean | — | — | Require photo. Requires showPhotoButton: true |
deviceToken | string | — | — | Device identifier string |
3pID | string | — | — | Third-party identifier for the requesting app |
hidePrinter | boolean | — | — | Hide printer option after a successful transaction |
skipMailPrint | boolean | — | — | Auto-send ticket after success (requires email or phone) |
xpLandscape | boolean | — | — | Launch POS app in landscape. Large screens only |
deviceName | string | — | — | Name to identify the device |
enableDialogTip | boolean | — | — | Show tip dialog at checkout. Requires tip to be 0 or omitted |
autoPaymentEnabled | integer | — | — | 1 to auto-start collection without pressing Cobrar |
Sale#
Billpocket://?transaction=venta&userToken=<token>&identifier=ORD-001&amount=500.00&urlScheme=https://miapp.com/resultado
Refund#
Billpocket://?transaction=devolucion&userToken=<token>&identifier=REF-001&transactionId=128010&urlScheme=https://miapp.com/resultado
Got a suggestion on this documentation? Contact us.