HTTP status code 200

Body

Media type: application/json

Type: object

• id: required(integer)

  Gate user id.

  Example:

  1

Example:

{
  "id": 1
}

Secured by authentication

Query Parameters

• project: required(string - pattern: [\w\d]+)

  Your merchant's public key.

  Example:

  f8c295d3d3dcab6ef2720944f152b784

• signature: required(string - pattern: [\w\d]+)

  Request signature. See the Authentication section.

  Example:

  cce8b8ea68ef2f5e6b7b17cafb52b073b93b009029fb73bca5a68ad71ff09547

HTTP status code 200

Body

Media type: application/json

Type: object

• id: required(string - pattern: [\w\d]{64})

  Token ID.

  Example:

  46a41baba257652ba2df481c0947a0ba5f9a586118efd178f2e8781848863aac

• expiresAt: required(string - pattern: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2})

  The date and time when the token expires in the ISO 8601 format.

  Example:

  2018-05-15T08:47:04+00:00

• card: required(object)
  • lastFour: required(string - pattern: [\d]{4})

    Last four digits of a bankcard's number.

    Example:

    3746

  • mask: required(string - pattern: [\d]{6}[\*]{6,9}[\d]{4})

    Bankcard's number mask. Only first six and last four digits are visible, others are hidden with asterisks.

    Example:

    544487******3746

  • type: required(string - pattern: (visa|mastercard|maestro))

    Bankcard's type (e.g. visa, mastercard, maestro).

    Example:

    mastercard

  • expirationMonth: required(integer)

    Bankcard's expiration month, with or without leading zero.

    Example:

    12

  • expirationYear: required(integer)

    Bankcard's expiration year (4 digits).

    Example:

    2034

Example:

{
  "id": "46a41baba257652ba2df481c0947a0ba5f9a586118efd178f2e8781848863aac",
  "expiresAt": "2017-05-15T09:07:04+00:00",
  "card": {
    "lastFour": "3746",
    "mask": "544487******3746",
    "type": "mastercard",
    "expirationMonth": 12,
    "expirationYear": 2034
  }
}

Secured by representation

Query Parameters

• project: required(string - pattern: [\w\d]+)

  Your merchant's public key.

  Example:

  f8c295d3d3dcab6ef2720944f152b784

HTTP status code 200

Body

Media type: application/json

Type: object

• id: required(integer)

  Identifier of a transaction.

  Example:

  1105

• success: required(boolean)

  Indicates whether request has been accepted for processing. If acs object is present indicates whether payment process can be continued.

  Example:

  true

• card: required(object)
  • lastFour: required(string - pattern: [\d]{4})

    Last four digits of a bankcard's number.

    Example:

    3746

  • mask: required(string - pattern: [\d]{6}[\*]{6,9}[\d]{4})

    Bankcard's number mask. Only first six and last four digits are visible, others are hidden with asterisks.

    Example:

    544487******3746

  • type: required(string - pattern: (visa|mastercard|maestro))

    Bankcard's type (e.g. visa, mastercard, maestro).

    Example:

    mastercard

  • expirationMonth: required(integer)

    Bankcard's expiration month, with or without leading zero.

    Example:

    12

  • expirationYear: required(integer)

    Bankcard's expiration year (4 digits).

    Example:

    2034

