API docs by Redocly

NoName API (2.0.0)

Download OpenAPI specification:

Balance

Get balance of Merchant's account.

Get account balance

Get balance of Merchant's account

Authorizations:
(TokenRequestBodySignature)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Payment instruments

Getting available payment instruments version 2.

Get available payment instruments by merchant id

Returns the list of available payment instruments for the specified merchant.

Authorizations:
(TokenRequestBodySignature)
query Parameters
limit
string
Example: limit=10

The maximum number of records to return.

offset
string
Example: offset=20

The number of records to skip.

payment_types
Array of strings
Example: payment_types=card2card&payment_types=sbp

Filter results by one or more payment types.

currencies
Array of strings
Example: currencies=USD,RUB

Filter results by one or more currency codes.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Common

Getting information by ID transaction or ID transaction merchant system.

Get transaction by ID

Retrieves information about a specific transaction by ID.

Authorizations:
(TokenRequestBodySignature)
path Parameters
transaction_id
required
string

The unique identifier of the transaction to retrieve.

Responses

Response samples

Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "processing",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "card2card",
  • "financial_institution": {
    },
  • "requisites": {
    },
  • "customer": {
    },
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "amounts": {
    }
}

Get transaction by ID merchant

Retrieves information about a specific transaction by ID transaction merchant system

Authorizations:
(TokenRequestBodySignature)
path Parameters
external_id
required
string

The unique identifier of the transaction in merchant system to retrieve.

Responses

Response samples

Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "processing",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "card2card",
  • "financial_institution": {
    },
  • "requisites": {
    },
  • "customer": {
    },
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "amounts": {
    }
}

H2H Sync Deposit Funds

Synchronous Host to Host workflow to process funds deposit operation version 2.

Workflow step by step

  • Step 1. Create order (is required).
  • Optional Step. Confirm transfer.
  • Optional Step. Cancel transfer.

Create transaction (deposit)

Creates a new transaction within the P2P protocol (deposit).

Authorizations:
(TokenRequestBodySignature)
query Parameters
process
required
string
Value: "h2h"
Example: process=h2h

Transaction operation mode

Request Body schema: application/json
required
external_id
required
string

external_id in merchant system

payment_type
required
string

Payment Type for transaction

object

Financial Institute. For example "bank"

description
string

Description for payout

required
object
callback_url
string <uri>

Callback URL

required
object

Responses

Callbacks

Request samples

Content type
application/json
Example
{
  • "external_id": "449bc546-e589-4aca-83fd-b41c2e03fbde",
  • "payment_type": "card2card",
  • "customer": {
    },
  • "amounts": {
    }
}

Response samples

Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "processing",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "card2card",
  • "financial_institution": {
    },
  • "requisites": {
    },
  • "customer": {
    },
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "amounts": {
    }
}

Callback payload samples

Callback
POST: Callback to the URL previously specified in the request body
Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "success",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "card2card",
  • "description": "test deposit",
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "fees": [
    ],
  • "amounts": {
    }
}

Confirm transaction by ID

Confirms the transaction by its identifier using a confirmation code (e.g., OTP).

Authorizations:
(TokenRequestBodySignature)
path Parameters
transactionId
required
string

The unique identifier of the transaction to confirm.

Request Body schema: application/json
optional
confirm_code
string

The confirmation code value (e.g., OTP, etc.)

confirm_type
string

Type of confirmation (e.g., OTP)

Responses

Request samples

Content type
application/json
{
  • "confirm_code": "1111",
  • "confirm_type": "OTP"
}

Response samples

Content type
application/json
{
  • "error": "invalid_request",
  • "error_description": "Invalid request syntax. Make sure your request matches the example in the documentation."
}

Confirm transaction by ID merchant

Confirms the transaction by its identifier in the system merchant using a confirmation code (e.g., OTP).

Authorizations:
(TokenRequestBodySignature)
path Parameters
external_id
required
string

