Service endpoints
There are two endpoints (base URLs) to which you can make your API calls:
- Stage, if you are testing your integration,
- and Production, when you have finished testing and want your application to go live.
| Environment | Endpoint |
|---|---|
|
Stage |
|
|
Production |
Request parameters
(For further details, please refer to the technical documentation.)
| Format abbreviation | Description |
| AN | Alphanumeric characters (a-z, A-Z, 0-9) |
| A | Alphabetic characters only (a-z, A-Z) |
| N | Numeric characters only |
| R | Decimal number with explicit decimal point, signed |
| JSON | JavaScript Object Notation |
Design and settings elements of the iFrame
| Parameter | Format | Length | Description |
| template | A | 32 | To display the iFrame, set the value: iframe-js |
| time_limit_to_pay | N | - | The time limit to pay allows you to specify the validity period of a payment page in seconds, starting from the moment the payment link (forwardUrl) is generated. If empty, default value is set to 7 days. Maximum value: 24 days |
| css | AN | 255 | URL to the merchant's style sheet Important: HTTPS protocol is required. |
| language | AN | 5 | Set the language of the payment page. Locale code, default to en_GB – English – Great Britain E.g.: fr_FR, es_ES, etc. |
| merchant_display_name | AN | 32 | Merchant's name displayed on the payment page |
| orderid | AN | 32 | ID of the order |
| display_selector | N | 1 |
Enable/disable the payment product selector. Possible values: |
| payment_product_list | AN | 255 |
List of payment products, separated by a “,” (e.g.: visa, mastercard, americanexpress) |
Payment settings
| Field name | Format | Length | Description |
| operation | A | - |
Set the value: |
| eci | N [string] | 1 | Set the value: 7 = e-commerce |
| multi_use | N | 1 | Set the value: 0 = for one-shot payment 1 = in order to re-use the token for a recurring payment |
| description | AN | 128 | Short description of the order |
| long_description | AN | - | Additional description of the order |
| authentication_indicator | N [string] | 1 | Indicate if 3-D Secure authentication should be performed: 0 = Bypass 3-D Secure authentication 1 = 3-D Secure authentication is triggered if the card is enrolled 2 = 3-D Secure authentication is mandatory |
| currency | A | 3 | Base currency for the order (default to EUR) This three-character currency code complies with ISO 4217. |
| amount | R | - | Order total amount |
| shipping | R | - | Shipping fees for the order (default to zero). Can be omitted if the shipping fees value is zero. |
| tax | R | - | Tax amount for the order (default to zero). Can be omitted if the tax amount value is zero. |
| tax_rate | R | - | Tax rate for the order |
| custom_data | JSON | You can use this parameter to submit custom values you wish to show in HiPay's back office transaction details, to receive back in the API response messages and in the notifications or to activate specific anti-fraud rules. E.g.: custom_data => { "shipping_method":"click and collect", "first_order":"0", "products_list":"First product, Second product, Third product"} |
Customer information
| Field name | Format | Length | Description |
| AN | - | Customer's e-mail address | |
| phone | AN |
- | Customer's phone number |
| birthdate | N | 8 | Customer's birthdate (YYYYMMDD) For fraud detection purposes |
| gender | A | 1 |
Gender of the customer: M = male |
| firstname | AN |
- | Customer's first name |
| lastname | AN | - | Customer's last name |
| streetaddress | AN | - | Customer's street address |
| streetaddress2 | AN | - | Additional address information of the customer (e.g.: building, floor, flat, etc.) |
| city | AN | - | Customer's city |
| state | AN | - | State of the country |
| zipcode | AN | - | Zip or postal code of the customer |
| country | A | 2 | Country code of the customer This two-letter country code complies with ISO 3166-1 (alpha 2). |
| shipto_firstname | AN | - | First name of the order's recipient |
| shipto_lastname | AN | - | Last name of the order's recipient |
| shipto_streetaddress | AN | - | Street address where the order is to be shipped |
| shipto_streetaddress2 | AN | - | Additional information about the street address where the order is to be shipped (e.g.: building, floor, flat, etc.) |
| shipto_city | AN | - | City where the order is to be shipped |
| shipto_state | AN | - | State where the order is to be shipped |
| shipto_zipcode | AN | - | Zip or postal code where the order is to be shipped |
| shipto_country | A | 2 |
Country code where the order is to be shipped This two-letter country code complies with ISO 3166-1 (alpha 2). |
| ipaddr | AN | - | Customer's IP address |
| cid | AN | - | Unique customer ID |
| accept_url | AN | URL to redirect your customers to once the payment process is completed successfully | |
| decline_url | AN | URL to redirect your customers to after the acquirer has declined the payment | |
| pending_url | AN | URL to redirect your customers to when the payment request has been submitted to the acquirer, but the response is not available yet | |
| exception_url | AN | URL to redirect your customers to after a system failure | |
| cancel_url | AN | URL to redirect your customers to when they decide to abort the payment |
Commentaires
0 commentaire
Cet article n'accepte pas de commentaires.