Take payments

Android

iOS

Accept payments with a terminal from your mobile point of sale through our POS app. You can integrate your app on Android using Intents and Links.

Intents

Execute an action in our POS application through an Intent on Android from your application. Install the SDK and send the required parameters when executing an action.

Adding the SDK to your proyect

Add the SDK in your project's build.gradle file.

Add the following necessary dependencies:

Building the Intent

Create an instance of BPIntentBuilder class and set an action:

Next, every mandatory or optional parameter should be set to the instance:

Request data model

These are all the parameters you can configure when making a request.

Property	Type	Required	Description
transaction	String	Yes	Transaction type: `venta`: Sale operation. `devolucion`: Refund operation.
userToken	String	Yes	User token
identifier	String	Yes	Send an identifier generated on your side for transaction traceability. It will be returned in the response. 256 characters maximum.
amount	Number	Yes	Transaction amount. Do not include tip. Two decimals.
urlScheme	String	Yes	App, webhook or url scheme to be called at the end of any transaction. This app should be ready to handle the POS app call. 50 characters maximum.
tip	Number	No	Tip included in the transaction. Two decimals.
msi	Integer	No	Defer a payment. Choose the number of monthly installments to defer payment: `0` : One-time payment. `3`: 3 installments. `6`: 6 installments. `9`: 9 installments. `12`: 12 installments.
reference	String	No	Text reference to identify the transaction. 256 characters maximum.
email	String	No	Customer’s email (when provided). 150 characters maximum.
phone	String	No	Customer's phone number (when provided). 14 characters maximum.
showPhotoButton	Boolean	No	It allows you to attach a photo during the transaction. The default value is false.
mandatoryPhoto	Boolean	No	Make photography mandatory during the transaction. You will need to set the showPhotoButton property to true.
deviceToken	String	No	String identifier for the device.
3pID	String	No	Specify an identifier for the third party requesting the transaction.
hidePrinter	Boolean	No	Specify if the printer option should be displayed after a successful transaction or not.
skipMailPrint	Boolean	No	Specify if the ticket should be automatically sent after a successful transaction or not, this requires a mail or phone number set and will skip the send ticket activity.
xpLandscape	Boolean	No	Specify whether the POS application will launch in landscape mode. Only applies to large screens.
deviceName	String	No	Name to identify the device.
setTimerFinishTRX	Integer	No	Set the timer (in seconds) to continue to the next screen in case there is no user interaction on the confirmation screen.
autoPaymentEnabled	Boolean (`true` or `false`)	No	When this parameter is sent as `true`, the payment process will be triggered automatically without waiting for confirmation via the Pay button.

Operations

Discover all the operations available through App to App integrations.

Sale

Send a request with the required payment settings from your system to a terminal to perform the desired transaction.

Start the POS application via the builder function by sending an Intent with all the required parameters.

If the information submitted is correct, the POS app will open to the payment screen with the transaction settings configured. Follow the steps on the screen to complete the payment process with the terminal.

Please review the documentation to perform a cancellation.

Tipping

You must enable the option in the settings menu to use tipping via Intents. Follow the steps below to enable tipping.

Click on the top left icon and select the Settings option.

Activate the Propina option.

If a transaction is set to a tip greater than 0, the tip amount will be displayed in a new label below the transaction amount.

If no tip amount is submitted in the request or if it is equal to 0 and the tip option is enabled, the tip selection dialog will be displayed.

Response

The response will be received as an Intent by the onActivityResult method of the calling activity.

Depending on the result of the operation, you may receive additional information through some of the following properties.

Remember that not all properties will be available in the response. It will depend on the result of the operation.

Property	Type	Description
result	String	The result of the operation. It can be: `aprobada`: approved. `rechazada`: declined. `error`: error.
statusinfo	String	In case of error, additional information will be returned.
amount	Number	Monto de la transacción (sin propina incluida). Dos decimales.
tip	Number	Tip included in the transaction.
reference	String	Text reference to identify the transaction.
transactionId	String	Transaction id.
msi	Integer	If it is a deferred payment, the number of installments will be returned. `0` : One-time payment. `3`: 3 installments. `6`: 6 installments. `9`: 9 installments. `12`: 12 installments.
authorization	String	Authorization given by the issuer bank
creditcard	String	Las 4 digits of the card.
email	String	Customer’s email (when provided).
phone	String	Customer's phone number (when provided).
cardtype	String	Card type.
arqc	String	Card’s chip validated cryptogram (when available).
aid	String	Card’s chip application identifier (when available).
applabel	String	Card’s chip application label (when available).
url	String	Identifier to obtain a digital voucher.
identifier	String	Transaction amount. Do not include tip.
bank	String	Card issuer.
accountType	String	Account type: `credit`: credit card. `debit`: debit card.
name	String	Cardholder name.
bp_version	String	POS app version.

Simulate different scenarios with test data.

Links

Perform an action in our POS app using custom URL schemes on Android from your native or web app. Set the URL with all the parameters required to open the POS app and perform the operation. The POS app will open when a link with the custom URL scheme Billpocket:// is clicked.

You need to have our POS app installed and configured on the same device as the point of sale app.