Developer Tools – URL parameters

The URL parameters used by PayPro Global are the following:

Key/Value
Description
products[i][id]=ID
Product Id for the [i](position of the product in cart) product that you want to sell.
products[i][qty]=QUANTITY
Product Quantity for [i](position of the product in cart) product.
products[i][agreement-id]=AGREEMENTID
Affiliate Agreement for [i](position of the product in cart) product.
products[i][data]=DATA
Dynamic encrypted data for [i](position of the product in cart) product for encrypted dynamic settings.
products[i][name]=NAME
Dynamic name for [i](position of the product in cart) product for unencrypted dynamic settings.
products[i][description]=DESCRIPTION
Dynamic description for [i](position of the product in cart) product for unencrypted dynamic settings.
products[i][discountpercentage]=DISCOUNTPERCENTAGE
Dynamic percentage discount for [i](position of the product in cart) product for unencrypted dynamic settings.
products[i][price][CURRENCY_CODE][amount]=PRICE
Dynamic price in selected currency [CURRENCY_CODE] for [i](position of the product in cart) product for unencrypted dynamic settings. You can find list of available currency codes here.
products[i][recurringprice][CURRENCY_CODE][amount]=RECURRINGPRICE
Dynamic recurring price in selected currency [CURRENCY_CODE] for [i](position of the product in cart) product for unencrypted dynamic settings. You can find list of available currency codes here.
products[i][allow-recurring-charges]=FALSE
If true then set subscription renewal type to Auto otherwise Manual.
products[i][skip-trial-period]=FALSE
Allow user to skip trial period and pay instantly.
products[i][download-warranty]=FALSE
If true then add download warranty to the cart.
products[i][media-backup]=FALSE
If true then add back-up media to the cart.
products[i][option-groups][OPTION_GROUP_ID]=
Option group setting for groups with single option.
products[i][option-groups][OPTION_GROUP_ID][]=
Option group setting for groups with multiple options.
custom-fields[CUSTOM_FIELD_ID][]=x-customfield1=value1,x-customfield2=value2
Custom fields settings.
page-template=ID
Using this parameter you can display any page template using it’s ID.
alwaysgoogle=FALSE
Add test order to Google Analytics
all-payment-methods=FALSE
If available and true then allow user to pay with all payment methods.
enable-auto-renewal=FALSE
If available and true set all subscriptions in order to Auto.
coupon-code-to-add=COUPONCODE
Apply coupon code.
use-test-mode=FALSE
Enables test mode for the order.
secret-key=SECRETKEY
Special key for the seller.
display-quote=FALSE
Show Get quote button.
payment-method=ID
Preselected payment method for the order. You can find list of available payment method IDs here.
currency=CURRENCYCODE
Preselected currency for the order. You can find list of available currency codes here.
language=LANGUAGECODE
Preselected language for the order. You can find list of available language codes here.
billing-first-name=FIRSTNAME
Predefined first name for the order.
billing-last-name=LASTNAME
Predefined last name for the order.
billing-email=EMAILADDRESS
Predefined email address for the order.
billing-contact-phone=PHONENUMBER
Predefined phone number for the order.
billing-country=COUNTRYCODE
Preselected country for the order. You can find list of available country codes here.
billing-state=STATECODE
Preselected state for the order. Available only if the country has states. You can find list of available state codes here.
billing-city=CITY
Predefined city for the order.
billing-zip=ZIPCODE
Predefined zip code for the order.
billing-address=BILLINGADDRESS
Predefined billing address for the order.
street-number=STREETNUMBER
Predefined street number for the order. Is required only for Brazil orders.
use-company-purchase=FALSE
If TRUE, shows company purchase fields for the order.
billing-company-name=COMPANYNAME
Predefined company name for the order. Parameter ‘use-company-purchase’ should be TRUE.
billing-company-vat-id=VATID
Predefined company vat id for the order. Parameter ‘use-company-purchase’ should be TRUE.
use-license-info=FALSE
If TRUE, shows licensee info fields for the order.
license-name=LICENSEENAME
Predefined licensee name for the order. Parameter ‘use-license-info’ should be TRUE.
license-email=LICENSEEEMAIL
Predefined licensee email for the order. Parameter ‘use-license-info’ should be TRUE.
use-shipping-info=FALSE
If TRUE, shows different shipping info fields for the order. Can be used only if any product in the order has physical delivery.
shipping-country=SHIPPINGCOUNTRYCODE
Predefined shipping country for the order. Parameter ‘use-shipping-info’ should be TRUE. You can find list of available country codes here.
shipping-state=SHIPPINGSTATECODE
Predefined shipping state for the order. Can be used only if shipping country has states, also parameter ‘use-shipping-info’ should be TRUE. You can find list of available state codes here.
shipping-city=SHIPPINGCITY
Predefined shipping city for the order. Parameter ‘use-shipping-info’ should be TRUE.
shipping-zip=SHIPPINGZIPCODE
Predefined shipping zip code for the order. Parameter ‘use-shipping-info’ should be TRUE.
shipping-address=SHIPPINGADDRESS
Predefined shipping address for the order. Parameter ‘use-shipping-info’ should be TRUE.
birth-date=BIRTHDATE
Predefined birth date for the order. Can be used only for Brazil orders.
fiscal-number-personal=CPF
Predefined personal fiscal number (CPF) for the order. Can be used only for Brazil orders.
fiscal-number-company=CNPJ
Predefined company fiscal number (CNPJ) for the order. Can be used only for Brazil orders also parameter ‘use-company-purchase’ should be TRUE.
paypal-email=PAYPALEMAIL
Predefined paypal email for the order. Can be used only for PayPal orders.
visa-qiwi-wallet=VISAQIWIWALLETNUMBER
Predefined visa qiwi wallet number for the order. Can be used only for VISA QIWI orders.
show-popular-methods-only=true
By default display only top 3 (2 for subscription products) most popular payment methods available for current product in the selected billing country (customer can still see a full list of options by clicking “See all payment methods”).

