Developers

API Documentation

Getting started

This information is intended for the person(s) in your company responsible for implementing and integrating the Payzoff API into your systems. Payzoff integration with any merchant system is accomplished via simple HTTP POST commands.

We will confidentially provide you with unique credentials, which will be needed in order to authenticate your company's system with the Payzoff system.

Once your company's system is integrated with Payzoff, the payment process is simplified by using only a simple call. Any refunds or other processes performed are done manually.

Setting Up the account

To integrate your system, you must first register an account with Payzoff. Upon registration, we will provide you with a set of credentials for validation with our system.

Payzoff Payment Process

The following is the process used when a consumer completes a purchase using Payzoff as their payment method.

1. The customer confirms their purchase decision by choosing Payzoff as the payment method on a site.

2. Once Shopper confirms purchase using Payzoff, Merchants must obtain a Payzoff Security code and URL to redirect a shopper to the Payzoff site to complete the payment.

Once the customer has confirmed their purchase, the merchant site will use an obtained code and URL to redirect the customer to the Payzoff site to complete payment. Merchants obtain this code and URL using standard HTTP POST commands. The URL for the POST information for all requests is: https://www.payzoff.com/api/v1.5

Request Data

Variable Desription Example/Value Default Required
api_key Payzoff API key, obtained in the member's profile D78CD7DAF172B2F1B55E19D9DDCE6514 Yes
action Transaction action payment Yes
amount Transaction amount 3.64 Yes
currency Transaction currency in ISO 4217 (see http://en.wikipedia.org/wiki/ISO_4217) USD Yes
seller_transaction_id Seller's unique transaction_id 123433434 Yes
signature md5 hash:
api_key + amount + seller_transaction_id + signature_key
Yes
description Transaction description BMW M6 Gran Coupe
return_url URL where shopper will be redirected from Payzoff if payment was successful1 . http://shopper-domain.com/transaction/ok Yes
result_url URL where shopper will get response from the Payzoff1 . http://shopper-domain.com/transaction/result Yes
fail_url URL where shopper will be redirected from Payzoff if payment was unsuccessful1 . http://shopper-domain.com/transaction/fail Yes
name Payer First and Last name John Doe Yes
method Will use this method. Values are available here and enabled methods you may found in member area -> API configuration -> Payment Methods tab 23 No
country Payer's country. Two lowercase letters. Required if field "method" is not empty uk No
bday Payer birthday day 24 Yes
bmon Payer birthday month 10 Yes
byear Payer birthday year 1990 Yes
transaction_mode 0 - live mode.
1 - testing mode.You will be redirected to dummy method
1 0 No
1. You are required to pass this url unless you set it in your profile

Payzoff Response

You will get response in JSON format, ex:
{"status":"ok","status_code":0,"result":{"secret_code":"cdxbdjnGRv33LkLbtc0pN0qqVAM7xmtzzlNXGAwf", "transaction_id":"8439901933860", "redirect_url":"http:\/\/zirtz\/payment\/confirm\/8439901933860"}}

Variable Desription Example/Value
status Indicates if request fail or ok. ok
status_code Please check all status code's description here 0
result
secret_code Unique transaction code known only to you and Payzoff. Save this value. It will be sent to result_url to verify it is a request from Payzoff. nfiTGXzzgPKv1jy2Aeoq9PYugZBWaLiIO2vZKJCl
transaction_id Payzoff transaction ID 4655302853830
redirect_url Redirect customer to this URL to continue payment process on Payzoff https://payzoff.com/payment/confirm/4655302853830

3. After the customer is redirected to the Payzoff site, they then select their payment method and confirm their payment.

4. Once the payment has been confirmed, the merchant will receive a notification at their result_url. For more information, see here).

The merchant's URL page may be coded in any language, but must accept parameters using HTTP POST standards and respond using standard format. Register the URL under Profile->Notifications in your Payzoff account or pass it along with a transaction request.
Payzoff will POST the following information to the result_url:

Variable Desription Example/Value
transaction_id Payzoff transaction ID 6164701949740
amount Amount to pay 1.56
paid_amount Amount actually paid 1.56
create_date Transaction create date in UNIX stamp format 1404387194
transaction_status Transaction status Complete
secret_code Unique secret transaction code which is only known to you and Payzoff. You must compare it with your records to make sure that the transaction came from Payzoff nfiTGXzzgPKv1jy2Aeoq9PYugZBWaLiIO2vZKJCl
signature Payzoff generates signature for each transaction. Thus you may verify sender source. Concatenate those POST values in following order md5 hash:
api_key + amount + transaction_id + secret_code + seller_transaction_id + signature_key
nfiTGXzzgPKv1jy2Aeoq9PYugZBWaLiIO2vZKJCl
Transaction status "Complete" in conjuncion with status_code "12" is final status and means successful payment.

Refund

Request Data

Here is parameters for the refund request.

Variable Desription Example/Value Default Required
api_key Payzoff API key, obtained in the member's profile D78CD7DAF172B2F1B55E19D9DDCE6514 Yes
action Transaction action refund Yes
amount If need partial refund pass needle mount. 12.23 Parent transaction's amount. Refund will be done in the currency of the parent transaction No
payzoff_transaction_id Payzoff's transaction ID 123433434 Yes
signature md5 hash:
api_key
+ transaction amount
+ transaction currency
+ payzoff_transaction_id
+ signature_key

Pay attantion, signature differs from the payment signature!
Yes

Refund Response

