Skip to content

Payments

Create checkout session

This endpoint generates a URL for a hosted payment page where customers can securely select their preferred payment method and complete their transaction.

Create payment

This endpoint is used to initiate a payment for a specific payment method. You can choose between two integration types:

  • HOSTED: Returns a URL for a payment method-specific hosted form, where the customer is redirected to securely complete the payment.
  • DIRECT: Enables server-to-server communication, where you manage the payment UI and directly interacts with the API to process payments.

Note that not all payment methods support both HOSTED and DIRECT integration types. Some support only one of these options, while others support both. For detailed information about the supported integration types for each payment method, refer to the payment method-specific documentation in our product guide.

Confirm payment

This endpoint is used for payment methods that require a multi-step payment flow. It allows you to confirm a previously created payment instance (initiated via the Create Payment endpoint) to complete the transaction. This step is essential for certain payment methods to finalize the payment process.

Incremental authorization

This endpoint allows you to increase the authorized amount for an existing card transaction when the initial authorization is insufficient. The additional amount is appended to the original authorization, and the total authorized amount reflects both.

Reverse payment

This endpoint is used to reverse a payment that has not yet been captured, effectively canceling the authorization.

Capture payment

This endpoint is used to capture an existing authorized payment.

Refund payment

This endpoint is used to refund a captured payment.

Refund payment without reference

This endpoint is used to refund a payment without reference.

Retrieve payment details by Payment ID

This endpoint is used to retrieve payment details with the Payment ID (payId)

Retrieve payment details by Transaction ID

This endpoint is used to retrieve payment details with the Transaction ID (transId)

Update payment details

This endpoint is used to update payment details

Create checkout session

Request

This endpoint generates a URL for a hosted payment page where customers can securely select their preferred payment method and complete their transaction.

Security
bearer and basic and apiKey
Headers
Idempotency-Keystring

A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.

Bodyapplication/jsonrequired
transIdstring, <= 64 charactersrequired

Transaction ID created in your system. It should be unique for each payment.

externalIntegrationIdstring

External integration identifier

refNrstring

Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually. It is recommended to limit the length to 18 characters so that it works for all payment methods. Allowed characters: (A-Z, a-z) and digits (0-9)

amountobject(amount)required

Test description

languagestring

Language code to determine the language of the payment form and customer communication where applicable. Use 2 letter ISO language codes for common languages such as en for English, de for German, etc. For variations of languages use 5 letter code such as fr-be for French language in Belgium.

captureMethodobject(captureMethod)
credentialOnFileobject(credentialOnFile)
orderobject(order)
simulationModestring

Used to simulate a specific payment success or error use case. Accepts a list of predefined error codes.

urlsobject(urls)required
billingAddressobject(billingAddress)
shippingobject(shipping)
statementDescriptorstring

Short, clear description of the transaction that appears on the customer's statement. It is recommend sending a maximum of 22 characters. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters / - ? : ( ) . , +

customerInfoobject(customerInfo)

Information about the customer.

expirationTimeany, (date-time)

Transaction expiry timestamp (UTC).

fraudDataobject(fraudData)
paymentFacilitatorobject(paymentFacilitator)

Object specifying SubMerchant (Payment Facilitator) details.

browserInfoobject(browserInfo)
deviceobject(device)
channelstring

Specifies the sales or interaction channel through which the transaction is initiated.

Enum:"ECOM""MOTO""APP""PAYBYLINK""POS"
metadataobject

A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Paygate will return the data as it is in the response.

templateobject(sessionTemplate)
allowedPaymentMethodsArray of strings

Indicates list of allowed payment methods that should be shown on the hosted payment page. If not passed default merchant level configuration is used to display the allowed payment methods.

Items Enum:"ALIPAY""BANCONTACT""BANCOMATPAY""BIZUM""BLIK""EPS""CARD""GOOGLEPAY""IDEAL""KLARNA"
partialPaymentboolean

Defines if the payment is a partial payment. Possible values: true or false.

paymentMethodsobject(paymentMethodsSession)
curl -i -X POST \
  -u '<username>:<password>' \
  https://tst.api.smartcollect.ing.com/api/v2/payments/sessions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "transId": "234542353f3452345",
    "amount": {
      "value": 1000,
      "currency": "EUR"
    },
    "urls": {
      "return": "https://my.callback.url.com/return",
      "cancel": "https://my.callback.url.com/cancel",
      "webhook": "https://my.callback.url.com/webhook"
    },
    "template": {
      "name": "ct"
    },
    "allowedPaymentMethods": [
      "CARD",
      "IDEAL",
      "WERO"
    ]
  }'

Responses

Accepted

Bodyapplication/json
Response
{ "_links": { "redirect": { … } } }