Skip to content

wallet

Top-up of customers' bank accounts and e-wallets by phone number.

Partners providing the service:

spitamen

Parameter Value
Country Tajikistan - TJ
Recipient Номер телефона получателя (account)
Settlement currency TJS

Payer and beneficiary (sender_info, recipient_info)

sender_info

Field Description Requirement
name.first First name required
name.last Family name required
date_of_birth Date of birth, YYYY-MM-DD required
identity_document_type Document kind required
identity_document_number Document series and number required
name.full Full name as in the document (family name first, with a patronymic) used when sent
Example sender_info / recipient_info (JSON)
{
  "sender_info": {
    "party_type": "natural",
    "name": {
      "first": "Ivan",
      "last": "Petrov",
      "full": "Petrov Ivan Sergeevich"
    },
    "date_of_birth": "1990-04-18",
    "identity_document_type": "passport",
    "identity_document_number": "AB1234567"
  }
}

Extra data fields

No extra data fields.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

stub

Stub test adapter. Like a real bank, it requires the payer and the beneficiary in sender_info / recipient_info (see the party profile). Outcomes are driven by the optional control fields below (defaults take the happy path) or, for a sending bank that cannot set them, by the recipient id (case-insensitive): STUB-OK happy path; STUB-NOT-FOUND precheck recipient not found; STUB-PAY-REFUSED Pay refused for good, so core fails the payment; STUB-FAIL postcheck failed; STUB-PENDING postcheck pending forever; STUB-CANCEL-UNSUPPORTED cancel returns payment-not-found; STUB-CANCEL-ELAPSED cancel refused as outside the window (403); STUB-POSTCHECK-FAILS-<n> the first n postchecks fail transiently; STUB-ACCEPT-DELAY-<ms> Pay holds its acceptance that many ms; STUB-CREDIT-DELAY-<ms> postcheck pending until that many ms after Pay; STUB-CREDIT-SHORT-<n> postcheck done but credited n hundredths below amount_debit. Any other recipient takes the happy path. A control field present in data wins over the recipient id.

Parameter Value
Country —
Recipient recipient phone number, or a STUB-* test id (see description)
Settlement currency USD, TJS, KZT

Payer and beneficiary (sender_info, recipient_info)

sender_info

Field Description Requirement
name.first First name required
name.last Family name required
date_of_birth Date of birth, YYYY-MM-DD required
identity_document_type Document kind required
identity_document_number Document series and number required
name.full Full name as in the document (family name first, with a patronymic) used when sent
identity_document_country Issuing country, ISO 3166-1 alpha-2 used when sent
country_of_residence Country of residence, ISO 3166-1 alpha-2 used when sent
address.country Address: country, ISO 3166-1 alpha-2 used when sent
address.city Address: city used when sent
address.street Address: street used when sent
address.building Address: building used when sent
address.postal_code Address: postal code used when sent
address.line Address as free text (up to 7 lines) used when sent

recipient_info

Field Description Requirement
name.first First name required
name.last Family name required
name.full Full name as in the document (family name first, with a patronymic) used when sent
country_of_residence Country of residence, ISO 3166-1 alpha-2 used when sent
Example sender_info / recipient_info (JSON)
{
  "sender_info": {
    "party_type": "natural",
    "name": {
      "first": "Ivan",
      "last": "Petrov",
      "full": "Petrov Ivan Sergeevich"
    },
    "date_of_birth": "1990-04-18",
    "identity_document_type": "passport",
    "identity_document_number": "AB1234567",
    "identity_document_country": "TJ",
    "country_of_residence": "AE",
    "address": {
      "country": "AE",
      "city": "Dubai",
      "street": "Sheikh Zayed Road",
      "building": "1",
      "postal_code": "00000",
      "line": [
        "Sheikh Zayed Road 1, Dubai"
      ]
    }
  },
  "recipient_info": {
    "party_type": "natural",
    "name": {
      "first": "Ivan",
      "last": "Petrov",
      "full": "Petrov Ivan Sergeevich"
    },
    "country_of_residence": "AE"
  }
}

Extra data fields

