ICEX1 API
Download ICEPAY ICEX1 API Postman collection
Checksum header
All our API endpoints are secured by a Checksum header.
In the postman collection you’ll find a pre-request script with a Javascript example.
Payment methods
Use the getmypaymentmethods endpoint to load your payment methods. This API will return a list of available payment methods and issuers.
*It's also possible to hardcode payment methods and issuers in your implementation.
Create transaction
The checkout endpoint is used to create a simple payment.
Request
| Variable | Information |
|---|---|
| Timestamp | |
| Amount | In cents |
| Country | |
| Currency | |
| Description | |
| Issuer | |
| Language | |
| OrderID | Must be unique + maxium 10 characters |
| PaymentMethod | |
| Reference | for non-unique identifiers. |
| URLCompleted | Where a customer gets sent after the payment has been completed. Use these landing pages to inform the customer but not to change the internal order status. |
| URLError | Where a customer gets sent after the payment has been aborted. Use these landing pages to inform the customer but not to change the internal order status. |
| URLPostback | Use this URL to change the internal order status. |
| EndUserIP |
Response
This API endpoint will return a PaymentID, which you can later use in the Postback WebHooks or refund request.
Payment methods and issuers examples
Below contains a sample of PaymentMethodCode and IssuerKeyword that can be used.
Note that these can also be received through the getmypaymentmethods endpoint.
| Payment method | PaymentMethodCode | IssuerKeyword |
|---|---|---|
| iDEAL | IDEAL | IDEAL |
| PayPal | PAYPAL | DEFAULT |
| Online Überweisen | ONLINEUBERWEISEN | DEFAULT |
Refunds
If an order needs to be refunded the requestrefund api endpoint can be used.
PaymentID is what you should have gotten from the checkout endpoint.
Postback
We will notify you of the latest payment status on all URLs in the URLPostback array.
This can be a maximum of 3 URLs. Use this for your E-commerce system to update the order status and optionally, for example, to update CRM or bookkeeping software.