Managed Redirect

In order to reduce development effort and simplify the integration of payment methods requiring consumer redirection, you can make a simple API call to request a URL generation, which you can use in the next step to redirect your customers to and let our Hosted Payment Page (HPP) handle the payment process.

1. Create a request to generate a redirect URL

POST a request for redirection URL to https://test.ipg-online.com/ipgrestapi/v2/services/managed-redirect

{
    "requestType": "GenericManagedRedirectRequest",
    "storeId": "123456789",
    "transactionAmount": {
        "total": "15",
        "currency": "EUR"
    },
    "transactionType": "SALE",
    "order": {
        "billing": {
            "name": "Test User",
            "address": {
                "country": "NLD"
            }
        }
    },
    "paymentMethod": {
        "paymentMethodType": "IDEAL_APM"
    }
}

{
    "requestType": "PaymentCardManagedRedirectRequest",
    "storeId": "123456789",
    "transactionAmount": {
        "total": "14",
        "currency": "EUR"
    },
    "transactionType": "SALE",
    "paymentMethod": {
        "paymentCard": {
            "number": "520474******2745",
            "securityCode": "XXX",
            "cardFunction": "CREDIT",
            "expiryDate": {
                "month": "12",
                "year": "28"
            }
        }
    },
    "redirectAttributes": {
        "language": "en",
        "challengeIndicator": "01",
        "authenticateTransaction": true,
      	"fullBypass":false,
      	"threeDSEmvCoMessageCategory":"01",
      	"browserJavaScriptEnabled":true,
      	"threeDSTransactionType":"01",
      	"skipTRA":false
      	
    }
}

{
    "requestType": "SepaSaleManagedRedirectRequest",
    "storeId": "123456789",
    "transactionAmount": {
        "total": "15",
        "currency": "EUR"
    },
    "transactionType": "SALE",
    "order": {
        "billing": {
            "name": "test user",     
            "contact": {
                "email": "[email protected]"
            },     
            "address": {
                "country": "DEU"
            }
        }
    },
    "paymentMethod": {
        "paymentMethodType": "DIRECT_DEBIT_APM",
        "sepa": {
            "iban": "DE02100500000024290661 ",
            "name": "Test User",
            "mandate": {
                "reference": "3RBQVEE",
                "signatureDate": "2023-02-02",
                "type": "RECURRING_COLLECTION"
              
            }
        }
    }
}

2. API response

API response sent back to you from our Gateway contains the parameter redirectURL what generates a hosted payment page for the cardholders to complete their payment.

{
    "clientRequestId": "2838649",
    "apiTraceId": "ZHX-QmIX2yqGEUomhIn1LgAAAEI",
    "requestStatus": "SUCCESS",
    "orderId": "R-04bd455b-d088-41be-a0e3-caa29e076000",
    "redirectURL": "https://test.ipg-online.com/connect/gateway/processing?storename=123456789&oid=R-04bd455b-d088-41be-a0e3-caa29e076000&managedRedirectUrlId=dc6234e3-260e-4b40-a149-cb9fd36b1522",
    "transactionId": "84439061097"
}

Once the process on external pages or forms is complete, hosted payment page redirects the consumer back to the ‘responseSuccessURL’ defined in your account.

Supported local payment methods:

Payment Method Type	Country
`ALIPAY`	China
`BCMC_APM`	Belgium
`DIRECT_DEBIT_APM`	Germany
`EPS`	Austria
`GIROPAY_APM`	Germany
`IDEAL`	Netherlands
`IDEAL_APM`	Netherlands
`KLARNA`	Germany
`KPS`	South Korea
`MYBANK`	Italy
`PAYPAL`	Global
`PAYSAFECARD`	Argentina
`PRZELEWY24`	Poland
`SAFETYPAY`	Brazil
`SBPS_OTHER_PAYMENTS`	Japan
`SOFORT`	Germany
`SOFORT_APM`	Germany
`TRUSTLY`	Finland
`TRUSTPAY`	Europe

1. Create a request to generate a redirect URL

2. API response

Supported local payment methods:

API Products

Point of Sale

Developer

Resources