Field Type Description Example Rules
should_be_success boolean Master switch; false -> payment ends failed at postcheck — —
stub_recipient_found boolean false -> Precheck returns recipient-not-found — —
stub_pay_fails boolean true -> Pay returns a transient error (retried) — —
stub_pay_refused boolean true -> Pay is refused for good (ErrPaymentRejected); core fails the payment — —
stub_accept_delay_ms integer Pay holds its acceptance this many ms; postcheck reports pending meanwhile — minimum 0, maximum 30000
stub_postcheck_status string Overrides the master switch at postcheck — enum done, failed, pending
stub_postcheck_fails integer The first n postchecks of this payment return a transient error (payment stays pending); from call n+1 the normal outcome applies — minimum 0, maximum 1000
stub_credit_short_minor integer A done postcheck reports a credited amount this many hundredths below amount_debit (0: the exact amount_debit) — minimum 0, maximum 1000000
stub_credit_delay_ms integer Postcheck reports pending until this many ms after Pay was called, then the normal outcome — minimum 0, maximum 3600000
stub_waf_block_once boolean The first Pay delivery fails as a protection tool would block it (an HTML 403 page without an error code); the redelivery succeeds — —
stub_echo_correlation boolean false: the bank's answers omit the correlation id (the transfer id) — —
stub_echo_amount string How the bank's answers write back the credited amount: verbatim (empty), with one more decimal place, through float64, or not at all — enum `,rescaled,float,none`
stub_cancellable boolean false -> Cancel returns payment-not-found — —
stub_double_credit boolean true -> a repeated Pay of this transfer credits it again and answers a new payment id STUB--, as a bank that does not deduplicate by Transfer ID would — —
stub_cancel_window_elapsed boolean true -> Cancel is refused as outside the cancellation window (core answers 403) — —
stub_rate number Precheck FX rate, 1 CREDIT = X DEBIT — —
stub_payout_currency string Precheck currency_debit, the payout currency; wins over the requested currency_debit (default: the requested currency_debit, else currency_credit) — —
stub_external_payment_id string Provider payment id returned by Pay (default STUB-) — —
stub_recipient_fee number Precheck: the bank's own fee, borne by the beneficiary — minimum 0
stub_recipient_fee_currency string Precheck: currency of stub_recipient_fee (default: payout currency) — —
stub_quote_ttl_seconds number Precheck: how long the bank honours the quote — minimum 0
data form
Example data (JSON)
{
  "should_be_success": false,
  "stub_recipient_found": false,
  "stub_pay_fails": false,
  "stub_pay_refused": false,
  "stub_accept_delay_ms": 0,
  "stub_postcheck_status": "",
  "stub_postcheck_fails": 0,
  "stub_credit_short_minor": 0,
  "stub_credit_delay_ms": 0,
  "stub_waf_block_once": false,
  "stub_echo_correlation": false,
  "stub_echo_amount": "",
  "stub_cancellable": false,
  "stub_double_credit": false,
  "stub_cancel_window_elapsed": false,
  "stub_rate": 0,
  "stub_payout_currency": "",
  "stub_external_payment_id": "",
  "stub_recipient_fee": 0,
  "stub_recipient_fee_currency": "",
  "stub_quote_ttl_seconds": 0
}
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "description": "Stub test adapter. Like a real bank, it requires the payer and the beneficiary in sender_info / recipient_info (see the party profile). Outcomes are driven by the optional control fields below (defaults take the happy path) or, for a sending bank that cannot set them, by the recipient id (case-insensitive): `STUB-OK` happy path; `STUB-NOT-FOUND` precheck recipient not found; `STUB-PAY-REFUSED` Pay refused for good, so core fails the payment; `STUB-FAIL` postcheck failed; `STUB-PENDING` postcheck pending forever; `STUB-CANCEL-UNSUPPORTED` cancel returns payment-not-found; `STUB-CANCEL-ELAPSED` cancel refused as outside the window (403); `STUB-POSTCHECK-FAILS-<n>` the first n postchecks fail transiently; `STUB-ACCEPT-DELAY-<ms>` Pay holds its acceptance that many ms; `STUB-CREDIT-DELAY-<ms>` postcheck pending until that many ms after Pay; `STUB-CREDIT-SHORT-<n>` postcheck done but credited n hundredths below amount_debit. Any other recipient takes the happy path. A control field present in data wins over the recipient id.",
  "properties": {
    "should_be_success": {
      "type": "boolean",
      "default": true,
      "description": "Master switch; false -> payment ends failed at postcheck"
    },
    "stub_recipient_found": {
      "type": "boolean",
      "default": true,
      "description": "false -> Precheck returns recipient-not-found"
    },
    "stub_pay_fails": {
      "type": "boolean",
      "default": false,
      "description": "true -> Pay returns a transient error (retried)"
    },
    "stub_pay_refused": {
      "type": "boolean",
      "default": false,
      "description": "true -> Pay is refused for good (ErrPaymentRejected); core fails the payment"
    },
    "stub_accept_delay_ms": {
      "type": "integer",
      "minimum": 0,
      "maximum": 30000,
      "default": 0,
      "description": "Pay holds its acceptance this many ms; postcheck reports pending meanwhile"
    },
    "stub_postcheck_status": {
      "type": "string",
      "enum": [
        "done",
        "failed",
        "pending"
      ],
      "description": "Overrides the master switch at postcheck"
    },
    "stub_postcheck_fails": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000,
      "default": 0,
      "description": "The first n postchecks of this payment return a transient error (payment stays pending); from call n+1 the normal outcome applies"
    },
    "stub_credit_short_minor": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000,
      "default": 0,
      "description": "A done postcheck reports a credited amount this many hundredths below amount_debit (0: the exact amount_debit)"
    },
    "stub_credit_delay_ms": {
      "type": "integer",
      "minimum": 0,
      "maximum": 3600000,
      "default": 0,
      "description": "Postcheck reports pending until this many ms after Pay was called, then the normal outcome"
    },
    "stub_waf_block_once": {
      "type": "boolean",
      "default": false,
      "description": "The first Pay delivery fails as a protection tool would block it (an HTML 403 page without an error code); the redelivery succeeds"
    },
    "stub_echo_correlation": {
      "type": "boolean",
      "default": true,
      "description": "false: the bank's answers omit the correlation id (the transfer id)"
    },
    "stub_echo_amount": {
      "type": "string",
      "enum": [
        "",
        "rescaled",
        "float",
        "none"
      ],
      "default": "",
      "description": "How the bank's answers write back the credited amount: verbatim (empty), with one more decimal place, through float64, or not at all"
    },
    "stub_cancellable": {
      "type": "boolean",
      "default": true,
      "description": "false -> Cancel returns payment-not-found"
    },
    "stub_double_credit": {
      "type": "boolean",
      "default": false,
      "description": "true -> a repeated Pay of this transfer credits it again and answers a new payment id STUB-<id>-<n>, as a bank that does not deduplicate by Transfer ID would"
    },
    "stub_cancel_window_elapsed": {
      "type": "boolean",
      "default": false,
      "description": "true -> Cancel is refused as outside the cancellation window (core answers 403)"
    },
    "stub_rate": {
      "type": "number",
      "default": 1,
      "description": "Precheck FX rate, 1 CREDIT = X DEBIT"
    },
    "stub_payout_currency": {
      "type": "string",
      "description": "Precheck currency_debit, the payout currency; wins over the requested currency_debit (default: the requested currency_debit, else currency_credit)"
    },
    "stub_external_payment_id": {
      "type": "string",
      "description": "Provider payment id returned by Pay (default STUB-<transaction id>)"
    },
    "stub_recipient_fee": {
      "type": "number",
      "minimum": 0,
      "description": "Precheck: the bank's own fee, borne by the beneficiary"
    },
    "stub_recipient_fee_currency": {
      "type": "string",
      "description": "Precheck: currency of stub_recipient_fee (default: payout currency)"
    },
    "stub_quote_ttl_seconds": {
      "type": "number",
      "minimum": 0,
      "description": "Precheck: how long the bank honours the quote"
    }
  }
}

zinda

Parameter Value
Country Tajikistan - TJ
Recipient Номер телефона получателя
Settlement currency TJS

Payer and beneficiary (sender_info, recipient_info)

sender_info

Field Description Requirement
name.first First name required
name.last Family name required
date_of_birth Date of birth, YYYY-MM-DD required
identity_document_type Document kind required
identity_document_number Document series and number required
name.full Full name as in the document (family name first, with a patronymic) used when sent

Document kinds accepted: passport

Example sender_info / recipient_info (JSON)
{
  "sender_info": {
    "party_type": "natural",
    "name": {
      "first": "Ivan",
      "last": "Petrov",
      "full": "Petrov Ivan Sergeevich"
    },
    "date_of_birth": "1990-04-18",
    "identity_document_type": "passport",
    "identity_document_number": "AB1234567"
  }
}

Extra data fields

No extra data fields.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}