Execute deposit

Execute deposit

patch

Execute deposit without customer redirection to gateway checkout page. Consult with support team before using this method.

Authorizations

BearerAuth

Path parameters

idstringRequired

Payment Id

Pattern: /[a-zA-Z0-9]{32}/

Body

application/json

customerIpstring · max: 39Required

Customer IP address. Both v4 and v6 addresses are supported.

Example: 152.13.130.125

ipCountryCodestring · min: 2 · max: 2Optional

Country of the specified customer IP address

Example: AU

customerUserAgentstring · max: 512Optional

User agent string for the browser. Equals the navigator.userAgent parameter in JavaScript.

Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36

browserWindowWidthintegerOptional

Browser window width in pixels. Equals the document.body.clientWidth parameter in JavaScript.

Example: 1642

browserWindowHeightintegerOptional

Browser window height in pixels. Equals the document.body.clientHeight parameter in JavaScript.

Example: 883

browserScreenWidthintegerOptional

Screen width in pixels. Equals the screen.width parameter in JavaScript.

Example: 1710

browserScreenHeightintegerOptional

Screen height in pixels. Equals the screen.height parameter in JavaScript.

Example: 1107

browserScreenColorDepthintegerOptional

Screen color depth in bits per pixel. Equals the screen.colorDepth parameter in JavaScript.

Example: 30

browserLanguagestring · max: 32Optional

Language of the navigator. Equals the navigator.language parameter in JavaScript.

Example: en-GB

browserJavaEnabledboolean · max: 39Optional

Indicates if the browser is Java-enabled or not. Equals the navigator.javaEnabled() parameter in JavaScript.

Example: true

browserTimezoneOffsetintegerOptional

Time zone difference, in minutes, from the current locale to UTC. Equals the new Date().getTimezoneOffset() parameter in JavaScript.

Example: -120

Responses

200

Payment Response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/payments/{id} HTTP/1.1
Host: engine-sandbox.convergegate.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "customerIp": "152.13.130.125"
}

{
  "timestamp": "2020-10-07T13:36:32.595+00:00",
  "status": 200,
  "result": {
    "id": "91d27876e87f4b22b3ecd53924bf973d",
    "referenceId": "payment-123",
    "created": "2030-12-25T10:11:12",
    "paymentType": "DEPOSIT",
    "state": "PENDING",
    "description": "Deposit via TEST shop",
    "parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
    "paymentMethod": "BASIC_CARD",
    "paymentMethodDetails": {
      "customerAccountNumber": "400000***0002",
      "cardToken": "3529d42227424875af8722cbf54d7073",
      "cardholderName": "John Doe",
      "cardExpiryMonth": "01",
      "cardExpiryYear": "2030",
      "cardBrand": "VISA",
      "cardIssuingCountryCode": "CY"
    },
    "amount": 11.12,
    "currency": "EUR",
    "customerAmount": 15,
    "customerCurrency": "USD",
    "redirectUrl": "http://start/payment/6ccaa03cb2c242a68ce332f38fedfad7",
    "errorCode": "4.01",
    "errorMessage": "Insufficient Funds",
    "externalResultCode": "03",
    "customer": {
      "referenceId": "customer_123",
      "citizenshipCountryCode": "AU",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "2001-12-03",
      "email": "[email protected]",
      "phone": "357 123123123",
      "locale": "ru",
      "accountNumber": "text",
      "accountName": "text",
      "accountType": "SAVINGS",
      "bank": "text",
      "bankCode": "text",
      "bankBranch": "text",
      "bankBranchCode": "text",
      "documentType": "BR_CPF",
      "documentNumber": "text",
      "routingGroup": "VIP",
      "kycStatus": true,
      "paymentInstrumentKycStatus": true,
      "dateOfFirstDeposit": "2021-01-01",
      "depositsAmount": 5000,
      "withdrawalsAmount": 1000,
      "depositsCnt": 5000,
      "withdrawalsCnt": 1000
    },
    "billingAddress": {
      "addressLine1": "7, Sunny street",
      "addressLine2": "Office 3",
      "city": "Limassol",
      "countryCode": "CY",
      "postalCode": "4141",
      "state": "CA"
    },
    "startRecurring": true,
    "preAuth": true,
    "recurringToken": "text",
    "terminalName": "text",
    "externalFeeAmount": 15,
    "externalFeeCurrency": "USD"
  }
}