Web checkout implementation
Parameters description
Available Payment methods.
Web checkout Implementation
Below you will find a sample code for your payment button. Simply replace the example values as required and you’ll be ready to start receiving payments.
Parameters description
Parameter | Type | Description | Requirement |
---|---|---|---|
pg_serviceid | integer | Service ID of your account. | Mandatory |
pg_price | numeric | The price of the product/service. | Mandatory |
pg_currency | string | Type of currency specified in alphabetic code ISO 4217 you want to use (eg: EUR, USD, GBP, MXN, etc.). See the full list of the currency codes. | Mandatory |
pg_country | string | Country of the payer, in ISO 3166-2 format (e.g. GB, DE, ES). See the list of the country codes. |
Mandatory |
pg_language | string | Language, in ISO 639-1 format (e.g. en, es). If the provided language is not available, defaults to english. | optional |
pg_method | string | Payment method. Please check the table below for a list of available payment methods and their codes. For more information regarding each payment method, please check our Pricing page. | Mandatory only for whitelabel checkout |
pg_name | string | Description of your product/service, which will be shown on the payment screen. | optional |
pg_custom | string | Custom field, can be used to identify customer, inventory, etc. | optional |
pg_email | string | Email address of the payer. | Mandatory only for whitelabel checkout |
pg_phone | string | Phone number of the payer. | Mandatory only for whitelabel checkout for some payment methods. |
pg_first_name | string | First name of the payer. | Mandatory only for whitelabel checkout |
pg_last_name | string | Last name of the payer. | Mandatory only for whitelabel checkout |
pg_personalid | string | Local personal ID number of the payer. | Mandatory only for whitelabel checkout for some payment methods |
pg_sub_merchant_id | string | Code used to distinguish between different merchants using our service via your platform. | optional |
pg_sub_merchant_url | string | Merchant’s website where payment originates. | optional |
pg_return_url | string | After the payment process your customers will be redirected here (e.g. https://www.mysite.com/thanks). | optional |
pg_cancel_url | string | Your customer will be redirected to after a cancelled or failed payment process (e.g. https://www.mysite.com/failed). | optional |
Available Payment methods:
Name | Coverage | Code |
Credit Card | Worldwide | creditcard |
Bitcoin | Worldwide | bitcoin |
Boleto | Brazil | boleto |
Banco do Brasil | Brazil | bancodobrasil |
Bradesco | Brazil | bradesco |
Itau | Brazil | itau |
Santander | Mexico | santander |
Banamex | Mexico | banamex |
OXXO | Mexico | oxxo |
BBVA Bancomer | Mexico | bancomer |
Citibanamex | Mexico | banamex |
Debit card Visa | Mexico | debvisa |
Debit card mastercard | Mexico | debmaster |
Mercadopago card | Mexico | mercadopagocard |
PagoFacil | Argentina | pagofacil |
RapiPago | Argentina | rapipago |
WebPay | Chile | webpay |
Servipag | Chile | servipag |
MACH | Chile | mach |
Multicaja | Chile | multicaja |
PSE | Colombia | pse |
Efecty | Colombia | efecty |
ViaBaloto | Colombia | viabaloto |
Apostar | Colombia | apostar |
Bancolombia | Colombia | bancolombia |
GANA | Colombia | gana |
PuntoRed | Colombia | puntored |
RedServi | Colombia | redservi |
SuRed | Colombia | sured |
SuSuerte | Colombia | susuerte |
PagoEfectivo | Perú | pagoefectivo |
BBVA Continental | Perú | bbva |
BCP | Perú | bcp |
ScotiaBank | Perú | ScotiaBank |
Western Union | Perú | wu |
Banco Pichincha | Ecuador | pichincha |
Banco de Costa Rica | Costa Rica | bcr |
Banco Nacional | Costa Rica | bncr |
Redpagos | Uruguay | redpagos |
Credit Card
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
Bitcoin
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
Webpay
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
Multicaja
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
Servipag
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
PagoEfectivo
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
pg_phone | Mandatory |
Pago Facil
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
Rapipago
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
Bradesco
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
pg_phone | Mandatory (Format E.g.: 5531123456789) |
OXXO
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
Itaú
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
pg_phone | Mandatory (Format E.g.: 5531123456789) |
Davivienda
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
Boleto
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
Redpagos
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
Santander Brasil
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
pg_phone | Mandatory (Format E.g.: 5531123456789) |
Santander México
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
Banco do Brasil
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
pg_phone | Mandatory (Format E.g.: 5531123456789) |
PSE
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
Efecty
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |
pg_personalid | Mandatory |
ViaBaloto
pg_country | Mandatory |
---|---|
pg_email | Mandatory |
pg_first_name | Mandatory |
pg_last_name | Mandatory |