The unique identifier of the transaction in the system merchant to confirm.

Request Body schema: application/json
optional
confirm_code
string

The confirmation code value (e.g., OTP, etc.)

confirm_type
string

Type of confirmation (e.g., OTP)

Responses

Request samples

Content type
application/json
{
  • "confirm_code": "1111",
  • "confirm_type": "OTP"
}

Response samples

Content type
application/json
{
  • "error": "invalid_request",
  • "error_description": "Invalid request syntax. Make sure your request matches the example in the documentation."
}

Cancel transaction by ID

Cancels the transaction by its identifier. Can only be used for transactions in a cancellable state.

Authorizations:
(TokenRequestBodySignature)
path Parameters
transactionId
required
string

The unique identifier of the transaction to cancel.

Request Body schema: application/json
required
reason
string

description about cancel

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "cancelled by customer",
  • "reason": "cancelled by customer",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "card2card",
  • "financial_institution": {
    },
  • "description": "string",
  • "requisites": {
    },
  • "customer": {
    },
  • "callback_url": "http://example.com",
  • "amounts": {
    }
}

Cancel transaction by ID merchant

Cancels the transaction by its identifier in the system merchant. Can only be used for transactions in a cancellable state.

Authorizations:
(TokenRequestBodySignature)
path Parameters
external_id
required
string

The unique identifier of the transaction to cancel.

Request Body schema: application/json
required
reason
string

description about cancel

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "cancelled by customer",
  • "reason": "cancelled by customer",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "card2card",
  • "financial_institution": {
    },
  • "description": "string",
  • "requisites": {
    },
  • "customer": {
    },
  • "callback_url": "http://example.com",
  • "amounts": {
    }
}

H2H Sync Withdraw Funds

Synchronous Host to Host workflow to process funds withdrawal operation version 2.

Workflow step by step

  • Step 1. Create order (is required).

Create transaction (payout)

Creates a new transaction within the P2P protocol (payout).

Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json
required
external_id
required
string

external_id in merchant system

payment_type
required
string

Payment Type for transaction

object

Financial Institute. For example "bank"

description
string

Description for payout

required
object
required
object
callback_url
string <uri>

Callback URL

required
object

Responses

Callbacks

Request samples

Content type
application/json
Example
{
  • "external_id": "449bc546-e589-4aca-83fd-b41c2e03fbde",
  • "payment_type": "bank_account_number",
  • "financial_institution": {
    },
  • "requisites": {
    },
  • "customer": {
    },
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "amounts": {
    }
}

Response samples

Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "processing",
  • "external_id": "449bc546-e589-4aca-83fd-b41c2e03fbde",
  • "payment_type": "bank_account_number",
  • "financial_institution": {
    },
  • "requisites": {
    },
  • "customer": {
    },
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "amounts": {
    }
}

Callback payload samples

Callback
POST: Callback to the URL previously specified in the request body
Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "success",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "card2card",
  • "description": "test deposit",
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "fees": [
    ],
  • "amounts": {
    }
}

Redirect Sync Deposit Funds

Redirect workflow to process funds deposit operation version 2.

Workflow step by step

  • Step 1. Create order (is required).

Create transaction (deposit)

Creates a new transaction within the P2P protocol with redirection to the payment form (deposit).

Authorizations:
(TokenRequestBodySignature)
query Parameters
process
required
string
Value: "redirect"
Example: process=redirect

Transaction operation mode

Request Body schema: application/json
required
external_id
required
string

external_id in merchant system

payment_type
required
string

Payment Type for transaction

object

Financial Institute. For example "bank"

description
string

Description for payout

required
object
callback_url
string <uri>

Callback URL

object
required
object

Responses

Callbacks

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
Example
{}

Callback payload samples

Callback
POST: Callback to the URL previously specified in the request body
Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "success",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "card2card",
  • "description": "test deposit",
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "fees": [
    ],
  • "amounts": {
    }
}

