Payment URL Call Simulation
PayByBank Process Flow
"Playground"test the APIs
“name”: “Test Test”,
Details of the call above are found in the API interface (section: APIS/Order Services For merchants).
Without the Check Amount Validation
If in the above call, if the amount parameter is not sent, then a request for a Payment Code without amount validation is recorded in active state and a payment code is retrieved. For this payment code, PayByBank can accept an unlimited number of payments without amount check. In this case for each payment received, PayByBank records an ORDER in PAID status. In case a Merchant does not wish to keep receiving payments for a payment code, then he can deactivate the Payment Code request with the cancel call.
The body of the above request will contain an Order object along with the details of the Order (the Order object is described in detail in the API interface, section OBJECTS/Order). Valid statuses for a paid Order: (PAID or COMPLETED).
Order status is changed from PAID to COMPLETED in the following 2 cases:
You have to contact us in order to declare the paymentUrl on your account.
Certification of your implementation on the specific Payment URL your developer has provided. The process is described in detail below:
To activate your Merchant account in Production, we have to certify the correct functionality of the implementation made in the test environment based on the paymentURL that the Merchant(or developer) has declared.
The test is made on this specific Payment URL in order to verify that it is functional. Since the certification is made on this payment URL, then the same payment URL will have to be used in production(if this cannot be done then the same certification will have to also be performed on the production Payment URL)
You will have to necessarily implement below calls:
Additionally the following steps will have to be followed:
You should always check the status of the ORDER that is sent in the HTTP POST. The same paymentURL is used to notify the Merchant in case of rejecting a payment due to payment_code_life expiration with an ORDER status READY_TO_CANCEL (or CANCELLED).
Once the connection is successfully completed then you will need to update the IPs from which the calls will be made (and where the notification will come from) and confirm that the productive URL is the same (and on the same server) as the test url .
* If case the payment url of the production is different from the test then the certification should be repeated (step 2 above). Optionally, you can set a predefined life time for all your orders.
To proceed with this, you will need to inform us of the life time you wish via email otherwise the system default value (720 hours / 30 days) will be used.
Finally when the above steps have been successfully completed then:
PayByBank Plugin: If you have used a plug and play plugin to communicate with PayByBank then the Integration team should certify your productive payment url and then proceed to steps 4 & 5 to receive the Product API Key.
Select the category you want and then then the specific call you will see a full description of the API calls as well as the schema of Requests/Responses
At the same time, in the “Playground” section you can to perform test calls and see the API response according to the request sent. The exact same calls will be used by the developer from the code implementation, so the Playground environment can be used as a first confirmation about the correct implementation.
In the section “Objects” you have the option to see in one place information regarding the Objects returned by the API calls.
Categories and Calls
Α. Account Information retrieval
Β. API Key update. If this call is invoked a new API Key will be returned to you while the previous API Key will not be valid any more.
Β. Retrieval of the merchant Orders with the option to choose one order identification. If the identification field (merchant_order_id) is not filled then all the orders will be retrieved for the specific merchant while additionally the option to provide more than one merchant order ids is given by separating them with a comma character(“,”)(e.g 0001,0002).
With Amount Check Validation (in pending status)
After the placement of a request the Order object you will receive will be in Pending status. After the payment of the order via the Bank (see PayByBank Process Flow)
Without Amount Check Validation (in active state)
If no amount is registered in the request (field Amount) then a payment code request is registered without the amount check validation. With this payment code you can have multiple payments. In this case you have the option to submit or leave blank the merchant_order_id field since this payment code may be used to serve multiple orders. In case you are using one payment code per merchant then you will be able to receive notifications for each payment received by the merchant. On the contrary this fixed payment code may not be applicable for distribution over multiple merchants since you will not be able to distinguish between the payments coming from different merchants.
For each service, you will find in detail:
Supported versions 3.x
Supported versions 1.7.x
Supported versions 3.x – 4.x