Examples of most commonly used URLs with different parameters:

One product with product id equals 1:
https://store.payproglobal.com/checkout?products[1][id]=1

One product with product id equals 1 and page template id equals 1:
https://store.payproglobal.com/checkout?products[1][id]=1&page-template=1

One product with product id equals 1 and language english:
https://store.payproglobal.com/checkout?products[1][id]=1&language=EN

One product with product id equals 1 and currency USD:
https://store.payproglobal.com/checkout?products[1][id]=1¤cy=USD

One product with product id equals 1 and country United States:
https://store.payproglobal.com/checkout?products[1][id]=1&billing-country=US

One product with product id equals 1, country United States and state Alaska:
https://store.payproglobal.com/checkout?products[1][id]=1&billing-country=US&billing-state=US-AK

One product with product id equals 1 and credit card payment method:
https://store.payproglobal.com/checkout?products[1][id]=1&payment-method=1

One product with product id equals 1 with test mode enabled:
https://store.payproglobal.com/checkout?products[1][id]=1&use-test-mode=true

TIP: If you have a secret key than you need use the link below to make test orders.

One product with product id equals 1 with test mode enabled:
https://store.payproglobal.com/checkout?products[1][id]=1&use-test-mode=true&secret-key=SECRETKEY

List of payment methods with IDs:

Payment method
ID
Credit Card
1
Phone Order
10
Fax Order
11
Check / Cash
13
PayPal
14
Wire Transfer
15
Purchase Order
30
WebMoney
31
Yandex.Money
32
Boleto Bancario
33
Alipay
34
QIWI
36
Real-time Bank Transfer
37

List of countries with codes:

Country
Code
Afghanistan
AF
Aland islands
AX
Albania
AL
Algeria
DZ
American Samoa
AS
Andorra
AD
Angola
AO
Anguilla
AI
Antarctica
AQ
Antigua and Barbuda
AG
Argentina
AR
Armenia
AM
Aruba
AW
Ascension Island
AC
Australia
AU
Austria
AT
Azerbaijan
AZ
Bahamas
BS
Bahrain
BH
Bangladesh
BD
Barbados
BB
Belarus
BY
Belgium
BE
Belize
BZ
Benin
BJ
Bermuda
BM
Bhutan
BT
Bolivia
BO
Bonaire, Sint Eustatius And Saba
BQ
Bosnia and Herzegovina
BA
Botswana
BW
Bouvet Island
BV
Brazil
BR
British Indian Ocean Territory
IO
Brunei Darussalam
BN
Bulgaria
BG
Burkina Faso
BF
Burundi
BI
Cambodia
KH
Cameroon
CM
Canada
CA
Canary Islands
IC
Cape Verde
CV
Cayman Islands
KY
Central African Republic
CF
Ceuta and Melilla
EA
Chad
TD
Chile
CL
China
CN
Christmas Island
CX
Clipperton Island
CP
Cocos (Keeling) Islands
CC
Colombia
CO
Comoros
KM
Congo
CG
Congo, the Democratic Republic of the
CD
Cook Islands
CK
Costa Rica
CR
Cote D’ivoire
CI
Croatia
HR
Cuba
CU
Curacao
CW
Cyprus
CY
Czech Republic
CZ
Denmark
DK
Diego Garcia
DG
Djibouti
DJ
Dominica
DM
Dominican Republic
DO
Ecuador
EC
Egypt
EG
El Salvador
SV
Equatorial Guinea
GQ
Eritrea
ER
Estonia
EE
Ethiopia
ET
Falkland Islands (Malvinas)
FK
Faroe Islands
FO
Fiji
FJ
Finland
FI
France
FR
French Guiana
GF
French Polynesia
PF
French Southern Territories
TF
Gabon
GA
Gambia
GM
Georgia
GE
Germany
DE
Ghana
GH
Gibraltar
GI
Greece
GR
Greenland
GL
Grenada
GD
Guadeloupe
GP
Guam
GU
Guatemala
GT
Guernsey
GG
Guinea
GN
Guinea-Bissau
GW
Guyana
GY
Haiti
HT
Heard Island and Mcdonald Islands
HM
Holy See
VA
Honduras
HN
Hong Kong
HK
Hungary
HU
Iceland
IS
India
IN
Indonesia
ID
Iran, Islamic Republic of
IR
Iraq
IQ
Ireland
IE
Isle of Man
IM
Israel
IL
Italy
IT
Jamaica
JM
Japan
JP
Jersey
JE
Jordan
JO
Kazakhstan
KZ
Kenya
KE
Kiribati
KI
Korea, Democratic People’s Republic of
KP
Korea, Republic of
KR
Kosovo
XK
Kuwait
KW
Kyrgyzstan
KG
Lao People’s Democratic Republic
LA
Latvia
LV
Lebanon
LB
Lesotho
LS
Liberia
LR
Libyan Arab Jamahiriya
LY
Liechtenstein
LI
Lithuania
LT
Luxembourg
LU
Macau
MO
Macedonia, Republic of
MK
Madagascar
MG
Malawi
MW
Malaysia
MY
Maldives
MV
Mali
ML
Malta
MT
Marshall Islands
MH
Martinique
MQ
Mauritania
MR
Mauritius
MU
Mayotte
YT
Mexico
MX
Micronesia, Federated States of
FM
Moldova, Republic of
MD
Monaco
MC
Mongolia
MN
Montenegro
ME
Montserrat
MS
Morocco
MA
Mozambique
MZ
Myanmar
MM
Namibia
NA
Nauru
NR
Nepal
NP
Netherlands
NL
Netherlands Antilles
AN
New Caledonia
NC
New Zealand
NZ
Nicaragua
NI
Niger
NE
Nigeria
NG
Niue
NU
Norfolk Island
NF
Northern Mariana Islands
MP
Norway
NO
Oman
OM
Outlying Oceania
QO
Pakistan
PK
Palau
PW
Palestinian Territory
PS
Panama
PA
Papua New Guinea
PG
Paraguay
PY
Peru
PE
Philippines
PH
Pitcairn
PN
Poland
PL
Portugal
PT
Puerto Rico
PR
Qatar
QA
Reunion
RE
Romania
RO
Russian Federation
RU
Rwanda
RW
Saint Barthelemy
BL
Saint Helena
SH
Saint Kitts and Nevis
KN
Saint Lucia
LC
Saint Martin
MF
Saint Pierre and Miquelon
PM
Saint Vincent and the Grenadines
VC
Samoa
WS
San Marino
SM
Sao Tome and Principe
ST
Saudi Arabia
SA
Senegal
SN
Serbia
RS
Seychelles
SC
Sierra Leone
SL
Singapore
SG
Sint Maarten
SX
Slovak Republic
SK
Slovenia
SI
Solomon Islands
SB
Somalia
SO
South Africa
ZA
South Georgia and the South Sandwich Islands
GS
South Sudan
SS
Spain
ES
Sri Lanka
LK
Sudan
SD
Suriname
SR
Svalbard and Jan Mayen
SJ
Swaziland
SZ
Sweden
SE
Switzerland
CH
Syrian Arab Republic
SY
Taiwan
TW
Tajikistan
TJ
Tanzania, United Republic of
TZ
Thailand
TH
Timor-Leste
TL
Togo
TG
Tokelau
TK
Tonga
TO
Trinidad and Tobago
TT
Tristan da Cunha
TA
Tunisia
TN
Turkey
TR
Turkmenistan
TM
Turks and Caicos Islands
TC
Tuvalu
TV
Uganda
UG
Ukraine
UA
United Arab Emirates
AE
United Kingdom
GB
United States
US
United States Minor Outlying Islands
UM
Uruguay
UY
Uzbekistan
UZ
Vanuatu
VU
Venezuela
VE
Vietnam
VN
Virgin Islands, British
VG
Virgin Islands, U.S.
VI
Wallis and Futuna Islands
WF
Western Sahara
EH
Yemen
YE
Zambia
ZM
Zimbabwe
ZW