• acs: (object)

  Parameters (PaReq, MD, TermUrl) that must be passed to bank ACS url as­is using the HTTP POST method.

  • url: required(string - pattern: (https?:\/\/)?([\w\d\.-]+)\.([\w\.]{2,6})([\/\w \.-]*)*\/?)

    URL where user must be redirected using HTTP POST with each parameter from parameters object.

    Example:

    https://bank.example.com/acs

  • parameters: required(object)
    • PaReq: required(string)

      Payer authentication request. Parameter that must be passed to bank ACS.

      Example:

      eJxVUttugkAQ/RXCe9kFLVAzrNHSC00xptomfaQwAVpuLiDYr+8uitpNNpkzlzMzZxfmfZ4pe+R1WhaOqmtUVbAIyygtYkd93z7e2OqcwTbhiO4Gw5YjAx/rOohRSSNHzetY01UG68Ub7hicmJgg0gwgIxQlPEyComEQhLult2LTiWXZEyAnCDlyz2UGPR99YptAjm4oghzZB2ZlE8RABgRh2RYNPzBzKmhGAC3PWNI01YyQruu0/bFGyxGIDAG5TLJupVULqj6NmO8uuuN9oP6vf1h9/xgrN576W88BIjMgChoUI+q31KSGYugzw5oZNpDBD0EuZ2A6pWKrow2VbLG4Clw7QKjJhdjjCiMC7KuyQJEhFDzbEGEdXjQYEJDLDvfPUtuwEXL1n7mVJXWx6ejeeI29u4P79VIt+VNSO1LxIUl2SYViukn1oY0EQCQNOT0mOT20sP59gD9FMLtc

    • MD: required(string)

      Merchant data. Parameter that must be passed to bank ACS and returned from there.

      Example:

      eyJ0cmFuc2Fj

    • TermUrl: required(string - pattern: (https?:\/\/)?([\w\d\.-]+)\.([\w\.]{2,6})([\/\w \.-]*)*\/?)

      Termination url. Payer return url after authentication on bank ACS. Parameter that must be passed to bank ACS.

      Example:

      https://checkout.cauri.com/widget/process/termination

• recurring: (object)
  • id: required(string - pattern: [\w\d]{64})

    Recurring profile token.

    Example:

    b527adb008e276b5f4b452a51ad284e71d39c44d1a0a83a35687b97894aa16ef

  • interval: required(integer)

    Days between recurring payments.

    Example:

    30

  • endsAt: required(string - pattern: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2})

    The last date and time when repeated payments will be available for a user in the ISO 8601 format.

    Example:

    2018-05-15T08:47:04+00:00

• responseCode: (string - pattern: [\w\d]{1,2})

  Response code of a transaction. Required only when success is false.

  Example:

  96

Example:

{
  "id": 1105,
  "success": true,
  "card": {
    "lastFour": "3746",
    "mask": "544487******3746",
    "type": "mastercard",
    "expirationMonth": 12,
    "expirationYear": 2034
  },
  "acs": {
    "url": "https://bank.example.com/acs",
    "parameters": {
      "MD": "eyJ0cmFuc2Fj",
      "PaReq": "eJxdUWF...",
      "TermUrl": "https://merchant.example.com/return"
    }
  },
  "recurring": {
    "id": "b527adb008e276b5f4b452a51ad284e71d39c44d1a0a83a35687b97894aa16ef",
    "interval": 1,
    "endsAt": "2018-05-15T08:47:04+00:00"
  }
}

Secured by authentication

Query Parameters

• project: required(string - pattern: [\w\d]+)

  Your merchant's public key.

  Example:

  f8c295d3d3dcab6ef2720944f152b784

• signature: required(string - pattern: [\w\d]+)

  Request signature. See the Authentication section.

  Example:

  cce8b8ea68ef2f5e6b7b17cafb52b073b93b009029fb73bca5a68ad71ff09547

HTTP status code 200

Body

Media type: application/json

Type: object

• id: required(integer)

  Identifier of a transaction.

  Example:

  1105

• success: required(boolean)

  Indicates whether request has been accepted for processing.

  Example:

  true

• card: required(object)
  • lastFour: required(string - pattern: [\d]{4})

    Last four digits of a bankcard's number.

    Example:

    3746

  • mask: required(string - pattern: [\d]{6}[\*]{6,9}[\d]{4})

    Bankcard's number mask. Only first six and last four digits are visible, others are hidden with asterisks.

    Example:

    544487******3746

  • type: required(string - pattern: (visa|mastercard|maestro))

    Bankcard's type (e.g. visa, mastercard, maestro).

    Example:

    mastercard

  • expirationMonth: required(integer)

    Bankcard's expiration month, with or without leading zero.

    Example:

    12

  • expirationYear: required(integer)

    Bankcard's expiration year (4 digits).

    Example:

    2034

