API | API Reference

get

Authorizations

AuthorizationstringRequired

Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path parameters

referenceIdstringRequired

Responses

200

OK

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get

/api/v1/api/payments/{referenceId}

GET /api/v1/api/payments/{referenceId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "referenceId": "text",
  "amount": 1,
  "currencyCode": "text",
  "status": "none",
  "customerAction": {
    "type": "none",
    "data": {
      "redirectionUrl": "text",
      "threeDsSessionId": "text",
      "threeDsSessionUrl": "text",
      "httpMethod": "text",
      "targetUrl": "text"
    }
  },
  "merchantMetadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "actualAmount": 1,
  "declineReason": {
    "code": 1,
    "description": "text"
  },
  "createdAt": "2025-12-07T10:00:59.366Z"
}

post

Authorizations

AuthorizationstringRequired

Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

referenceIdstring | nullableRequired

amountinteger · int64Required

currencyCodestring | nullableRequired

descriptionstring | nullableOptional

webhookUrlstring | nullableOptional

Responses

200

OK

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post

/api/v1/api/payments/initiate-session

POST /api/v1/api/payments/initiate-session HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 869

{
  "referenceId": "0197c226-4815-799e-8882-390ff54e971d",
  "amount": 10000,
  "currencyCode": "USD",
  "description": "Payment for product ABC for my client X",
  "customer": {
    "referenceId": "Customer_1",
    "firstName": "Mark",
    "lastName": "Twain",
    "email": "[email protected]",
    "phone": "+447932484444",
    "address": {
      "countryCode": "UK",
      "postalCode": "123",
      "city": "London",
      "addressLine1": ""
    }
  },
  "customerContextDto": null,
  "merchantMetadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "paymentPageSettings": {
    "languageCode": "EN",
    "lifetime": 1800,
    "attemptsAvailable": 5,
    "skipSuccessScreen": false,
    "skipFailureScreen": false,
    "returnUrls": {
      "default": "https://merchant-website.com",
      "success": null,
      "failure": null
    }
  },
  "paymentMethods": [
    "card_basic"
  ],
  "paymentMethodOptions": {
    "cardBasic": {
      "isTwoPhase": false,
      "createToken": false
    }
  },
  "webhookUrl": "http://gate-payment-service.gate.svc.cluster.local:8080/merchant-notification/webhook"
}

{
  "referenceId": "text",
  "amount": 1,
  "currencyCode": "text",
  "status": "none",
  "customerAction": {
    "type": "none",
    "data": {
      "redirectionUrl": "text",
      "threeDsSessionId": "text",
      "threeDsSessionUrl": "text",
      "httpMethod": "text",
      "targetUrl": "text"
    }
  },
  "merchantMetadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "actualAmount": 1,
  "declineReason": {
    "code": 1,
    "description": "text"
  },
  "createdAt": "2025-12-07T10:00:59.366Z"
}

post

Authorizations

AuthorizationstringRequired

Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

referenceIdstring | nullableRequired

amountinteger · int64Required

currencyCodestring | nullableRequired

paymentMethodstring · enumRequiredPossible values:

descriptionstring | nullableOptional

webhookUrlstring | nullableOptional

Responses

200

OK

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post

/api/v1/api/payments/payout

POST /api/v1/api/payments/payout HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1286

{
  "referenceId": "payout-2025-09-29-001",
  "amount": 5000,
  "currencyCode": "USD",
  "paymentMethod": "card_basic",
  "paymentMethodData": {
    "cardBasic": {
      "cardNumber": "4111111111111111",
      "cardHolder": "Mark Twain",
      "expMonth": "12",
      "expYear": "2026",
      "cvv": "123"
    }
  },
  "description": "Payout for affiliate commission",
  "customer": {
    "referenceId": "Customer_1",
    "firstName": "Mark",
    "lastName": "Twain",
    "email": "[email protected]",
    "phone": "+447932484444",
    "address": {
      "countryCode": "UK",
      "postalCode": "123",
      "city": "London",
      "addressLine1": "221B Baker Street"
    }
  },
  "merchantMetadata": {
    "orderId": "ORD-1001",
    "campaign": "AffiliateSeptember"
  },
  "customerContext": {
    "ip": "192.168.1.1",
    "browser": {
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
      "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
      "screenColorDepth": 24,
      "windowHeight": 1080,
      "windowWidth": 1920,
      "screenHeight": 1080,
      "screenWidth": 1920,
      "language": "en-US",
      "javaEnabled": true,
      "javaScriptEnabled": true,
      "timezoneOffset": -120
    },
    "device": {
      "ip": "192.168.1.1",
      "ipCountry": "UK",
      "type": "Desktop",
      "timeZone": "GMT+0",
      "imei": null,
      "mac": "00:1B:44:11:3A:B7",
      "id": "device-001",
      "os": "Windows 10",
      "screenWidth": 1920,
      "screenHeight": 1080,
      "browserLang": "en-US"
    }
  },
  "webhookUrl": "http://gate-payment-service.gate.svc.cluster.local:8080/merchant-notification/webhook"
}