Common

Getting information by ID transaction or ID transaction merchant system.

Get transaction by ID

Retrieves information about a specific transaction by ID.

Authorizations:
(TokenRequestBodySignature)
path Parameters
transaction_id
required
string

The unique identifier of the transaction to retrieve.

Responses

Response samples

Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "processing",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "ecom_local_all",
  • "requisites": {
    },
  • "customer": {
    },
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "amounts": {
    }
}

Get transaction by ID merchant

Retrieves information about a specific transaction by ID transaction merchant system

Authorizations:
(TokenRequestBodySignature)
path Parameters
external_id
required
string

The unique identifier of the transaction in merchant system to retrieve.

Responses

Response samples

Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "processing",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "ecom_local_all",
  • "requisites": {
    },
  • "customer": {
    },
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "amounts": {
    }
}

H2H Ecom Deposit Funds

Host-to-host workflow for processing ecom type deposit transaction version 2.

Transaction creation is only possible for the following payment types:

  • ecom_local_all: is sent if the card data input form and the 3DS code input form are implemented in the merchant's system. In this case, the 3DS code is mandatorily sent via the API using the "Confirm" method.

  • ecom_local_card: is sent if the card data input form is implemented in the merchant's system, but the 3DS code input form is absent. In this case, after successful transaction creation, the response will contain a link to an external 3DS code input form.

    Workflow step by step

    • Step 1. Creation of the ecom order (required).
    • Step 2. Confirmation of the transfer. Depending on the specified payment_type:
      • ecom_local_all - by the "Confirm" method (required).
      • ecom_local_card - client enters the code manually on the external 3DS input form from the response

Create ecom transaction (deposit)

Creates a new transaction within the Ecom protocol (deposit).

Authorizations:
(TokenRequestBodySignature)
query Parameters
process
required
string
Value: "h2h"
Example: process=h2h

Transaction operation mode

Request Body schema: application/json
required
external_id
required
string <uuid>

external_id in merchant system

payment_type
required
string

Ecom Payment Type for transaction

required
object
description
string

Description

required
object
required
object
callback_url
string <uri>

Callback URL

Responses

Callbacks

Request samples

Content type
application/json
Example
{
  • "external_id": "449bc546-e589-4aca-83fd-b41c2e03fbde",
  • "payment_type": "ecom_local_all",
  • "customer": {
    },
  • "amounts": {
    },
  • "requisites": {
    },
  • "callback_url": "https://merchant-side.com/send-status-here"
}

Response samples

Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "waiting for confirmation",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "ecom_local_all",
  • "requisites": {
    },
  • "customer": {
    },
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "amounts": {
    }
}

Callback payload samples

Callback
POST: Callback to the URL previously specified in the request body
Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "success",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "ecom_local_all",
  • "description": "test deposit",
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "fees": [
    ],
  • "amounts": {
    }
}

Confirm transaction by ID merchant

Confirms a transaction by its identifier in the merchant's system (e.g. 3ds). Transaction confirmation is only available in the "waiting for confirmation" status and is required for payment_type: ecom_local_all

Authorizations:
(TokenRequestBodySignature)
path Parameters
external_id
required
string

The unique identifier of the transaction in the system merchant to confirm.

Request Body schema: application/json
optional
confirm_code
string

The confirmation code value

confirm_type
string

Type of confirmation (e.g., 3ds)

Responses

Request samples

Content type
application/json
{
  • "confirm_code": "1111",
  • "confirm_type": "3ds"
}

Response samples

Content type
application/json
{
  • "error": "invalid_request",
  • "error_description": "Invalid request syntax. Make sure your request matches the example in the documentation."
}

Confirm transaction by ID

Confirms a transaction by its identifier (e.g. 3ds). Transaction confirmation is only available in the "waiting for confirmation" status and is required for payment_type: ecom_local_all