• recurring: (object)
  • id: required(string - pattern: [\w\d]{64})

    Recurring profile token.

    Example:

    b527adb008e276b5f4b452a51ad284e71d39c44d1a0a83a35687b97894aa16ef

  • interval: required(integer)

    Days between recurring payments.

    Example:

    30

  • endsAt: required(string - pattern: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2})

    The last date and time when repeated payments will be available for a user in the ISO 8601 format.

    Example:

    2018-05-15T08:47:04+00:00

• responseCode: (string - pattern: [\w\d]{1,2})

  Response code of a transaction. Required only when success is false.

  Example:

  96

Example:

{
  "id": 1105,
  "success": true,
  "card": {
    "lastFour": "3746",
    "mask": "544487******3746",
    "type": "mastercard",
    "expirationMonth": 12,
    "expirationYear": 2034
  },
  "recurring": {
    "id": "b527adb008e276b5f4b452a51ad284e71d39c44d1a0a83a35687b97894aa16ef",
    "interval": 1,
    "endsAt": "2018-05-15T08:47:04+00:00"
  }
}

Secured by authentication

Query Parameters

• project: required(string - pattern: [\w\d]+)

  Your merchant's public key.

  Example:

  f8c295d3d3dcab6ef2720944f152b784

• signature: required(string - pattern: [\w\d]+)

  Request signature. See the Authentication section.

  Example:

  cce8b8ea68ef2f5e6b7b17cafb52b073b93b009029fb73bca5a68ad71ff09547

HTTP status code 200

Body

Media type: application/json

Type: object

• id: required(integer)

  Identifier of a transaction.

  Example:

  1105

• success: required(boolean)

  Indicates whether request has been accepted for processing.

  Example:

  true

• card: required(object)
  • lastFour: required(string - pattern: [\d]{4})

    Last four digits of a bankcard's number.

    Example:

    3746

  • mask: required(string - pattern: [\d]{6}[\*]{6,9}[\d]{4})

    Bankcard's number mask. Only first six and last four digits are visible, others are hidden with asterisks.

    Example:

    544487******3746

  • type: required(string - pattern: (visa|mastercard|maestro))

    Bankcard's type (e.g. visa, mastercard, maestro).

    Example:

    mastercard

  • expirationMonth: required(integer)

    Bankcard's expiration month, with or without leading zero.

    Example:

    12

  • expirationYear: required(integer)

    Bankcard's expiration year (4 digits).

    Example:

    2034

• responseCode: (string - pattern: [\w\d]{1,2})

  Response code of a transaction. Required only when success is false.

  Example:

  96

Example:

{
  "id": 1105,
  "success": true,
  "card": {
    "lastFour": "3746",
    "mask": "544487******3746",
    "type": "mastercard",
    "expirationMonth": 12,
    "expirationYear": 2034
  }
}

Secured by authentication

Query Parameters

• project: required(string - pattern: [\w\d]+)

  Your merchant's public key.

  Example:

  f8c295d3d3dcab6ef2720944f152b784

• signature: required(string - pattern: [\w\d]+)

  Request signature. See the Authentication section.

  Example:

  cce8b8ea68ef2f5e6b7b17cafb52b073b93b009029fb73bca5a68ad71ff09547

HTTP status code 200

Body

Media type: application/json

Type: object

• success: required(boolean)

  Indicates whether cancellation was successful.

  Example:

  true

Example:

{
  "success": true
}

Secured by authentication

Query Parameters

• project: required(string - pattern: [\w\d]+)

  Your merchant's public key.

  Example:

  f8c295d3d3dcab6ef2720944f152b784

• signature: required(string - pattern: [\w\d]+)

  Request signature. See the Authentication section.

  Example:

  cce8b8ea68ef2f5e6b7b17cafb52b073b93b009029fb73bca5a68ad71ff09547

HTTP status code 200

Body

Media type: application/json

Type: object

• id: required(integer)

  Identifier of a transaction.

  Example:

  1105

• order_id: (string - pattern: [\w\d]{1,64})

  Merchant's order id of a transaction.

  Example:

  179

• description: (string)

  Order description.

  Example:

  Order #179 for Demo Customer

• user: required(string - pattern: .{1,64})

  Unique and unchangeable merchant's identifier of a user.

  Example:

  user@example.com or 2

• price: required(number)

  Order price.

  Example:

  1.73

