Page cover

Webhooks

After a confirmation of a transaction by the external payment system, a notification (Callback) with the final status of the transaction will be sent to the Merchant’s site.

Notification (Callback) - is a POST request, containing information about the results of a successful and unsuccessful operations, which is sent to the special addresses specified by the client and transmits the data of a specific transaction in the form of a set of parameters.

You need to specify the address for callbacks in a letter to the technical support. In addition, you can set different addresses for callbacks about successful and unsuccessful transactions.

The parameter status_id contains transaction status.

Status will be sent repeatedly until json {"result": "ok"} respond received, with periods 45s, 2, 5, 10, 30 minutes, and once per hour during twenty-four hours.

Callback examples

Deposits

Success

{
  "status": x,
  "type": x,
  "external_id": "**",
  "order_id": "**",
  "amount": x,
  "currency": "**",
  "customer_id": "**",
  "signature": "**"
}

Decline

{
  "status": x,
  "type": x,
  "external_id": "**",
  "order_id": "**",
  "amount": x,
  "currency": "**",
  "customer_id": "**",
  "reason_code": "**",
  "reason": "**",
  "signature": "**"
}

Notification parameters

Parameters
Type
Description
Example

status

Enum

Operation status

7

type

Enum

Operation type

2

external_id

String

Order identifier in the merchant's system

example_external_id

order_id

String

Order identifier in the Cabbagino's system

173805987126016235868313296400

amount

Numeric

Amount to be paid in minor units (e.g., for USD - in cents)

10000

currency

ISO 4217 alpha-3

Order currency

USD

customer_id

String

Merchant’s initial ID, returned in callback

307353

reason_code

String

Three-digit error code

001

reason

String

General or detailed decline reason

General decline

signature

String

Request signature, see Request signature generating rules

d9f5713990de5c6e32169dba1f0102f540018975

Balances

Request address

GET https://api.mvpgateways.com/balances/

Headers

{
    "Content-Type": "application/json",
    "MERCHANT_KEY": "***"
}

Merchant key will be provided to you by your Cabbagino manager

Response example

{
    "AZN": {
        "total": 7298202,
        "reserved": 0,
        "sources": [
            {
                "source": "name",
                "amount": 7298202
            }
        ]
    }
}

Last updated