Authorizations:
(TokenRequestBodySignature)
path Parameters
transaction_id
required
string

The unique identifier of the transaction to confirm.

Request Body schema: application/json
optional
confirm_code
string

The confirmation code value

confirm_type
string

Type of confirmation (e.g., 3ds)

Responses

Request samples

Content type
application/json
{
  • "confirm_code": "1111",
  • "confirm_type": "3ds"
}

Response samples

Content type
application/json
{
  • "error": "invalid_request",
  • "error_description": "Invalid request syntax. Make sure your request matches the example in the documentation."
}

Redirect Ecom Deposit Funds

Redirect workflow for processing ecom type deposit transaction version 2.

Transaction creation is only possible for the following payment types:

  • ecom_platform_all: is sent if the card data input form and the 3DS code input form are not implemented in the merchant's system, and the NoName platform forms are used.

  • ecom_platform_card: is sent if the card data input form and the 3DS code input form are not implemented in the merchant's system, and the NoName platform's card data input form along with a third-party 3DS code input form are used.

  • ecom_noname: is sent for payment by card in ecom RUB

    Workflow step by step

    • Step 1. Creation of the ecom order (required).

Create ecom transaction (deposit)

Creates a new transaction within the Ecom protocol (deposit).

Authorizations:
(TokenRequestBodySignature)
query Parameters
process
required
string
Value: "redirect"
Example: process=redirect

Transaction operation mode

Request Body schema: application/json
required
external_id
required
string <uuid>

external_id in merchant system

payment_type
required
string

Ecom Payment Type for transaction

required
object
description
string

Description

required
object
callback_url
string <uri>

Callback URL

object

Responses

Callbacks

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
Example
{}

Callback payload samples

Callback
POST: Callback to the URL previously specified in the request body
Content type
application/json
Example
{
  • "transaction_id": "4b41beef-748f-4776-9463-04d85a8de2d4",
  • "created_at": "2025-07-31T09:48:34.572Z",
  • "status": "success",
  • "external_id": "449bc546-e589-4aca-83fd-287150955133",
  • "payment_type": "ecom_platform_all",
  • "description": "test deposit",
  • "callback_url": "https://merchant-side.com/send-status-here",
  • "fees": [
    ],
  • "amounts": {
    }
}

Accounts

Account operations.

Get account balance

Get balance of Merchant's account

Authorizations:
(TokenRequestIdRequestIdSignature)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

H2H Sync Deposit Funds

Synchronous Host to Host workflow to process funds deposit operation version 1 (not supported).

Workflow step by step

  • Preliminary Step. Get available payment instruments (is optional).
  • Step 1. Create order (is required).
  • Step 2. Confirm transfer (is optional).

Order status changed Webhook

A webhook request sending order status changes.

Public RSA key of Moneygate System is:

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtFSx1aPxesUTi83VE68+
NLLIzaIUnZ9XU2E2Zl9NttnnJ5t8Rhv1UkcsAf1dPL4W0KcNVkoOexlJD4xGxI88
3GuQ+ol3wFv8heLf76JhB8yuvtz/qqHF+zMM9BPyr+hPdMwMDSzkAuC//9Bo/L6q
C0whrzNw1FRCw3XWNe6gAwJpecPF2kHxIr+m5XEWuXDVSjCQIA2fctj6iWthZTsu
skYeZa49r1SpLU4NKFwgZ9soxT8eldZz4dW2q6O3buGLWraaPju3jBA9YYGdvKHw
Si5XxYtoSjmpqqykWMizCWd7PcsQCffcO6QP4zU19l3Ef30+AZ5wFb328NTSQj8w
WQIDAQAB
-----END PUBLIC KEY-----
Authorizations:
RequestBodySignature
Request Body schema: application/json
id
required
string

Order ID in Merchant's system

blowfish_id
required
string

Order ID in Moneygate system

status_code
required
integer
Enum: 4 5 6 7 8 9 10

