Payment URL
Creating a Payment URL
Use POST to make a call to /payment-url (see API Reference) such as the example below creates a URL for a sale payment to send to a customer.
{
"transactionAmount": {
"total": "42.42",
"currency": "EUR"
},
"transactionType": "SALE",
"transactionNotificationURL": "https://mywebshop/Customer",
"expiration": "4102358400",
"authenticateTransaction": true,
"dynamicMerchantName": "MyWebsite",
"invoiceNumber": "96126098",
"purchaseOrderNumber": "123055342",
"hostedPaymentPageText": "Dear Customer, please pay our invoice 123456. "
}
{
"clientRequestId": "30dd879c-ee2f-11db-8314-0800200c9a66",
"apiTraceId": "rrt-0bd552c12342d3448-b-ea-1142-12938318-7",
"requestStatus": "SUCCESS",
"orderId": "9723846",
"paymentUrl": "https://hyperlink-to-payment.com",
"transactionId": "2381723322"
}
The value in paymentUrl can then be sent to the customer via your preferred means.
Other Payment URL functions
To delete a Payment URL, add your storeId and the transactionId from the Payment URL creation request response (ipgTransactionId) to the /payment-url header, and use the DELETE method to call the /payment-url API.
You can retrieve the data associated with a payment URL by sending a GET to /paymentURL. Add storeId and the transactionId from the Payment URL creation request response (ipgTransactionId) to the /payment-url header to retrieve the details for a specific Payment URL, or set storeId, fromDate and toDate to call a response with all Payment URLs and their details created within a specific time range.
Payment URL with Recurring payment
For cases where you wish to create a recurring schedule within Payment URL you need to include recurringDetails in the standard Payment URL request.
The following JSON document represents an example of a request with minimal set of elements:
{
"transactionAmount": {
"total": "42.00",
"currency": "EUR"
},
"transactionType": "SALE",
"expiration": "4102358400",
"authenticateTransaction": true,
"dynamicMerchantName": "MyWebsite",
"invoiceNumber": "96126098",
"purchaseOrderNumber": "123055342",
"ip": "264.31.73.24",
"recurringDetails": {
"numberOfPayments": "6",
"frequency": {
"every":"2",
"unit": "DAY"
}
}
}
In the response you will receive generated URL you can pass to your customers:
{
"clientRequestId": "72cb9403-ec27-4edb-90c6-cbf3e1114651",
"apiTraceId": "ZONiu64DB63LI9h0hHnkAwAAAPs",
"requestStatus": "SUCCESS",
"orderId": "R-353a62bb-0139-4576-9ae8-c7579a72cbf3",
"paymentUrl": "https://test.ipg-online.com/connect/gateway/processing?paymentUrlId=1e46b20c-1964-4e8b-803e-7888e330aff3",
"expiration": 4102358400,
"transactionId": "84635479227"
}
Updated 3 months ago