• earned: (number)

  Amount earned by merchant.

  Example:

  1.68

• currency: required(string - pattern: (USD|EUR|RUB))

  Currency code in the ISO 4217 alfa-3 format.

  Example:

  EUR

• type: required(string - pattern: (payin|return payin|redemption))

  Type of a transaction. See the Transaction types section.

  Example:

  payin

• status: required(string - pattern: (pending|authenticating|paid|fail|refunded|reversed|chargeback))

  Status of a transaction. See the Transaction statuses section.

  Example:

  paid

• error: required(boolean)

  Indicates whether a transaction has error.

  Example:

  false

• sandbox: required(boolean)

  Indicates whether a transaction is processed in testing mode.

  Example:

  true

• auth_code: (string - pattern: [\w\d]{1,6})

  Authorization code of a transaction. Required only for paid payin transactions.

  Example:

  123456

• response_code: (string - pattern: [\w\d]{1,2})

  Response code of a transaction. Required only for failed payin transactions.

  Example:

  96

• can_reverse: required(boolean)

  Indicates whether a transaction can reverse.

  Example:

  false

• can_refund: required(boolean)

  Indicates whether a transaction can refund.

  Example:

  true

• can_partial_refund: required(boolean)

  Indicates whether a transaction can partial refund.

  Example:

  true

• attr_*: (string)

  Any custom attributes, that were passed when payment has been created. Like: attr_realm, attr_server, attr_landing.

  Example:

  attr_server: our-server-1, attr_landing: 123

Example:

{
  "id": 1105,
  "order_id": "179",
  "description": "Order #179 for Demo Custommer",
  "user": "2",
  "price": 1.73,
  "earned": 1.68,
  "currency": "EUR",
  "type": "payin",
  "status": "paid",
  "error": false,
  "sandbox": true,
  "auth_code": "123456",
  "response_code": "0",
  "can_reverse": false,
  "can_refund": true,
  "can_partial_refund": true
}

Secured by authentication

Query Parameters

• project: required(string - pattern: [\w\d]+)

  Your merchant's public key.

  Example:

  f8c295d3d3dcab6ef2720944f152b784

• signature: required(string - pattern: [\w\d]+)

  Request signature. See the Authentication section.

  Example:

  cce8b8ea68ef2f5e6b7b17cafb52b073b93b009029fb73bca5a68ad71ff09547

HTTP status code 200

Body

Media type: application/json

Type: object

• id: required(integer)

  Identifier of a money return transaction.

  Example:

  4551

• success: required(boolean)

  Indicates whether return of money was successful.

  Example:

  true

Example:

{
  "id": 4551,
  "success": true
}

Secured by authentication

Query Parameters

• project: required(string - pattern: [\w\d]+)

  Your merchant's public key.

  Example:

  f8c295d3d3dcab6ef2720944f152b784

• signature: required(string - pattern: [\w\d]+)

  Request signature. See the Authentication section.

  Example:

  cce8b8ea68ef2f5e6b7b17cafb52b073b93b009029fb73bca5a68ad71ff09547

HTTP status code 200

Body

Media type: application/json

Type: object

• id: required(integer)

  Identifier of a money return transaction.

  Example:

  4551

• success: required(boolean)

  Indicates whether return of money was successful.

  Example:

  true

Example:

{
  "id": 4551,
  "success": true
}

Secured by authentication

Query Parameters

• project: required(string - pattern: [\w\d]+)

  Your merchant's public key.

  Example:

  f8c295d3d3dcab6ef2720944f152b784

• signature: required(string - pattern: [\w\d]+)

  Request signature. See the Authentication section.

  Example:

  cce8b8ea68ef2f5e6b7b17cafb52b073b93b009029fb73bca5a68ad71ff09547

HTTP status code 200

Secured by authentication

Query Parameters

• project: required(string - pattern: [\w\d]+)

  Your merchant's public key.

  Example:

  f8c295d3d3dcab6ef2720944f152b784

• signature: required(string - pattern: [\w\d]+)

  Request signature. See the Authentication section.

  Example:

  cce8b8ea68ef2f5e6b7b17cafb52b073b93b009029fb73bca5a68ad71ff09547