You will get response in JSON format, ex:
{{"status":"ok","status_code":0,"result":{"status":"ok"}}

If result status is "ok" then refund successful, otherwise fail.

Status codes

Status Code Desription
0 No error, request succeful
1 Empty API key. You may obtain it in you Profile
2 API key is invalid. Make sure you put correct API key
3 You are not authorized to perform this action
4 You must pass transaction amount
5 You are only allowed to perform your request via SSL
6 We require seller transaction ID
7 We already got transaction with current transaction ID
8 We require to set return_url, result_url and fail_url
9 We use action to identify what request you are trying to perform
10 Signature is wrong. Make sure you generate correct signature hash
11 We require current code to process payment.

Appendix

Methods by countries

Methods NameMethod ID
Algeria
Ecopayz66
Bitcoin1062
Argentina
Paysafecard109
Daopay58
Pago Facil106
Rapipago118
Red Link122
Provincia Pagos112
Transferencia142
Santander Río128
Astropaycard6
Ecopayz66
Bitcoin1062
Australia
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Volksbanken146
Austria
Paysafecard109
Sofort133
Daopay58
Apothekerbank3
Ärztebank124
Bank Austria35
Bankhaus Krentschker & Co32
Bankhaus Spängler34
BAWAG39
Erste Bank und Sparkassen71
Gartnerbank73
Hypo Alpe Adria81
Hypo Burgenland82
Hypo Niederosterreich83
Hypo80
Hypo Tirol84
Immo-Bank86
PSK Bank115
Raiffeisen117
Schoellerbank129
Sparda Wien136
Sparda-Bank Linz134
Sparda-Bank Villach135
Vorarlberger Landes- und Hypothekenbank148
VR-Bank Braunau149
Ecopayz66
Bitcoin1062
Easybank64
Bankhaus Schelhammer & Schattera33
Albania
Ecopayz66
Bitcoin1062
Bahrain
Daopay58
Ecopayz66
Bitcoin1062
Belarus
Ecopayz66
Bitcoin1062
Belgium
Paysafecard109
Sofort133
Daopay58
Ecopayz66
Bitcoin1062
Bolivia
Astropaycard6
Ecopayz66
Bitcoin1062
Bosnia and Herzegovina
Daopay58
Ecopayz66
Bitcoin1062
Brazil
Daopay58
Boleto Bancário45
Bradesco47
Banco do Brasil21
Caixa49
Banrisul38
HSBC78
Astropaycard6
EBANX65
Ecopayz66
Boleto Bancário46
Bitcoin1062
Banco Itau, S.A.1164
Santander Brasil1167
Banco do Brasil1242
Banco Itau, S.A.1515
Bradesco1308
Santander Brasil1518
Bulgaria
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Canada
Paysafecard109
Daopay58
MoneyGram100
BMO44
TD138
RBC119
Ecopayz66
Bitcoin1062
Chile
Daopay58
Red Compra 121
webpay plus151
Banco de Chile18
Transbank141
Astropaycard6
Ecopayz66
Bitcoin1062
Itau Chile91
Scotiabank Chile130
Santander127
Banco de Chile1149
Banco del Estado1152
Banco Security1155
BBVA Chile40
BICE1158
Banco Corpbanca15
TBANK1161
China
Ecopayz66
Bitcoin1062
Colombia
efecty70
PSE114
Via Baloto145
Banco Cooperativo Coopcentral14
Banco Falabella22
Helm Bank77
Citibank53
Bancoomeva9
Bancolombia8
Banco ProCredit28
Banco Pichincha26
Banco GNB Sudameris23
Banco de Occidente20
Banco de Bogotá17
Banco Davivienda16
Banco Colpatria13
Banco Caja Social11
Banco AV Villas10
Banco Popular27
HSBC Colombia79
Astropaycard6
redpagos120
Ecopayz66
Bitcoin1062
Safetypay Cash126
Efecty Colombia1170
Banco Corpbanca Colombia1173
Banco DAVIVIENDA1176
BBVA Colombia1179
Costa Rica
Banco LAFISE24
Banco Popular27
Banco Cathay12
Teledolar139
Mucap101
Grupo Mutual Alajuela75
Banco Nacional de Costa Rica25
Correos de Costa Rica56
Banco Promerica29
Astropaycard6
Ecopayz66
Bitcoin1062
Safetypay Cash126
Croatia
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Cyprus
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Czech Republic
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Denmark
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Ecuador
Astropaycard6
Ecopayz66
Bitcoin1062
Banco Pichincha Ecuador1182
Egypt
Daopay58
Ecopayz66
Bitcoin1062
Estonia
Daopay58
Ecopayz66
Bitcoin1062
Finland
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
France
Paysafecard109
Sofort133
Daopay58
Ecopayz66
Bitcoin1062
French Guiana
Daopay58
Astropaycard6
Ecopayz66
Bitcoin1062
Germany
Paysafecard109
Sofort133
Daopay58
Micropayment96
Volks und Raiffeisenbanken147
Sparkassen137
PSD-Banken113
Postbank111
MLP-Bank97
Merkur Bank95
GLS Gemeinschaftsbank74
Deutsche Kreditbank (DKB)59
Cronbank57
Comdirect54
Bankhaus Ellwanger & Geiger31
Bankhaus Bauer30
Bank Schilling & Co36
Ecopayz66
Bitcoin1062
Greece
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Guadeloupe
Daopay58
Astropaycard6
Ecopayz66
Bitcoin1062
Hong Kong
Ecopayz66
Bitcoin1062
Hungary
Paysafecard109
Sofort133
Daopay58
Ecopayz66
Bitcoin1062
India
Ecopayz66
Bitcoin1062
Indonesia
gudangvoucher76
Ecopayz66
Bitcoin1062
Iraq
Ecopayz66
Bitcoin1062
Ireland
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Israel
Daopay58
Ecopayz66
Bitcoin1062
Italy
Paysafecard109
Sofort133
Daopay58
Ecopayz66
Bitcoin1062
Japan
Ecopayz66
Bitcoin1062
Jordan
Ecopayz66
Bitcoin1062
Kazakhstan
Ecopayz66
Bitcoin1062
Korea
Ecopayz66
Bitcoin1062
Kuwait
Daopay58
Ecopayz66
Bitcoin1062
Latvia
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Lebanon
Ecopayz66
Bitcoin1062
Lithuania
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Luxembourg
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Malaysia
Ecopayz66
Bitcoin1062
Mauritania
Ecopayz66
Bitcoin1062
Malta
Paysafecard109
Ecopayz66
Bitcoin1062
Mexico
Paysafecard109
Banamex7
Banorte37
Inbursa87
Ixe Banco92
OXXO104
HSBC78
Astropaycard6
Ecopayz66
Bitcoin1062
Safetypay Cash126
Banamex WS Mexico1188
BBVA Bancomer1191
Santander Mexico1194
Scotiabank Mexico1197
Morocco
Daopay58
Ecopayz66
Bitcoin1062
Macedonia
Daopay58
Ecopayz66
Bitcoin1062
Martinique
Daopay58
Astropaycard6
Ecopayz66
Bitcoin1062
Burma (Myanmar)
Ecopayz66
Bitcoin1062
Netherlands
Paysafecard109
Sofort133
Daopay58
ABN AMRO2
ING89
SNS Bank132
ASN Bank4
Friesland Bank72
RegioBank123
Triodos Bank143
Van Lanschot Bankiers144
Ecopayz66
Bitcoin1062
Knab93
Rabobank116
Norway
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Nicaragua
LAFISE Bancentro94
Astropaycard6
Ecopayz66
Bitcoin1062
Safetypay Cash126
New Zealand
Daopay58
Ecopayz66
Bitcoin1062
Oman
Daopay58
Ecopayz66
Bitcoin1062
Pakistan
Ecopayz66
Bitcoin1062
Panama
LAFISE Bancentro94
Astropaycard6
Ecopayz66
Bitcoin1062
Safetypay Cash126
Paraguay
Astropaycard6
Ecopayz66
Bitcoin1062
Peru
Paysafecard109
Pago Efectivo105
Interbank90
Caja Municipal de Trujillo51
Caja Municipal de TACNA50
BBVA Continental42
Banco de Crédito19
Astropaycard6
Ecopayz66
Efectivo Safetypay69
Bitcoin1062
Safetypay Cash126
Scotiabank Peru1185
Philippines
Ecopayz66
Bitcoin1062
Poland
Paysafecard109
Sofort133
Daopay58
Dotpay60
Ecopayz66
Bitcoin1062
Portugal
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Qatar
Daopay58
Ecopayz66
Bitcoin1062
Romania
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Russia
Daopay58
Ecopayz66
Bitcoin1062
Reunion
Daopay58
Ecopayz66
Bitcoin1062
Saudi Arabia
Daopay58
Ecopayz66
Bitcoin1062
Singapore
Ecopayz66
Bitcoin1062
Slovakia
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Slovenia
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Serbia
Daopay58
Ecopayz66
Bitcoin1062
South Africa
Daopay58
Ecopayz66
Bitcoin1062
Spain
Paysafecard109
Sofort133
Daopay58
Ibercaja85
cai48
Ecopayz66
Bitcoin1062
Sweden
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Switzerland
Paysafecard109
Sofort133
Daopay58
Ecopayz66
Bitcoin1062
Tanzania
Ecopayz66
Bitcoin1062
Taiwan
Ecopayz66
Bitcoin1062
Thailand
Ecopayz66
Bitcoin1062
SCB1134
Krungsri1137
UOB Thailand1140
Krung Thai Bank1143
Tunisia
Ecopayz66
Bitcoin1062
Turkey
Paysafecard109
Daopay58
Ecopayz66
Bitcoin1062
Ukraine
Indomog88
Micropayment96
Dotpay60
Astropaycard6
Ecopayz66
Bitcoin1062
Payvision1072
United Arab Emirates
Daopay58
Ecopayz66
Bitcoin1062
United Kingdom
Paysafecard109
Sofort133
Daopay58
Ecopayz66
Bitcoin1062
Great Britain
United States
Openbucks103
Paysafecard109
MoneyGram100
Ecopayz66
Efectivo Safetypay69
Bitcoin1062
Safetypay Cash126
Uruguay
Paysafecard109
Astropaycard6
redpagos120
Ecopayz66
Bitcoin1062
Red Pagos1146
Uzbekistan
Ecopayz66
Bitcoin1062
Venezuela
Astropaycard6
Ecopayz66
Bitcoin1062
Vietnam
Ecopayz66
Bitcoin1062

Php SDK

Download Php SDK

Magento Module

Download and extract the magento module, then copy app/* folder to magento setup.

Download Magento Module