{
  "referenceId": "text",
  "amount": 1,
  "currencyCode": "text",
  "status": "none",
  "customerAction": {
    "type": "none",
    "data": {
      "redirectionUrl": "text",
      "threeDsSessionId": "text",
      "threeDsSessionUrl": "text",
      "httpMethod": "text",
      "targetUrl": "text"
    }
  },
  "merchantMetadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "actualAmount": 1,
  "declineReason": {
    "code": 1,
    "description": "text"
  },
  "createdAt": "2025-12-07T10:00:59.366Z"
}

post

Authorizations

AuthorizationstringRequired

Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

referenceIdstring | nullableRequired

amountinteger · int32Required

currencyCodestring | nullableRequired

Responses

200

OK

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post

/api/v1/api/payments/refund

POST /api/v1/api/payments/refund HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "referenceId": "refund-2025-09-29-001",
  "amount": 2500,
  "currencyCode": "USD"
}

{
  "referenceId": "text",
  "amount": 1,
  "currencyCode": "text",
  "status": "none",
  "customerAction": {
    "type": "none",
    "data": {
      "redirectionUrl": "text",
      "threeDsSessionId": "text",
      "threeDsSessionUrl": "text",
      "httpMethod": "text",
      "targetUrl": "text"
    }
  },
  "merchantMetadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "actualAmount": 1,
  "declineReason": {
    "code": 1,
    "description": "text"
  },
  "createdAt": "2025-12-07T10:00:59.366Z"
}

post

Authorizations

AuthorizationstringRequired

Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

referenceIdstring | nullableRequired

descriptionstring | nullableOptional

amountinteger · int64Required

currencyCodestring | nullableRequired

paymentMethodstring · enumOptionalPossible values:

webhookUrlstring | nullableOptional

Responses

200

OK

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post

/api/v1/api/payments

POST /api/v1/api/payments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1711

{
  "referenceId": "0197c226-4815-799e-8882-390ff54e971d",
  "description": "Payment for product ABC for my client X",
  "amount": 10000,
  "currencyCode": "USD",
  "merchantMetadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "customer": {
    "referenceId": "Customer_1",
    "firstName": "Mark",
    "lastName": "Twain",
    "email": "[email protected]",
    "phone": "+447932484444",
    "address": {
      "countryCode": "UK",
      "postalCode": "123",
      "city": "London",
      "addressLine1": ""
    }
  },
  "paymentMethod": "card_basic",
  "paymentMethodData": {
    "cardBasic": {
      "cardNumber": "5555555555554444",
      "cardHolder": "IVAN IVANOV",
      "expMonth": "11",
      "expYear": "2029",
      "cvv": "123"
    }
  },
  "paymentMethodOptions": {
    "cardBasic": {
      "isTwoPhase": false,
      "createToken": false
    }
  },
  "customerContext": {
    "ip": "203.0.113.42",
    "browser": {
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36",
      "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8",
      "screenColorDepth": 24,
      "windowHeight": 900,
      "windowWidth": 1440,
      "screenHeight": 1080,
      "screenWidth": 1920,
      "language": "ru-RU",
      "javaEnabled": false,
      "javaScriptEnabled": true,
      "timezoneOffset": -180
    },
    "device": {
      "ip": "203.0.113.42",
      "ipCountry": "FI",
      "type": "Desktop",
      "timeZone": "Europe/Helsinki",
      "imei": null,
      "mac": "02:42:AC:11:00:02",
      "id": "9f1d8b57-5f2a-4e0a-92b6-2f6a1e1d9c0a",
      "os": "Windows 11 Pro 23H2",
      "screenWidth": 1920,
      "screenHeight": 1080,
      "browserLang": "ru-RU"
    }
  },
  "paymentPageSettings": {
    "languageCode": "en",
    "lifetime": 1800,
    "attemptsAvailable": 10,
    "skipSuccessScreen": false,
    "skipFailureScreen": false,
    "returnUrls": {
      "default": "https://merchant-website.com",
      "success": null,
      "failure": null
    }
  },
  "webhookUrl": "http://gate-payment-service.gate.svc.cluster.local:8080/merchant-notification/webhook"
}

{
  "referenceId": "text",
  "amount": 1,
  "currencyCode": "text",
  "status": "none",
  "customerAction": {
    "type": "none",
    "data": {
      "redirectionUrl": "text",
      "threeDsSessionId": "text",
      "threeDsSessionUrl": "text",
      "httpMethod": "text",
      "targetUrl": "text"
    }
  },
  "merchantMetadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "actualAmount": 1,
  "declineReason": {
    "code": 1,
    "description": "text"
  },
  "createdAt": "2025-12-07T10:00:59.366Z"
}

Good morning