Cancel an order.
Requests parameters.
Requests options (you can set default values when creating the client: HipayClientOptions.defaultReqOpts).
Capture an order.
Instruct the payment gateway to capture a previously-authorized transaction, i.e. transfer the funds from the customer's bank account to the merchant's bank account. This transaction is always preceded by an authorization.
Requests parameters.
Requests options (you can set default values when creating the client: HipayClientOptions.defaultReqOpts).
Create a new order.
At the time of payment you must create a new order then redirect the customer to the secure payment page hosted by HiPay. When the customer makes the payment the order is authorized and you can capture it.
Requests parameters.
Requests options (you can set default values when creating the client: HipayClientOptions.defaultReqOpts).
Returns client API endpoint
Returns client environment
Parse Notification (callback) inputs.
After a successful purchase, HiPay calls twice your Notification (callback) URL in background with comprehensive
information about the payment (the first time for the authorization notification and the second one for the
capture notification).
Information are passed through an xml field in the body of an http POST request (of type
application/x-www-form-urlencoded).
This method parses the contents of this xml field and validates the checksum of the request.
Checksum or Signature verification: TODO (wait for HiPay support information about documentations errors)
The value of the field xml (from POST request body)
Refund an order.
Requests parameters.
Requests options (you can set default values when creating the client: HipayClientOptions.defaultReqOpts).
Generated using TypeDoc
Create a new HipayClient.
Get your API credentials (login/password) from the dashboard Toolbox.
Important: If you wan't to use the stage environment (for testing) use the sandbox site: test-professional.hipay.com! Test accounts are validated automatically, just enter random (but valid) information at each step (to validate bank information use Bank Name: "HSBC" and IBAN: "FR7630056009271234567890182").