Mobile application API definition (1.0.0)

Download OpenAPI specification:Download

Authentication

Authenticated

When this is required, request should be made with a authentication token provided by the login route.

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

Permissions

When this is required, the user making the request should have the listed permissions. This is not something added to the request, but a state of the user in the database.

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

PhoneValidationToken

When this is required, the request should be made with a token given by another route requiring a phone number validation by SMS.

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

BankGuarantees

Get user bank guarantees

Get the list of usable or currently used bank guarantees.

Authorizations:

Authenticated

Responses

Response samples

200
401
403
410
500

Content type

application/json

{"code": 0,
"data": [{"id": "string",
"amount": "350.000",
"currency": "string",
"date": "2019-08-24T14:15:22Z",
"being_used": true,
"exp_date": "2019-08-24T14:15:22Z"
}
]
}

Create user bank guarantee

Create a new bank guarantee for the user.

Authorizations:

Authenticated

Request Body schema: application/json

Info about the bank guarantee to create.

amount required	string^\d+\.?\d{0,2}$ Amount of the pre authorization.
currency required	string Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYN" "BYR" "BZD" "CAD" "CDF" "CHF" "CLF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XDR" "XOF" "XPF" "YER" "ZAR" "ZMK" "ZMW" "ZWL" Currency code.
card_id required	string non-empty Identifier of the card on which to make the pre authorization.