Payment order status codes:

  • -1 - not found in the system
  • 1 - registered
  • 2 - pending
  • 3 - processing
  • 4 - success (is final)
  • 5 - other errors (is final)
  • 6 - error, no traders found (is final)
  • 7 - error, order amount does not meet the limits (is final)
  • 8 - (deposit orders only) cancelled by customer (is final)
  • 9 - error, order has expired (is final)
  • 10 - dispute
status
required
string

Order status text

object

Responses

Request samples

Content type
application/json
{
  • "id": "449bc546-e589-4aca-83fd-453260574467",
  • "blowfish_id": "700d6b67-de3a-4357-94a7-63b66527f99e",
  • "amount": 50000,
  • "currency": "RUB",
  • "status": "success",
  • "status_code": 4
}

Get payment instruments

Preliminary Step

This step is optional.

Get a list of possible payment instruments.

You can skip this step if you have defined the values of properties: payment_type and bank.

The next step is :

  • to create order to deposit funds using the redirect protocol (is required).
Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json

Request body

currency
string

Currency alphabetic code according to ISO 4217

Responses

Request samples

Content type
application/json
Example
{
  • "currency": "RUB"
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    }
}

Create order

Step 1

This step is required.

Create order to deposit funds using the synchronous host-to-host protocol.

Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json

Request body

id
string

Order ID, generated in the merchant's system. Unique within their system

service_id
integer

Service ID

object

Responses

Request samples

Content type
application/json
Example
{
  • "id": "449bc546-e589-4aca-83fd-b41c2e03fbde",
  • "data": {
    }
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "id": "449bc546-e589-4aca-83fd-287150955133",
  • "data": {
    }
}

Confirm transfer

Step 2.

This step is optional.

You can skip this step for deposit order. Then the order will be considered executed upon confirmation by the trader.

This API function should be called after the transfer of funds by a customer.

Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json

Request body

id
required
string

Order ID in Merchant system

object

Responses

Request samples

Content type
application/json
Example
{
  • "id": "449bc546-e589-4aca-83fd-b41c2e03fbde"
}

Response samples

Content type
application/json
{
  • "success": true
}

Cancel order

Auxiliary Endpoint

This API endpoint cancel an order.

Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json

Request body

id
required
string

Order ID in Merchant System

Responses

Request samples

