Payments
Creates a new customer-initiated payment.
After a payment is created a payment method (card, bank, saved token) must be added to it. The user can attempt adding payment method multiple times until ultimately one is successful. The checkout process is continued by either redirecting the user to the gateway hosted checkout page or integrating directly with EGW APIs.
Additionally, the setupToken fields can be used to save the used payment method for future payments.
This API uses OAuth 2 with the client credentials flow. More info
ID of the request, unique to the call, as determined by the initiating party
Identifies the method or channel through which a payment was initiated:
- BROWSER - payment initiated when the customer makes a regular online purchase via a website (e-shop)
Description of the payment
Merchant's payment reference
Merchant's order number
^[a-zA-Z0-9/-?:().,'+\-]*$Unique ID of the participant
Default country for bank selection in the gateway hosted checkout page
Default locale for the gateway hosted checkout page
Unique ID of the shop
OK
Unique ID of the participant
Unique ID of the payment
Bad Request
Forbidden
Not Found
Conflict
Service Unavailable
POST /egw/{version}/payments/cit HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 1009
{
"basket": {
"items": [
{
"description": "text",
"imageUrl": "text",
"name": "text",
"price": {
"amount": 5877.78,
"currency": "EUR"
},
"quantity": 1,
"sku": "text",
"taxRate": 1,
"totalPrice": {
"amount": 5877.78,
"currency": "EUR"
}
}
],
"salesTaxAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"shippingAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"subtotalAmount": {
"amount": 5877.78,
"currency": "EUR"
}
},
"billingAddress": {
"addressLine1": "text",
"addressLine2": "text",
"city": "text",
"country": "text",
"postalCode": "text",
"state": "text"
},
"channel": "BROWSER",
"customer": {
"email": "name@gmail.com",
"name": "text",
"phone": "text"
},
"description": "text",
"instructedAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"merchantReference": "text",
"orderNumber": "text",
"participantId": "text",
"preferredCountry": "text",
"preferredLocale": "cz",
"setupToken": {
"purposes": [
"CIT"
],
"required": true
},
"shippingAddress": {
"addressLine1": "text",
"addressLine2": "text",
"city": "text",
"country": "text",
"postalCode": "text",
"state": "text"
},
"shopAgreementId": "text",
"shopRedirectUrl": "text"
}{
"_links": {
"checkoutRedirect": {
"href": "text"
}
},
"availablePaymentMethods": [
{
"type": "text"
}
],
"basket": {
"items": [
{
"description": "text",
"imageUrl": "text",
"name": "text",
"price": {
"amount": 5877.78,
"currency": "EUR"
},
"quantity": 1,
"sku": "text",
"taxRate": 1,
"totalPrice": {
"amount": 5877.78,
"currency": "EUR"
}
}
],
"salesTaxAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"shippingAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"subtotalAmount": {
"amount": 5877.78,
"currency": "EUR"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"environment": "SANDBOX",
"instructedAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"orderNumber": "text",
"participantId": "text",
"paymentId": "text",
"paymentStatus": "INITIALIZED",
"shop": {
"agreementId": "text",
"country": "text",
"name": "text"
}
}Creates a new merchant-initiated payment - payment without direct involvement of the end user (e.g. subscriptions).
Only previously saved payment method token can be used for merchant-initiated payments. Before creating merchant-initiated payments it is necessary to setup a token agreement during an initial customer-initiated payment.
This API uses OAuth 2 with the client credentials flow. More info
ID of the request, unique to the call, as determined by the initiating party
Identifies the method or channel through which a payment was initiated:
- RECURRING - payment initiated by the merchant or backend system without customer presence, on a predefined schedule with a fixed or variable amount (e.g., monthly subscription, utility bill)
- MERCHANT - payment initiated by the merchant or backend system without customer presence, on an ad-hoc basis with a variable amount and undefined frequency (e.g., automatic top-up, partial shipments, no-show fees, or other post-service charges)
Description of the payment
Merchant's payment reference
Merchant's order number
^[a-zA-Z0-9/-?:().,'+\-]*$Unique ID of the participant
Unique ID of the shop
OK
Unique ID of the participant
Unique ID of the payment
Bad Request
Forbidden
Not Found
Conflict
Service Unavailable
POST /egw/{version}/payments/mit HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 887
{
"basket": {
"items": [
{
"description": "text",
"imageUrl": "text",
"name": "text",
"price": {
"amount": 5877.78,
"currency": "EUR"
},
"quantity": 1,
"sku": "text",
"taxRate": 1,
"totalPrice": {
"amount": 5877.78,
"currency": "EUR"
}
}
],
"salesTaxAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"shippingAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"subtotalAmount": {
"amount": 5877.78,
"currency": "EUR"
}
},
"billingAddress": {
"addressLine1": "text",
"addressLine2": "text",
"city": "text",
"country": "text",
"postalCode": "text",
"state": "text"
},
"channel": "RECURRING",
"customer": {
"email": "name@gmail.com",
"name": "text",
"phone": "text"
},
"description": "text",
"instructedAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"merchantReference": "text",
"orderNumber": "text",
"participantId": "text",
"shippingAddress": {
"addressLine1": "text",
"addressLine2": "text",
"city": "text",
"country": "text",
"postalCode": "text",
"state": "text"
},
"shopAgreementId": "text"
}{
"_links": {
"checkoutRedirect": {
"href": "text"
}
},
"availablePaymentMethods": [
{
"type": "text"
}
],
"basket": {
"items": [
{
"description": "text",
"imageUrl": "text",
"name": "text",
"price": {
"amount": 5877.78,
"currency": "EUR"
},
"quantity": 1,
"sku": "text",
"taxRate": 1,
"totalPrice": {
"amount": 5877.78,
"currency": "EUR"
}
}
],
"salesTaxAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"shippingAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"subtotalAmount": {
"amount": 5877.78,
"currency": "EUR"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"environment": "SANDBOX",
"instructedAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"orderNumber": "text",
"participantId": "text",
"paymentId": "text",
"paymentStatus": "INITIALIZED",
"shop": {
"agreementId": "text",
"country": "text",
"name": "text"
}
}Returns the content of a payment object
This API uses OAuth 2 with the client credentials flow. More info
Unique ID of the payment
ID of the request, unique to the call, as determined by the initiating party
OK
Identifies the method or channel through which a payment was initiated:
- BROWSER - payment initiated when the customer makes a regular online purchase via a website (e-shop)
- RECURRING - payment initiated by the merchant or backend system without customer presence, on a predefined schedule with a fixed or variable amount (e.g., monthly subscription, utility bill)
- MERCHANT - payment initiated by the merchant or backend system without customer presence, on an ad-hoc basis with a variable amount and undefined frequency (e.g., automatic top-up, partial shipments, no-show fees, or other post-service charges)
- PAYMENT_LINK - payment initiated when the customer clicks a link provided by the merchant (e.g., via a button in an app or website, a link sent via SMS, chat or other messaging channel)
- QR_CODE - payment initiated when the customer scans a QR code presented by the merchant (e.g., in-store or on-screen)
Merchant's payment reference
Merchant's order number
Unique ID of the participant
Unique ID of the payment
Bad Request
Forbidden
Not Found
Conflict
Service Unavailable
GET /egw/{version}/payments/{paymentId}?queryParams=[object+Object] HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
{
"_links": {
"checkoutRedirect": {
"href": "text"
},
"shopRedirect": {
"href": "text"
}
},
"availablePaymentMethods": [
{
"type": "text"
}
],
"basket": {
"items": [
{
"description": "text",
"imageUrl": "text",
"name": "text",
"price": {
"amount": 5877.78,
"currency": "EUR"
},
"quantity": 1,
"sku": "text",
"taxRate": 1,
"totalPrice": {
"amount": 5877.78,
"currency": "EUR"
}
}
],
"salesTaxAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"shippingAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"subtotalAmount": {
"amount": 5877.78,
"currency": "EUR"
}
},
"channel": "BROWSER",
"checkoutBranding": {
"basketItemPlaceholder": "text",
"buttonRadius": "text",
"color": "text",
"disabledOptions": [
"CARD"
],
"font": "text",
"groupOrder": [
"WALLETS"
],
"groupingType": "NO_GROUPING",
"logo": "text",
"logoPlaceholder": "text",
"paymentOptionOrder": [
"CARD"
],
"secondaryColor": "text"
},
"createdAt": "2026-01-01T00:00:00.000Z",
"customer": {
"email": "name@gmail.com",
"name": "text",
"phone": "text"
},
"environment": "SANDBOX",
"instructedAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"merchantReference": "text",
"orderNumber": "text",
"participantId": "text",
"paymentId": "text",
"paymentLinkId": "text",
"paymentMethod": {
"card": {
"brand": "VISA",
"cardholderName": "text",
"expiry": {
"month": "text",
"year": "text"
},
"lastFourDigits": "text"
},
"gatewayTokenId": "text",
"openBanking": {
"bankId": "text",
"iban": "text"
},
"type": "CARD"
},
"paymentStatus": "INITIALIZED",
"preferredCountry": "text",
"refundedAmount": {
"amount": 5877.78,
"currency": "EUR"
},
"shop": {
"agreementId": "text",
"country": "text",
"name": "text"
}
}Capturing an authorized payment will complete (finalise) the payment, this is only used for card payments
This API uses OAuth 2 with the client credentials flow. More info
Unique ID of the payment
ID of the request, unique to the call, as determined by the initiating party
The request for capturing an existing payment
OK
The response after capturing a card payment
Unique ID of the payment
Current status of the payment
Bad Request
Forbidden
Not Found
Conflict
Service Unavailable
PATCH /egw/{version}/payments/{paymentId}/capture HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"instructedAmount": {
"amount": 5877.78,
"currency": "EUR"
}
}{
"paymentId": "text",
"paymentStatus": "INITIALIZED"
}A payment can be cancelled when it is initialized or authorized
This API uses OAuth 2 with the client credentials flow. More info
Unique ID of the payment
ID of the request, unique to the call, as determined by the initiating party
The request for cancelling a payment
Reason to cancel the payment
OK
The response after cancelling a payment
Unique ID of the payment
Current status of the payment
Bad Request
Forbidden
Not Found
Conflict
Service Unavailable
PATCH /egw/{version}/payments/{paymentId}/cancel HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"reason": "SUSPECTED_FRAUD"
}{
"paymentId": "text",
"paymentStatus": "INITIALIZED"
}Last updated
Was this helpful?