Payments

get

Authorizations

AuthorizationstringRequired

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

Path parameters

referenceIdstringRequired

Responses

200

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get

/api/v1/payments/{referenceId}

GET /api/v1/payments/{referenceId} HTTP/1.1
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": "2026-02-01T11:14:10.895Z"
}

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

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post

/api/v1/payments/initiate-session

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

{
  "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": ""
    }
  },
  "customerContext": 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": "2026-02-01T11:14:10.895Z"
}

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

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post

/api/v1/payments/payout

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

{
  "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",
    "deviceInfo": 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": "2026-02-01T11:14:10.895Z"
}

post

Authorizations

AuthorizationstringRequired

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

Body

referenceIdstring · nullableRequired

amountinteger · int32Required

currencyCodestring · nullableRequired

Responses

200

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post

/api/v1/payments/refund

POST /api/v1/payments/refund HTTP/1.1
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": "2026-02-01T11:14:10.895Z"
}

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

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post

/api/v1/payments

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

{
  "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",
    "deviceInfo": {
      "deviceId": "9f1d8b57-5f2a-4e0a-92b6-2f6a1e1d9c0a",
      "siteKey": "demo",
      "ts": 1739698800456,
      "perfMs": 126,
      "env": {
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 15_6_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36",
        "platform": "MacIntel",
        "product": "Gecko",
        "languages": [
          "en-US",
          "en"
        ],
        "timezone": "Europe/Helsinki",
        "doNotTrack": "1",
        "webdriver": false,
        "cookieEnabled": true,
        "referrer": "https://merchant.io/checkout",
        "url": "https://merchant.io/checkout/payment",
        "screen": {
          "width": 2560,
          "height": 1600,
          "colorDepth": 24,
          "pixelRatio": 2
        },
        "deviceMemory": 8,
        "hardwareConcurrency": 10
      },
      "storage": {
        "localStorage": true,
        "sessionStorage": true,
        "indexedDb": true
      },
      "perms": {
        "geolocation": "prompt",
        "notifications": "granted",
        "push": "prompt",
        "camera": "denied",
        "microphone": "denied",
        "clipboardRead": "unknown",
        "clipboardWrite": "granted"
      },
      "canvas": {
        "hash": "3cf0b7a1d81f96c7d4a99512b5e8f3a49e1b2f67df1e7b321c58029ff98ad3ea",
        "sample": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
      },
      "webgl": {
        "supported": true,
        "vendor": "Google Inc.",
        "renderer": "ANGLE (AMD Radeon Pro 5600M, Metal-accelerated)",
        "maxTextureSize": 16384
      },
      "audio": {
        "supported": true,
        "hash": "e18f71397e9fa93b24a21904a45a6c74f7ab6ec0ff6928ee2d2a3b7e9bcd302f"
      },
      "battery": {
        "battery": {
          "charging": true,
          "level": 0.92
        },
        "connection": {
          "effectiveType": "4g",
          "downlink": 8.7,
          "rtt": 60
        }
      },
      "plugins": {
        "plugins": [
          {
            "name": "Chrome PDF Viewer",
            "description": "Portable Document Format",
            "filename": "internal-pdf-viewer"
          }
        ],
        "mimeTypes": [
          {
            "type": "application/pdf",
            "description": "Portable Document Format",
            "suffixes": "pdf"
          }
        ]
      },
      "fonts": {
        "Arial": true,
        "Roboto": true,
        "Times New Roman": true,
        "Noto Sans": false,
        "Courier New": true
      },
      "quirks": {
        "floatPrecision": "3.14159265359",
        "mathPow": 9007199254740992,
        "taToString": "1,2,3"
      },
      "media": [
        {
          "kind": "videoinput",
          "label": "FaceTime HD Camera (Built-in)",
          "deviceId": "ab12cd34"
        },
        {
          "kind": "audioinput",
          "label": "MacBook Pro Microphone",
          "deviceId": "ef56gh78"
        }
      ],
      "vis": {
        "hidden": false,
        "visibilityState": "visible",
        "hasFocus": true
      },
      "sdk": {
        "name": "df-agent-full",
        "version": "1.0.0"
      }
    }
  },
  "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": "2026-02-01T11:14:10.895Z"
}

PreviousAPI Preface NextModels

Last updated 1 month ago