Content type
application/json
{
  • "id": "449bc546-e589-4aca-83fd-b41c2e03fbde"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get order status

Auxiliary Endpoint

This API endpoint returns current order status and trader requisites.

Moneygate System also supports status transmission by callbacks (if property callback_url has been set on Step 1).

Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json

Request body

id
required
string

Order ID in Merchant System

Responses

Request samples

Content type
application/json
{
  • "id": "449bc546-e589-4aca-83fd-b41c2e03fbde"
}

Response samples

Content type
application/json
Example
{
  • "id": "O-123-321",
  • "status": "not found in the system",
  • "status_code": -1
}

H2H Sync Withdraw Funds

Synchronous Host to Host workflow to process funds withdrawal operation version 1 (not supported).

Workflow step by step

  • Preliminary Step. Get available payment instruments (is optional).
  • Step 1. Create order (is required).

Create order

Step 1

This step is required.

Create order to withdrawal funds using the synchronous host-to-host protocol.

Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json

Request body

id
required
string

Order ID, generated in the merchant's system. Unique within their system

required
object

Responses

Request samples

Content type
application/json
Example
{
  • "id": "449bc546-e589-4aca-83fd-b41c2e03fbde",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "id": "449bc546-e589-4aca-83fd-387498270450",
  • "data": {
    }
}

Get order status

Auxiliary Endpoint

This API endpoint returns current order status and trader requisites.

Moneygate System also supports status transmission by callbacks (if property callback_url has been set on Step 1).

Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json

Request body

id
required
string

Order ID in Merchant System

Responses

Request samples

Content type
application/json
{
  • "id": "449bc546-e589-4aca-83fd-b41c2e03fbde"
}

Response samples

Content type
application/json
Example
{
  • "id": "O-123-321",
  • "status": "not found",
  • "status_code": -1
}

Redirect Deposit Funds

Redirect workflow to process funds deposit operation version 1 (not supported).

Workflow step by step

  • Preliminary Step. Get available payment instruments (is optional).
  • Step 1. Create order (is required).

Order status changed Webhook

A webhook request sending order status changes.

Public RSA key of Moneygate System is:

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtFSx1aPxesUTi83VE68+
NLLIzaIUnZ9XU2E2Zl9NttnnJ5t8Rhv1UkcsAf1dPL4W0KcNVkoOexlJD4xGxI88
3GuQ+ol3wFv8heLf76JhB8yuvtz/qqHF+zMM9BPyr+hPdMwMDSzkAuC//9Bo/L6q
C0whrzNw1FRCw3XWNe6gAwJpecPF2kHxIr+m5XEWuXDVSjCQIA2fctj6iWthZTsu
skYeZa49r1SpLU4NKFwgZ9soxT8eldZz4dW2q6O3buGLWraaPju3jBA9YYGdvKHw
Si5XxYtoSjmpqqykWMizCWd7PcsQCffcO6QP4zU19l3Ef30+AZ5wFb328NTSQj8w
WQIDAQAB
-----END PUBLIC KEY-----
Authorizations:
RequestBodySignature
Request Body schema: application/json
id
required
string

Order ID in Merchant's system

blowfish_id
required
string

Order ID in Moneygate system

status_code
required
integer
Enum: 4 5 6 7 8 9 10

Payment order status codes:

  • -1 - not found in the system
  • 1 - registered
  • 2 - pending
  • 3 - processing
  • 4 - success (is final)
  • 5 - other errors (is final)
  • 6 - error, no traders found (is final)
  • 7 - error, order amount does not meet the limits (is final)
  • 8 - (deposit orders only) cancelled by customer (is final)
  • 9 - error, order has expired (is final)
  • 10 - dispute
status
required
string

Order status text

object

Responses

Request samples

Content type
application/json
{
  • "id": "449bc546-e589-4aca-83fd-453260574467",
  • "blowfish_id": "700d6b67-de3a-4357-94a7-63b66527f99e",
  • "amount": 50000,
  • "currency": "RUB",
  • "status": "success",
  • "status_code": 4
}

Get payment instruments

Preliminary Step

This step is optional.

Get a list of possible payment instruments.

You can skip this step if you have defined the values of properties: payment_type and bank.

The next step is :

  • to create order to deposit funds using the redirect protocol (is required).
Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json

Request body

currency
string

Currency alphabetic code according to ISO 4217

Responses

Request samples

Content type
application/json
Example
{
  • "currency": "RUB"
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    }
}

Create order

Step 1

This step is required. Create order to deposit funds using the redirect protocol.

Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json

Request body

id
required
string

Order ID. Generated by the merchant's system

service_id
integer

Service ID

required
object

Responses

Request samples

Content type
application/json
Example
{
  • "id": "449bc546-e589-4aca-83fd-b41c2e03fbde",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "id": "449bc546-e589-4aca-83fd-278763832861",
  • "data": {}
}

Get order status

Auxiliary Endpoint

This API endpoint returns current order status and trader requisites.

Moneygate System also supports status transmission by callbacks (if property callback_url has been set on Step 1).

Authorizations:
(TokenRequestBodySignature)
Request Body schema: application/json

Request body

id
required
string

Order ID in Merchant System

Responses

Request samples

Content type
application/json
{
  • "id": "449bc546-e589-4aca-83fd-b41c2e03fbde"
}

Response samples

Content type
application/json
Example
{
  • "id": "O-123-321",
  • "status": "not found in the system",
  • "status_code": -1
}