List of states with codes:

State
Code
Acre
BR-AC
Alagoas
BR-AL
Amazonas
BR-AM
Amapa
BR-AP
Bahia
BR-BA
Ceara
BR-CE
Distrito Federal
BR-DF
Espirito Santo
BR-ES
Goias
BR-GO
Maranhao
BR-MA
Minas Gerais
BR-MG
Mato Grosso do Sul
BR-MS
Mato Grosso
BR-MT
Para
BR-PA
Paraiba
BR-PB
Pernambuco
BR-PE
Piaui
BR-PI
Parana
BR-PR
Rio de Janeiro
BR-RJ
Rio Grande do Norte
BR-RN
Rondonia
BR-RO
Roraima
BR-RR
Rio Grande do Sul
BR-RS
Santa Catarina
BR-SC
Sergipe
BR-SE
Sao Paulo
BR-SP
Tocantins
BR-TO
Alberta
CA-AB
British Columbia
CA-BC
Manitoba
CA-MB
New Brunswick
CA-NB
Newfoundland and Labrador
CA-NL
Nova Scotia
CA-NS
Northwest Territories
CA-NT
Ontario
CA-ON
Prince Edward Island
CA-PE
Quebec
CA-QC
Saskatchewan
CA-SK
Yukon
CA-YT
Alaska
US-AK
Alabama
US-AL
Arkansas
US-AR
Arizona
US-AZ
California
US-CA
Colorado
US-CO
Connecticut
US-CT
District of Columbia
US-DC
Delaware
US-DE
Florida
US-FL
Georgia
US-GA
Hawaii
US-HI
Iowa
US-IA
Idaho
US-ID
Illinois
US-IL
Indiana
US-IN
Kansas
US-KS
Kentucky
US-KY
Louisiana
US-LA
Massachusetts
US-MA
Maryland
US-MD
Maine
US-ME
Michigan
US-MI
Minnesota
US-MN
Missouri
US-MO
Mississippi
US-MS
Montana
US-MT
North Carolina
US-NC
North Dakota
US-ND
Nebraska
US-NE
New Hampshire
US-NH
New Jersey
US-NJ
New Mexico
US-NM
Nevada
US-NV
New York
US-NY
Ohio
US-OH
Oklahoma
US-OK
Oregon
US-OR
Pennsylvania
US-PA
Rhode Island
US-RI
South Carolina
US-SC
South Dakota
US-SD
Tennessee
US-TN
Texas
US-TX
Utah
US-UT
Virginia
US-VA
Vermont
US-VT
Washington
US-WA
Wisconsin
US-WI
West Virginia
US-WV
Wyoming
US-WY

List of currencies with codes:

Currencies
Code
Arab Emirates Dirham
AED
Afghanistan Afghani
AFN
Albanian Lek
ALL
Armenian Dram
AMD
Netherlands Antillean Guilder
ANG
Angolan Kwanza
AOA
Argentine Peso
ARS
Australian Dollar
AUD
Aruban Guilder
AWG
Azerbaijanian Manat
AZN
Konvertibilna Marka
BAM
Barbados Dollar
BBD
Bangladeshi Taka
BDT
Bulgarian Lev
BGN
Bahraini Dinar
BHD
Burundi Franc
BIF
Bermudian Dollar
BMD
Brunei Dollar
BND
Boliviano
BOB
Brazilian Real
BRL
Bahamian Dollar
BSD
Bhutan Ngultrum
BTN
Botswana Pula
BWP
Belarusian Ruble
BYR
Belize Dollar
BZD
Canadian Dollar
CAD
Franc Congolais
CDF
Swiss Franc
CHF
Chilean Peso
CLP
Yuan Renminbi
CNY
Colombian Peso
COP
Costa Rican Colon
CRC
Cuban Peso
CUP
Cape Verde Escudo
CVE
Czech Koruna
CZK
Djibouti Franc
DJF
Danish Krone
DKK
Dominican Peso
DOP
Algerian Dinar
DZD
Egyptian Pound
EGP
Eritrean Nakfa
ERN
Ethiopian Birr
ETB
Euro
EUR
Fiji Dollar
FJD
Falkland Islands Pound
FKP
British Pound
GBP
Georgian Lari
GEL
Gibraltar Pound
GIP
Gambian Dalasi
GMD
Guinea Franc
GNF
Guatemalan Quetzal
GTQ
Guyana Dollar
GYD
Hong Kong Dollar
HKD
Honduran Lempira
HNL
Croatian Kuna
HRK
Haitian Gourde
HTG
Hungarian Forint
HUF
Indonesian Rupiah
IDR
Israeli New Shekel
ILS
Indian Rupee
INR
Iraqi Dinar
IQD
Iranian Rial
IRR
Iceland Krona
ISK
Jamaican Dollar
JMD
Jordanian Dinar
JOD
Japanese Yen
JPY
Kenyan Shilling
KES
Kyrgyzstani Som
KGS
Kampuchean Riel
KHR
Comoros Franc
KMF
North Korean Won
KPW
Korean Won
KRW
Kuwaiti Dinar
KWD
Cayman Islands Dollar
KYD
Kazakhstan Tenge
KZT
Lao Kip
LAK
Lebanese Pound
LBP
Sri Lanka Rupee
LKR
Liberian Dollar
LRD
Lesotho Loti
LSL
Latvian Lats
LVL
Libyan Dinar
LYD
Moroccan Dirham
MAD
Moldovan Leu
MDL
Malagasy Ariary
MGA
Macedonia Denar
MKD
Myanmar Kyat
MMK
Mongolian Tugrik
MNT
Macau Pataca
MOP
Mauritanian Ouguiya
MRO
Mauritius Rupee
MUR
Maldive Rufiyaa
MVR
Malawi Kwacha
MWK
Mexican Nuevo Peso
MXN
Malaysian Ringgit
MYR
New Mozambican Metical
MZN
Namibian Dollar
NAD
Nigerian Naira
NGN
Nicaraguan Cordoba Oro
NIO
Norwegian Krone
NOK
Nepalese Rupee
NPR
New Zealand Dollar
NZD
Omani Rial
OMR
Panamanian Balboa
PAB
Peruvian Nuevo Sol
PEN
Papua New Guinea Kina
PGK
Philippine Peso
PHP
Pakistan Rupee
PKR
Polish Zloty
PLN
Paraguay Guarani
PYG
Qatari Rial
QAR
Romanian Leu
RON
Serbian Dinar
RSD
Russian Ruble
RUB
Rwanda Franc
RWF
Saudi Riyal
SAR
Solomon Islands Dollar
SBD
Seychelles Rupee
SCR
Sudanese Pound
SDG
Swedish Krona
SEK
Singapore Dollar
SGD
St. Helena Pound
SHP
Sierra Leone Leone
SLL
Somali Shilling
SOS
Suriname Dollar
SRD
Sao Tome Dobra
STD
El Salvador Colon
SVC
Syrian Pound
SYP
Swaziland Lilangeni
SZL
Thai Baht
THB
Tunisian Dollar
TND
Tongan Pa’anga
TOP
New Turkish Lira
TRY
Trinidad and Tobago Dollar
TTD
Taiwan Dollar
TWD
Tanzanian Shilling
TZS
Ukrainian Hryvnia
UAH
Ugandan shilling
UGX
United States Dollar
USD
Uruguayan peso
UYU
Uzbekistan Sum
UZS
Venezuelan Bolivar Fuerte
VEF
Vietnamese Dong
VND
Vanuatu Vatu
VUV
Samoan Tala
WST
CFA Franc BEAC
XAF
East Caribbean Dollar
XCD
CFA Franc BCEAO
XOF
CFP Franc
XPF
Yemeni Rial
YER
South African Rand
ZAR
Zambian Kwacha
ZMK

List of languages with codes:

Language
Code
Czech
CS
Danish
DA
German
DE
English
EN
Spanish
ES
Finish
FI
French
FR
Italian
IT
Japanese
JA
Korean
KO
Dutch
NL
Norwegian
NO
Polish
PL
Portuguese
PT
Romanian
RO
Russian
RU
Slovak
SK
Slovenian
SL
Swedish
SV
Turkish
TR
Ukrainian
UK
Chinese Simple
ZH-CHS
Chinese Traditional
ZH-CHT