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.
INITIATING A DIRECT DEBIT TRANSACTION AFTER CREATING A DEBIT AGREEMENT
Request parameters
Please note: Bacs Direct Debit is only available in the United Kingdom for transactions in pounds sterling (GBP).
To initiate a Bacs Direct Debit transaction on the HiPay Enterprise Payment Gateway, you must first create a debit agreement.
To do so, you must send the following mandatory/complementary parameters in your debit agreement creation call through the debit-agreement API.
(For further details, please refer to the technical documentation.)
Then you must send the following mandatory/complementary parameters in your transaction creation call through the order API.
Request example (debit-agreement API)
{
gender:M
firstname:John
lastname:Doe
payment_product:bacs
currency:GBP
authentication_indicator:0
account_number:12345678
account_branch_code:200321
streetaddress:123 Main Street
email:test@ddress.com
zipcode:AA99 9AA
city:ANY CITY
country:GB
} Response example (debit-agreement API)
0
success
Debit agreement has been successfully created.
1234567
1234
available
2019-02-07T18:22:51+0100
Z10101234567890
2019-02-07T17:22:51.8765432Z
M
John
Doe
123 Main Street
AA99 9AA
ANY CITY
test@address.com
GB
12345678
200321
Request example (order API)
{
currency:GBP
payment_product:bacs
orderid:
amount:359.98
description:bacs stage
country:GB
decline_url:https://www.mysite.com/decline
pending_url:https://www.mysite.com/pending
exception_url:https://www.mysite.com/exception
cancel_url:https://www.mysite.com/cancel
accept_url:https://www.mysite.com/accept
operation:authorization
debit_agreement_id:1234567
firstname:John
lastname:Doe
streetaddress:123 Main Street
city:ANY CITY
zipcode: AA99 9AA
} Response example (order API)
completed
true
00001234567
1
800000654321
2019-02-07T17:27:38+0000
2019-02-07T18:27:39+0100
142
Authorization Requested
0.00
0.00
0.00
0.00
2
GBP
0.0.0.0
7
bacs
0
ACCEPTED
1234567890
2019-02-07T17:27:38+0000
1
359.98
0.00
0.00
2
GBP
en_US
INITIATING A DIRECT DEBIT TRANSACTION WITHOUT ANY EXISTING DEBIT AGREEMENT
You can also initiate a Bacs Direct Debit transaction without any existing debit agreement.
To do so, you must send the following mandatory/complementary parameters through the order API.
Please note: this API does not accept iban/bic values.
Request example (order API)
{
currency:GBP
payment_product:bacs
orderid:
amount:100
description: bacs stage test
country:GB
decline_url:https://www.mysite.com/decline
pending_url:https://www.mysite.com/pending
exception_url:https://www.mysite.com/exception
cancel_url:https://www.mysite.com/cancel
accept_url:https://www.mysite.com/accept
operation:sale
eci:7
gender:M
firstname:John
lastname:Doe
streetaddress:123 Main Street
streetaddress2:Any building
email:test@ddress.com
zipcode:AA99 9AA
city:ANY CITY
payment_product_parameters:{"account_number":"87654321","account_branch_code":"200321"}
} Response example (order API)
completed
true
00001234567
1
800000654321
2019-02-11T10:57:19+0000
2019-02-11T11:57:20+0100
142
Authorization Requested
0.00
0.00
0.00
0.00
2
GBP
0.0.0.0
7
bacs
0
ACCEPTED
1234567890
2019-02-11T10:57:19+0000
1
100.00
0.00
0.00
2
GBP
en_US
test@ddress.com
