Intended AudienceThis overview document is written for technical people with a background in payments services; and implementing online payment functionality to the e-commerce sites and/or internal ERP systems.
Contact Customer SupportFor problems with transaction processing or your connection to the server, contact Customer Support.
Response ParsingAPI responses by default will be in form of JSON format. You can use any JSON parsing tool or framework to process API responses.
Test EnvironmentAn API test environment means you want to use POS in TEST mode, so it need from you to set your POS in TEST mode from your Payfull App.
API RequestsA request to the Payfull API is made a by sending a POST HTTP request to Payfull API Endpoint URL. Each HTTP POST request send to the API URI should have a set of parameter-value pairs encoded in it, depending of the type of request being sent.
TLS / SSL Security ProtocolOur services allow only the use of TLS 1.1 and TLS 1.2 protocols as required by PCI-DSS rules. Please make sure your application POSTs the data to Payfull URL via these protocols. Otherwise, "Connection will be closed or Connection Closed" mistakes will be taken.
API ResponsesThe API response supports JSON data format. Each response, regardless of the success of the action which is represented by status, will return the ErrorCode and ErrorMSG parameters. Depending on the successfulness of the action the ErrorCode and ErrorMSG can have the specific value pairs. If an error has occurred and the API call is considered to be failed (ErrorCode is not equal to 00) the status, ErrorCode and ErrorMSG parameters will be present in the response.
AuthenticationYou authenticate to the API by providing your user information (secure credentials) in the request. You can manage your API user information from your account or by requesting related change from support team. Every API user have its own merchant and password information. Your merchant and password pair carries many privileges, so be sure to keep them secret!
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate properly for all requests.
Generate Hash CodeFor Each Request, it needs to generate hash code by using merchant password as Shared secret key in customer side.
API will generate same hash in payfull side and compare it with the submitted hash
To generate the hash code please follow the steps below:
- - arrange the parameters alphabetically from A to Z
- - Create a parameters string which has the length for each parameter with its value side by side
- - Create the sha256 hash code from the parameters string and pass the merchant password as Shared secret key
- - Add the hash code to the request parameters
lets say you have the following parameters to send.
- paramB = '4111'
- paramA = '6632009'
- paramC = 'AXCVF'
- parameters string = "7" . "6632009" . "4" . "4111" . "5" . "AXCVF";
- parameters string = "76632009441115AXCVF";
Opensource E-commerce Websites
If you have nopcommerce website and want to have payment gateway, you can use our ready plug-in
For download 3.80
If you have magento website and want to have payment gateway, you can use our ready plug-in
For download 1.9
If you have Prestashop website and want to have payment gateway, you can use our ready plug-in
For download 1.6 v1.6
If you don't want to lose time for the API, you can use our api library.
For Download Click
Tel: 0216 201 13 10
Fax: 0216 201 13 09