nurmuhammet/tbbank-react-native-mobile
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
tbbank-react-native-mobile/resources/openapi.json

7242 lines
192 KiB
JSON
Raw Permalink Blame History

{
"openapi": "3.1.0",
"info": {
"title": "TBBANK",
"version": "0.0.1"
},
"servers": [
{
"url": "https://online.tbbank.gov.tm/api"
}
],
"tags": [
{
"name": "1. App enums"
},
{
"name": "Sargytlar - Karz - Karz sargytlary Mobile"
},
{
"name": "Sargytlar - Karz - Karzyň galyndysy"
},
{
"name": "Sargytlar - Karz - Karzyň ýapylandygy barada güwanama"
},
{
"name": "Sargytlar - Kart - Täze kart"
},
{
"name": "Sargytlar - Kart - Kart hereketleri"
},
{
"name": "Sargytlar - Kart - Kart rekwizitler"
},
{
"name": "Sargytlar - Kart - Kart galyndylary"
},
{
"name": "Sargytlar - Kart - Kart pin bukjalar"
}
],
"security": [
{
"http": []
}
],
"paths": {
"/base-app-enums": {
"get": {
"operationId": "baseAppEnum.index",
"description": "`System` -daky esasy bolup biljek `Maglumatlar`, köplenç `Select` -larda ulanylýar.",
"summary": "Base app enums",
"tags": [
"1. App enums"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"loan_types": {
"anyOf": [
{
"type": "object"
},
{
"type": "array",
"items": {}
}
]
},
"regions": {
"type": "array",
"prefixItems": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
],
"minItems": 7,
"maxItems": 7,
"additionalItems": false
},
"educations": {
"type": "array",
"prefixItems": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
],
"minItems": 3,
"maxItems": 3,
"additionalItems": false
},
"marriage_statuses": {
"type": "array",
"prefixItems": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
],
"minItems": 5,
"maxItems": 5,
"additionalItems": false
},
"passport_series": {
"type": "array",
"prefixItems": [
{
"type": "string",
"enum": [
"I-AS"
]
},
{
"type": "string",
"enum": [
"I-MR"
]
},
{
"type": "string",
"enum": [
"II-MR"
]
},
{
"type": "string",
"enum": [
"I-AH"
]
},
{
"type": "string",
"enum": [
"II-AH"
]
},
{
"type": "string",
"enum": [
"I-LB"
]
},
{
"type": "string",
"enum": [
"II-LB"
]
},
{
"type": "string",
"enum": [
"I-BN"
]
},
{
"type": "string",
"enum": [
"II-BN"
]
},
{
"type": "string",
"enum": [
"I-DZ"
]
},
{
"type": "string",
"enum": [
"II-DZ"
]
}
],
"minItems": 11,
"maxItems": 11,
"additionalItems": false
},
"card_types": {
"anyOf": [
{
"type": "object"
},
{
"type": "array",
"items": {}
}
]
},
"card_states": {
"anyOf": [
{
"type": "object"
},
{
"type": "array",
"items": {}
}
]
}
},
"required": [
"loan_types",
"regions",
"educations",
"marriage_statuses",
"passport_series",
"card_types",
"card_states"
]
}
}
}
}
}
}
},
"/alerts": {
"get": {
"operationId": "alert.index",
"description": "`Alert`-lar, dine api dereje gosulyar, `mobile app`-lar dine `GET` edip alyp gorkezip bilyarler `app`-a girende.",
"summary": "Get alerts for user",
"tags": [
"Alert"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/alerts-all": {
"get": {
"operationId": "alert.all",
"summary": "All alerts",
"tags": [
"Alert"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/auth/register": {
"post": {
"operationId": "apiAuth.register",
"summary": "(Auth) Register user",
"tags": [
"ApiAuth"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthRegisterRequest"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/auth/login": {
"post": {
"operationId": "apiAuth.login",
"summary": "(Auth) Login",
"tags": [
"ApiAuth"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthLoginRequest"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/auth/verify": {
"post": {
"operationId": "apiAuth.verify",
"summary": "(Auth) Verify the code",
"tags": [
"ApiAuth"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthVerifyRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"token": {
"type": "string"
},
"message": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/ProfileResponse"
}
},
"required": [
"success",
"token",
"message",
"user"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/auth/delete-user": {
"post": {
"operationId": "apiAuth.delete",
"summary": "(Auth)* Delete user",
"tags": [
"ApiAuth"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"enum": [
"user deleted successfully"
]
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/branches": {
"get": {
"operationId": "branch.index",
"description": "Bank şahamçalary. http://online.tbbank.gov.tm/work-place/resources/branches",
"summary": "LIST branches",
"tags": [
"Branch"
],
"parameters": [
{
"name": "groupBy",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"enum": [
"region"
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/contact-us": {
"post": {
"operationId": "contactUs.store",
"summary": "Store contact us message",
"tags": [
"ContactUs"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Message Title",
"example": "Salam",
"maxLength": 255
},
"message": {
"type": "string",
"description": "Message content",
"example": "Bet app",
"maxLength": 255
}
},
"required": [
"title",
"message"
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/metrics": {
"get": {
"operationId": "metrics.index",
"summary": "Metrics",
"tags": [
"Metrics"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"loanOrders": {
"type": "string"
},
"acceptedLoanOrders": {
"type": "string"
},
"deniedLoanOrders": {
"type": "string"
}
},
"required": [
"loanOrders",
"acceptedLoanOrders",
"deniedLoanOrders"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/profile": {
"get": {
"operationId": "profile.index",
"summary": "Get user profile",
"tags": [
"Profile"
],
"responses": {
"200": {
"description": "`ProfileResponse`",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "profile.store",
"summary": "Update user profile",
"tags": [
"Profile"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserProfileRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/provinces": {
"get": {
"operationId": "province.index",
"summary": "LIST provinces (etraplar)",
"tags": [
"Province"
],
"parameters": [
{
"name": "groupBy",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"enum": [
"region"
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/card-balance-quick-check": {
"get": {
"operationId": "cardBalance.quickCheck",
"summary": "Quick card balance check",
"tags": [
"Sargytlar - Kart - Kart galyndylary"
],
"parameters": [
{
"name": "passport_serie",
"in": "query",
"schema": {
"type": "string",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
]
},
"example": "I-AS"
},
{
"name": "passport_id",
"in": "query",
"schema": {
"type": "number"
},
"example": 379514
},
{
"name": "card_number",
"in": "query",
"schema": {
"type": "string"
},
"example": "9934612100000243"
},
{
"name": "card_month",
"in": "query",
"schema": {
"type": "string",
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12"
]
},
"example": "12"
},
{
"name": "card_year",
"in": "query",
"schema": {
"type": "string",
"enum": [
"2024",
"2025",
"2026",
"2027",
"2028",
"2029",
"2030",
"2031",
"2032",
"2033",
"2034",
"2035",
"2036",
"2037",
"2038",
"2039",
"2040",
"2041",
"2042",
"2043",
"2044",
"2045",
"2046",
"2047",
"2048",
"2049",
"2050",
"2051",
"2052",
"2053",
"2054",
"2055",
"2056",
"2057",
"2058",
"2059",
"2060",
"2061",
"2062",
"2063",
"2064",
"2065",
"2066",
"2067",
"2068",
"2069",
"2070",
"2071",
"2072",
"2073",
"2074",
"2075",
"2076",
"2077",
"2078",
"2079",
"2080",
"2081",
"2082",
"2083",
"2084",
"2085",
"2086",
"2087",
"2088",
"2089",
"2090"
]
},
"example": "2049"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"data": {
"type": "object"
}
},
"required": [
"status",
"data"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
},
"url": {
"type": "string",
"enum": [
""
]
}
},
"required": [
"status",
"message",
"url"
]
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/card-balances": {
"get": {
"operationId": "cardBalance.index",
"summary": "LIST*",
"tags": [
"Sargytlar - Kart - Kart galyndylary"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "cardBalance.store",
"summary": "SAVE*",
"tags": [
"Sargytlar - Kart - Kart galyndylary"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"passport_serie": {
"type": "string",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"example": 379514
},
"card_number": {
"type": "string",
"example": "9934612100000243"
},
"card_month": {
"type": "string",
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12"
],
"example": "12"
},
"card_year": {
"type": "string",
"enum": [
"2024",
"2025",
"2026",
"2027",
"2028",
"2029",
"2030",
"2031",
"2032",
"2033",
"2034",
"2035",
"2036",
"2037",
"2038",
"2039",
"2040",
"2041",
"2042",
"2043",
"2044",
"2045",
"2046",
"2047",
"2048",
"2049",
"2050",
"2051",
"2052",
"2053",
"2054",
"2055",
"2056",
"2057",
"2058",
"2059",
"2060",
"2061",
"2062",
"2063",
"2064",
"2065",
"2066",
"2067",
"2068",
"2069",
"2070",
"2071",
"2072",
"2073",
"2074",
"2075",
"2076",
"2077",
"2078",
"2079",
"2080",
"2081",
"2082",
"2083",
"2084",
"2085",
"2086",
"2087",
"2088",
"2089",
"2090"
],
"example": "2049"
}
},
"required": [
"passport_serie",
"passport_id",
"card_number",
"card_month",
"card_year"
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/card-balances/{order}": {
"get": {
"operationId": "cardBalance.show",
"description": "ID ugradyp alyan route -da. Soň page-da download button bolmaly, basaňdan soň, modal çykmaly, start date bilen end date ugradyp download basanda `/api/card-transactions-download/{order}` route gelyan pdf download etmeli.",
"summary": "SHOW*",
"tags": [
"Sargytlar - Kart - Kart galyndylary"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardBalance"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
},
"post": {
"operationId": "cardBalance.update",
"description": "ID ugradyp `route`-da update edip bilyan. Base App Enum-lardan peydalan. Panelkadan gor.",
"summary": "UPDATE*",
"tags": [
"Sargytlar - Kart - Kart galyndylary"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"passport_serie": {
"type": "string",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"example": 379514
},
"card_number": {
"type": "string",
"example": "9934612100000243"
},
"card_month": {
"type": "string",
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12"
],
"example": "12"
},
"card_year": {
"type": "string",
"enum": [
"2024",
"2025",
"2026",
"2027",
"2028",
"2029",
"2030",
"2031",
"2032",
"2033",
"2034",
"2035",
"2036",
"2037",
"2038",
"2039",
"2040",
"2041",
"2042",
"2043",
"2044",
"2045",
"2046",
"2047",
"2048",
"2049",
"2050",
"2051",
"2052",
"2053",
"2054",
"2055",
"2056",
"2057",
"2058",
"2059",
"2060",
"2061",
"2062",
"2063",
"2064",
"2065",
"2066",
"2067",
"2068",
"2069",
"2070",
"2071",
"2072",
"2073",
"2074",
"2075",
"2076",
"2077",
"2078",
"2079",
"2080",
"2081",
"2082",
"2083",
"2084",
"2085",
"2086",
"2087",
"2088",
"2089",
"2090"
],
"example": "2049"
}
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"delete": {
"operationId": "cardBalance.destroy",
"summary": "DELETE*",
"tags": [
"Sargytlar - Kart - Kart galyndylary"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
}
},
"/card-balances-download/{order}": {
"get": {
"operationId": "cardBalance.download",
"description": "Download card transaction file",
"summary": "Download*",
"tags": [
"Sargytlar - Kart - Kart galyndylary"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"data": {
"type": "object"
}
},
"required": [
"status",
"data"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
},
"url": {
"type": "string",
"enum": [
""
]
}
},
"required": [
"status",
"message",
"url"
]
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
}
},
"/card-transactions": {
"get": {
"operationId": "cardTransactions.index",
"summary": "LIST*",
"tags": [
"Sargytlar - Kart - Kart hereketleri"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "cardTransactions.store",
"summary": "SAVE*",
"tags": [
"Sargytlar - Kart - Kart hereketleri"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"passport_serie": {
"type": "string",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"example": 379514
},
"card_number": {
"type": "string",
"example": "9934612100000243"
},
"card_month": {
"type": "string",
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12"
],
"example": "12"
},
"card_year": {
"type": "string",
"enum": [
"2024",
"2025",
"2026",
"2027",
"2028",
"2029",
"2030",
"2031",
"2032",
"2033",
"2034",
"2035",
"2036",
"2037",
"2038",
"2039",
"2040",
"2041",
"2042",
"2043",
"2044",
"2045",
"2046",
"2047",
"2048",
"2049",
"2050",
"2051",
"2052",
"2053",
"2054",
"2055",
"2056",
"2057",
"2058",
"2059",
"2060",
"2061",
"2062",
"2063",
"2064",
"2065",
"2066",
"2067",
"2068",
"2069",
"2070",
"2071",
"2072",
"2073",
"2074",
"2075",
"2076",
"2077",
"2078",
"2079",
"2080",
"2081",
"2082",
"2083",
"2084",
"2085",
"2086",
"2087",
"2088",
"2089",
"2090"
],
"example": "2049"
}
},
"required": [
"passport_serie",
"passport_id",
"card_number",
"card_month",
"card_year"
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/card-transactions/{order}": {
"get": {
"operationId": "cardTransactions.show",
"description": "ID ugradyp alyan route -da. Soň page-da download button bolmaly, basaňdan soň, modal çykmaly, start date bilen end date ugradyp download basanda `/api/card-transactions-download/{order}` route gelyan pdf download etmeli.",
"summary": "SHOW*",
"tags": [
"Sargytlar - Kart - Kart hereketleri"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardTransaction"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
},
"post": {
"operationId": "cardTransactions.update",
"description": "ID ugradyp `route`-da update edip bilyan. Base App Enum-lardan peydalan. Panelkadan gor.",
"summary": "UPDATE*",
"tags": [
"Sargytlar - Kart - Kart hereketleri"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"passport_serie": {
"type": "string",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"example": 379514
},
"card_number": {
"type": "string",
"example": "9934612100000243"
},
"card_month": {
"type": "string",
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12"
],
"example": "12"
},
"card_year": {
"type": "string",
"enum": [
"2024",
"2025",
"2026",
"2027",
"2028",
"2029",
"2030",
"2031",
"2032",
"2033",
"2034",
"2035",
"2036",
"2037",
"2038",
"2039",
"2040",
"2041",
"2042",
"2043",
"2044",
"2045",
"2046",
"2047",
"2048",
"2049",
"2050",
"2051",
"2052",
"2053",
"2054",
"2055",
"2056",
"2057",
"2058",
"2059",
"2060",
"2061",
"2062",
"2063",
"2064",
"2065",
"2066",
"2067",
"2068",
"2069",
"2070",
"2071",
"2072",
"2073",
"2074",
"2075",
"2076",
"2077",
"2078",
"2079",
"2080",
"2081",
"2082",
"2083",
"2084",
"2085",
"2086",
"2087",
"2088",
"2089",
"2090"
],
"example": "2049"
}
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"delete": {
"operationId": "cardTransactions.destroy",
"summary": "DELETE*",
"tags": [
"Sargytlar - Kart - Kart hereketleri"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
}
},
"/card-transactions-download/{order}": {
"get": {
"operationId": "cardTransactions.download",
"description": "Download card transaction file",
"summary": "Download*",
"tags": [
"Sargytlar - Kart - Kart hereketleri"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
},
{
"name": "start_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "end_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"status",
"message",
"url"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
},
"url": {
"type": "string",
"enum": [
""
]
}
},
"required": [
"status",
"message",
"url"
]
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/card-pin-order": {
"get": {
"operationId": "cardPin.index",
"summary": "LIST*",
"tags": [
"Sargytlar - Kart - Kart pin bukjalar"
],
"responses": {
"200": {
"description": "Array of `CardPinIndexResource`",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardPinIndexResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "cardPin.store",
"summary": "SAVE*",
"tags": [
"Sargytlar - Kart - Kart pin bukjalar"
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CardPinStoreRequest"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/card-pin-order/{order}": {
"get": {
"operationId": "cardPin.show",
"description": "ID ugradyp alyan route -da.",
"summary": "SHOW*",
"tags": [
"Sargytlar - Kart - Kart pin bukjalar"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`CardPinIndexResource`",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardPinIndexResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
},
"post": {
"operationId": "cardPin.update",
"description": "ID ugradyp `route`-da update edip bilyan. Base App Enum-lardan peydalan. Panelkadan gor.",
"summary": "UPDATE*",
"tags": [
"Sargytlar - Kart - Kart pin bukjalar"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CardPinUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"delete": {
"operationId": "cardPin.destroy",
"summary": "DELETE*",
"tags": [
"Sargytlar - Kart - Kart pin bukjalar"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
}
},
"/card-requisites": {
"get": {
"operationId": "cardRequisite.index",
"summary": "LIST*",
"tags": [
"Sargytlar - Kart - Kart rekwizitler"
],
"responses": {
"200": {
"description": "Array of `CardRequisiteIndexResource`",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardRequisiteIndexResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "cardRequisite.store",
"summary": "SAVE*",
"tags": [
"Sargytlar - Kart - Kart rekwizitler"
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CardRequisiteStoreRequest"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/card-requisites/{order}": {
"get": {
"operationId": "cardRequisite.show",
"description": "ID ugradyp alyan route -da. Soň page-da download button bolmaly, basaňdan soň, `/api/card-requisites-download/{order}` route gelyan file download etmeli.",
"summary": "SHOW*",
"tags": [
"Sargytlar - Kart - Kart rekwizitler"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`CardRequisiteIndexResource`",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardRequisiteIndexResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
},
"post": {
"operationId": "cardRequisite.update",
"description": "ID ugradyp `route`-da update edip bilyan. Base App Enum-lardan peydalan. Panelkadan gor.",
"summary": "UPDATE*",
"tags": [
"Sargytlar - Kart - Kart rekwizitler"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CardRequisiteUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"delete": {
"operationId": "cardRequisite.destroy",
"summary": "DELETE*",
"tags": [
"Sargytlar - Kart - Kart rekwizitler"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
}
},
"/card-requisites-download/{order}": {
"get": {
"operationId": "cardRequisite.download",
"description": "Download card transaction file",
"summary": "Download*",
"tags": [
"Sargytlar - Kart - Kart rekwizitler"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"status",
"message",
"url"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
},
"url": {
"type": "string",
"enum": [
""
]
}
},
"required": [
"status",
"message",
"url"
]
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
}
},
"/card-order": {
"get": {
"operationId": "cardOrder.index",
"summary": "LIST*",
"tags": [
"Sargytlar - Kart - Täze kart"
],
"responses": {
"200": {
"description": "Array of `CardOrderIndexResource`",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardOrderIndexResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "cardOrder.store",
"description": "POST ugradanyňdan soň, halkbank toleg link berer, webwiew -da açmaly. Şul route-da ýetende, break etse bolyar, `https://online.tbbank.gov.tm/online-payment-store`",
"summary": "SAVE*",
"tags": [
"Sargytlar - Kart - Täze kart"
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CardOrderStoreRequest"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"payment": {
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
""
]
}
]
}
},
"required": [
"status",
"url"
]
}
},
"required": [
"message",
"payment"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/card-order/{cardOrder}": {
"get": {
"operationId": "cardOrder.show",
"description": "ID ugradyp alyan route -da.",
"summary": "SHOW*",
"tags": [
"Sargytlar - Kart - Täze kart"
],
"parameters": [
{
"name": "cardOrder",
"in": "path",
"required": true,
"description": "The card order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`CardOrderIndexResource`",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardOrderIndexResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
},
"post": {
"operationId": "cardOrder.update",
"description": "ID ugradyp `route`-da update edip bilyan. Base App Enum-lardan peydalan. Panelkadan gor.",
"summary": "UPDATE*",
"tags": [
"Sargytlar - Kart - Täze kart"
],
"parameters": [
{
"name": "cardOrder",
"in": "path",
"required": true,
"description": "The card order ID",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CardOrderUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"delete": {
"operationId": "cardOrder.destroy",
"summary": "DELETE*",
"tags": [
"Sargytlar - Kart - Täze kart"
],
"parameters": [
{
"name": "cardOrder",
"in": "path",
"required": true,
"description": "The card order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
}
},
"/loan-order": {
"get": {
"operationId": "loanOrder.index",
"description": "`Karz sargytlary list`-leri list gornushde gelyar. https://online.tbbank.gov.tm/work-place/resources/loan-order-mobiles dan `Label` gorup bilyan. `BaseAppEnum` dan gerek yerlerini match edishene gora alyan.",
"summary": "LIST* Loan orders",
"tags": [
"Sargytlar - Karz - Karz sargytlary Mobile"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "loanOrder.store",
"description": "`Karz sargytlary save`. Example bar, online panelkadan gorup hem bilersin. Update store daky yaly, yone oz ugratyan zadyn update bolyar, eger ugratmasaň, üýtgemez.",
"summary": "SAVE* Loan order",
"tags": [
"Sargytlar - Karz - Karz sargytlary Mobile"
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/LoanOrderStoreRequest"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/loan-order/{loanOrder}": {
"get": {
"operationId": "loanOrder.show",
"description": "`Karz sargytlary show by id`. ID ugradyp alyan route -da. Base App Enum-lardan peydalan. Panelkadan gor.",
"summary": "SHOW* Loan order",
"tags": [
"Sargytlar - Karz - Karz sargytlary Mobile"
],
"parameters": [
{
"name": "loanOrder",
"in": "path",
"required": true,
"description": "The loan order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`LoanOrderShowResource`",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoanOrderShowResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
},
"post": {
"operationId": "loanOrder.update",
"description": "`Karz sargytlary update`. ID ugradyp `route`-da update edip bilyan. Base App Enum-lardan peydalan. Panelkadan gor.",
"summary": "UPDATE* Loan order",
"tags": [
"Sargytlar - Karz - Karz sargytlary Mobile"
],
"parameters": [
{
"name": "loanOrder",
"in": "path",
"required": true,
"description": "The loan order ID",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/LoanOrderUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"delete": {
"operationId": "loanOrder.destroy",
"summary": "DELETE* loan order resource",
"tags": [
"Sargytlar - Karz - Karz sargytlary Mobile"
],
"parameters": [
{
"name": "loanOrder",
"in": "path",
"required": true,
"description": "The loan order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
}
},
"/loan-remaining": {
"get": {
"operationId": "loanRemainingOrder.index",
"summary": "Galan karzyny görip biler, zaýawka içinde knopka bolýar, basaňdan soň modal jogaby bermeli",
"tags": [
"Sargytlar - Karz - Karzyň galyndysy"
],
"parameters": [
{
"name": "passport_serie",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
]
}
},
{
"name": "passport_id",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "account_number",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/loan-remaining-order": {
"get": {
"operationId": "loanOrderRemainingOrder.index",
"summary": "LIST*",
"tags": [
"Sargytlar - Karz - Karzyň galyndysy"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "loanOrderRemainingOrder.store",
"summary": "SAVE*",
"tags": [
"Sargytlar - Karz - Karzyň galyndysy"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"passport_serie": {
"type": "string",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"example": 379514
},
"account_number": {
"type": "string",
"example": "14208934130700002997232"
}
},
"required": [
"passport_serie",
"passport_id",
"account_number"
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/loan-remaining-order/{order}": {
"get": {
"operationId": "loanOrderRemainingOrder.show",
"description": "ID ugradyp alyan route -da.",
"summary": "SHOW*",
"tags": [
"Sargytlar - Karz - Karzyň galyndysy"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoanRemainingOrder"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
},
"post": {
"operationId": "loanOrderRemainingOrder.update",
"description": "ID ugradyp `route`-da update edip bilyan. Base App Enum-lardan peydalan. Panelkadan gor.",
"summary": "UPDATE*",
"tags": [
"Sargytlar - Karz - Karzyň galyndysy"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"passport_serie": {
"type": "string",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"example": 379514
},
"account_number": {
"type": "string",
"example": "14208934130700002997232"
}
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"delete": {
"operationId": "loanOrderRemainingOrder.destroy",
"summary": "DELETE*",
"tags": [
"Sargytlar - Karz - Karzyň galyndysy"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
}
},
"/loan-paid-off-letter-orders": {
"get": {
"operationId": "loanPaidOffLetterOrder.index",
"summary": "LIST*",
"tags": [
"Sargytlar - Karz - Karzyň ýapylandygy barada güwanama"
],
"responses": {
"200": {
"description": "Array of `LoanPaidOffLetterOrderIndexResource`",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoanPaidOffLetterOrderIndexResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "loanPaidOffLetterOrder.store",
"summary": "SAVE*",
"tags": [
"Sargytlar - Karz - Karzyň ýapylandygy barada güwanama"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoanPaidOffLetterOrderStoreRequest"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/loan-paid-off-letter-orders/{order}": {
"get": {
"operationId": "loanPaidOffLetterOrder.show",
"description": "ID ugradyp alyan route -da.",
"summary": "SHOW*",
"tags": [
"Sargytlar - Karz - Karzyň ýapylandygy barada güwanama"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`LoanPaidOffLetterOrderIndexResource`",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoanPaidOffLetterOrderIndexResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
},
"post": {
"operationId": "loanPaidOffLetterOrder.update",
"description": "ID ugradyp `route`-da update edip bilyan. Base App Enum-lardan peydalan. Panelkadan gor.",
"summary": "UPDATE*",
"tags": [
"Sargytlar - Karz - Karzyň ýapylandygy barada güwanama"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
]
},
"branch_id": {
"type": "integer",
"description": "Branch id (https://online.tbbank.gov.tm/api/branches)"
},
"customer_name": {
"type": "string",
"description": "Customer name",
"example": "Mahmyt",
"maxLength": 255
},
"customer_surname": {
"type": "string",
"description": "Customer surname",
"example": "Allaberdiyev",
"maxLength": 255
},
"customer_patronic_name": {
"type": [
"string",
"null"
],
"description": "Customer patronic name",
"example": "Öwezowiç",
"maxLength": 255
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
]
},
"passport_id": {
"type": "number",
"description": "Passport number",
"example": 100999
},
"born_at": {
"type": "string",
"description": "Date of birth",
"example": "10.10.2000"
},
"phone": {
"type": "integer",
"description": "Phone number",
"example": 65999990
},
"loan_contract_number": {
"type": "string",
"description": "Contract number",
"example": "3242358989234",
"maxLength": 255
},
"loan_contract_date": {
"type": "string",
"description": "Contract date",
"example": "20.34.23",
"maxLength": 255
},
"loan_amount": {
"type": "string",
"description": "Loan amount",
"example": "20000",
"maxLength": 255
},
"loan_reason": {
"type": "string",
"description": "Loan reason",
"example": "Puldan pul yasamak ucin",
"maxLength": 255
}
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"delete": {
"operationId": "loanPaidOffLetterOrder.destroy",
"summary": "DELETE*",
"tags": [
"Sargytlar - Karz - Karzyň ýapylandygy barada güwanama"
],
"parameters": [
{
"name": "order",
"in": "path",
"required": true,
"description": "The order ID",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
}
}
}
},
"/visa-master-order": {
"get": {
"operationId": "visaMasterPaymentOrder.index",
"tags": [
"VisaMasterPaymentOrder"
],
"responses": {
"200": {
"description": ""
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
}
},
"components": {
"securitySchemes": {
"http": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"AuthLoginRequest": {
"type": "object",
"properties": {
"phone": {
"type": "integer",
"description": "Phone number to authenticate",
"example": 65707012
},
"password": {
"type": "string",
"description": "User's password",
"example": "MahmytAllaberdiyevPassword",
"maxLength": 255
}
},
"required": [
"phone",
"password"
],
"title": "AuthLoginRequest"
},
"AuthRegisterRequest": {
"type": "object",
"properties": {
"phone": {
"type": "integer",
"description": "Phone number to authenticate",
"example": 65707012
},
"name": {
"type": "string",
"description": "User's name",
"example": "Mahmyt Allaberdiyev",
"maxLength": 255
},
"password": {
"type": "string",
"description": "User's password",
"example": "MahmytAllaberdiyevPassword",
"maxLength": 255
}
},
"required": [
"phone",
"name",
"password"
],
"title": "AuthRegisterRequest"
},
"AuthVerifyRequest": {
"type": "object",
"properties": {
"phone": {
"type": "integer",
"description": "Phone number to authenticate",
"example": 65707012
},
"code": {
"type": "integer",
"description": "Verification code (OTP)",
"example": 432123
}
},
"required": [
"phone",
"code"
],
"title": "AuthVerifyRequest"
},
"CardBalance": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"unique_id": {
"type": [
"string",
"null"
]
},
"passport_serie": {
"type": "string"
},
"passport_id": {
"type": "string"
},
"card_number": {
"type": "string"
},
"card_month": {
"type": "string"
},
"card_year": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"deleted_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"unique_id",
"passport_serie",
"passport_id",
"card_number",
"card_month",
"card_year",
"user_id",
"created_at",
"updated_at",
"deleted_at"
],
"title": "CardBalance"
},
"CardOrderIndexResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"unique_id": {
"type": [
"string",
"null"
]
},
"paid": {
"type": "string"
},
"card_state_id": {
"type": "string"
},
"card_type_id": {
"type": "string"
},
"region": {
"type": "string"
},
"branch_id": {
"type": "string"
},
"customer_name": {
"type": "string"
},
"customer_surname": {
"type": "string"
},
"customer_patronic_name": {
"type": [
"string",
"null"
]
},
"old_surname": {
"type": [
"string",
"null"
]
},
"born_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"passport_serie": {
"type": "string"
},
"passport_id": {
"type": "string"
},
"passport_given_at": {
"type": "string",
"format": "date-time"
},
"passport_given_by": {
"type": "string"
},
"born_place": {
"type": "string"
},
"passport_address": {
"type": [
"string",
"null"
]
},
"real_address": {
"type": [
"string",
"null"
]
},
"job_location": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"phone_additional": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"passport_one": {
"type": "string"
},
"passport_two": {
"type": "string"
},
"passport_three": {
"type": "string"
},
"passport_four": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": "integer"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"deleted_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"unique_id",
"paid",
"card_state_id",
"card_type_id",
"region",
"branch_id",
"customer_name",
"customer_surname",
"customer_patronic_name",
"old_surname",
"born_at",
"passport_serie",
"passport_id",
"passport_given_at",
"passport_given_by",
"born_place",
"passport_address",
"real_address",
"job_location",
"phone",
"phone_additional",
"status",
"passport_one",
"passport_two",
"passport_three",
"passport_four",
"notes",
"user_id",
"created_at",
"updated_at",
"deleted_at"
],
"title": "CardOrderIndexResource"
},
"CardOrderStoreRequest": {
"type": "object",
"properties": {
"card_state_id": {
"type": "integer",
"description": "Card state id (https://online.tbbank.gov.tm/api/base-app-enums)"
},
"card_type_id": {
"type": "integer",
"description": "Card type id (https://online.tbbank.gov.tm/api/base-app-enums)"
},
"region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
],
"example": "ag"
},
"branch_id": {
"type": "integer",
"description": "Branch id (https://online.tbbank.gov.tm/api/branches)"
},
"customer_name": {
"type": "string",
"description": "Customer name",
"example": "Mahmyt",
"maxLength": 255
},
"customer_surname": {
"type": "string",
"description": "Customer surname",
"example": "Allaberdiyev",
"maxLength": 255
},
"customer_patronic_name": {
"type": [
"string",
"null"
],
"description": "Customer patronic name",
"example": "Öwezowiç",
"maxLength": 255
},
"born_at": {
"type": "string",
"description": "Date of birth",
"example": "10.10.2000"
},
"old_surname": {
"type": [
"string",
"null"
],
"description": "Old surname",
"maxLength": 255
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"description": "Passport number",
"example": 100999
},
"passport_given_at": {
"type": "string",
"format": "date-time",
"description": "Passport date of issue",
"example": "10.10.2020"
},
"passport_given_by": {
"type": "string",
"description": "Passport given by",
"example": "Ashgabat shaher polisiya tarapyndan",
"maxLength": 255
},
"born_place": {
"type": "string",
"description": "Born place",
"example": "Ashgabat shaher",
"maxLength": 255
},
"job_location": {
"type": "string",
"description": "Işleýän ýeriňiz we wezipäňiz",
"example": "Aşgabat şäheriniň \"TÜRKMENBAŞY\" PAÝDARLAR TÄJIRÇILIK bankynyň Baş bugalteri",
"maxLength": 255
},
"passport_address": {
"type": "string",
"description": "Passport address",
"example": "Kemine 100/190",
"maxLength": 255
},
"real_address": {
"type": "string",
"description": "Real address",
"example": "Kemine 100/190",
"maxLength": 255
},
"phone": {
"type": "integer",
"description": "Phone number",
"example": 65999990
},
"phone_additional": {
"type": [
"integer",
"null"
],
"description": "Phone number (additional)",
"example": 65999990
},
"passport_one": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Passport (sahypa 1)",
"maxLength": 2048
},
"passport_two": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (2-3-nji sahypa)",
"maxLength": 2048
},
"passport_three": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (8-9 sahypa)",
"maxLength": 2048
},
"passport_four": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (32-nji sahypa)",
"maxLength": 2048
}
},
"required": [
"card_state_id",
"card_type_id",
"region",
"branch_id",
"customer_name",
"customer_surname",
"born_at",
"passport_serie",
"passport_id",
"passport_given_at",
"passport_given_by",
"born_place",
"job_location",
"passport_address",
"real_address",
"phone",
"passport_one",
"passport_two",
"passport_three",
"passport_four"
],
"title": "CardOrderStoreRequest"
},
"CardOrderUpdateRequest": {
"type": "object",
"properties": {
"card_state_id": {
"type": "integer",
"description": "Card state id (https://online.tbbank.gov.tm/api/base-app-enums)"
},
"card_type_id": {
"type": "integer",
"description": "Card type id (https://online.tbbank.gov.tm/api/base-app-enums)"
},
"region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
],
"example": "ag"
},
"branch_id": {
"type": "integer",
"description": "Branch id (https://online.tbbank.gov.tm/api/branches)"
},
"customer_name": {
"type": "string",
"description": "Customer name",
"example": "Mahmyt",
"maxLength": 255
},
"customer_surname": {
"type": "string",
"description": "Customer surname",
"example": "Allaberdiyev",
"maxLength": 255
},
"customer_patronic_name": {
"type": [
"string",
"null"
],
"description": "Customer patronic name",
"example": "Öwezowiç",
"maxLength": 255
},
"born_at": {
"type": "string",
"description": "Date of birth",
"example": "10.10.2000"
},
"old_surname": {
"type": [
"string",
"null"
],
"description": "Old surname",
"maxLength": 255
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"description": "Passport number",
"example": 100999
},
"passport_given_at": {
"type": "string",
"format": "date-time",
"description": "Passport date of issue",
"example": "10.10.2020"
},
"passport_given_by": {
"type": "string",
"description": "Passport given by",
"example": "Ashgabat shaher polisiya tarapyndan",
"maxLength": 255
},
"born_place": {
"type": "string",
"description": "Born place",
"example": "Ashgabat shaher",
"maxLength": 255
},
"job_location": {
"type": "string",
"description": "Işleýän ýeriňiz we wezipäňiz",
"example": "Aşgabat şäheriniň \"TÜRKMENBAŞY\" PAÝDARLAR TÄJIRÇILIK bankynyň Baş bugalteri",
"maxLength": 255
},
"passport_address": {
"type": "string",
"description": "Passport address",
"example": "Kemine 100/190",
"maxLength": 255
},
"real_address": {
"type": "string",
"description": "Real address",
"example": "Kemine 100/190",
"maxLength": 255
},
"phone": {
"type": "integer",
"description": "Phone number",
"example": 65999990
},
"phone_additional": {
"type": [
"integer",
"null"
],
"description": "Phone number (additional)",
"example": 65999990
},
"passport_one": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Passport (sahypa 1)",
"maxLength": 2048
},
"passport_two": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (2-3-nji sahypa)",
"maxLength": 2048
},
"passport_three": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (8-9 sahypa)",
"maxLength": 2048
},
"passport_four": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (32-nji sahypa)",
"maxLength": 2048
}
},
"title": "CardOrderUpdateRequest"
},
"CardPinIndexResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"unique_id": {
"type": [
"string",
"null"
]
},
"card_type_id": {
"type": "string"
},
"card_number": {
"type": "string"
},
"region": {
"type": "string"
},
"branch_id": {
"type": "string"
},
"customer_name": {
"type": "string"
},
"customer_surname": {
"type": "string"
},
"customer_patronic_name": {
"type": [
"string",
"null"
]
},
"born_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"phone": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"passport_serie": {
"type": "string"
},
"passport_id": {
"type": "string"
},
"passport_one": {
"type": "string"
},
"passport_two": {
"type": "string"
},
"passport_three": {
"type": "string"
},
"passport_four": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": "integer"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"deleted_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"unique_id",
"card_type_id",
"card_number",
"region",
"branch_id",
"customer_name",
"customer_surname",
"customer_patronic_name",
"born_at",
"phone",
"status",
"passport_serie",
"passport_id",
"passport_one",
"passport_two",
"passport_three",
"passport_four",
"notes",
"user_id",
"created_at",
"updated_at",
"deleted_at"
],
"title": "CardPinIndexResource"
},
"CardPinStoreRequest": {
"type": "object",
"properties": {
"card_type_id": {
"type": "integer",
"description": "Card type id (https://online.tbbank.gov.tm/api/base-app-enums)"
},
"region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
],
"example": "ag"
},
"branch_id": {
"type": "integer",
"description": "Branch id (https://online.tbbank.gov.tm/api/branches)"
},
"customer_name": {
"type": "string",
"description": "Customer name",
"example": "Mahmyt",
"maxLength": 255
},
"customer_surname": {
"type": "string",
"description": "Customer surname",
"example": "Allaberdiyev",
"maxLength": 255
},
"customer_patronic_name": {
"type": [
"string",
"null"
],
"description": "Customer patronic name",
"example": "Öwezowiç",
"maxLength": 255
},
"born_at": {
"type": "string",
"description": "Date of birth",
"example": "10.10.2000"
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"description": "Passport number",
"example": 100999
},
"card_number": {
"type": "string",
"description": "Card number",
"example": "9934 2312 2342 0249"
},
"phone": {
"type": "integer",
"description": "Phone number",
"example": 65999990
},
"passport_one": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Passport (sahypa 1)",
"maxLength": 2048
},
"passport_two": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (2-3-nji sahypa)",
"maxLength": 2048
},
"passport_three": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (8-9 sahypa)",
"maxLength": 2048
},
"passport_four": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (32-nji sahypa)",
"maxLength": 2048
}
},
"required": [
"card_type_id",
"region",
"branch_id",
"customer_name",
"customer_surname",
"born_at",
"passport_serie",
"passport_id",
"card_number",
"phone",
"passport_one",
"passport_two",
"passport_three",
"passport_four"
],
"title": "CardPinStoreRequest"
},
"CardPinUpdateRequest": {
"type": "object",
"properties": {
"card_type_id": {
"type": "integer",
"description": "Card type id (https://online.tbbank.gov.tm/api/base-app-enums)"
},
"region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
],
"example": "ag"
},
"branch_id": {
"type": "integer",
"description": "Branch id (https://online.tbbank.gov.tm/api/branches)"
},
"customer_name": {
"type": "string",
"description": "Customer name",
"example": "Mahmyt",
"maxLength": 255
},
"customer_surname": {
"type": "string",
"description": "Customer surname",
"example": "Allaberdiyev",
"maxLength": 255
},
"customer_patronic_name": {
"type": [
"string",
"null"
],
"description": "Customer patronic name",
"example": "Öwezowiç",
"maxLength": 255
},
"born_at": {
"type": "string",
"description": "Date of birth",
"example": "10.10.2000"
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"description": "Passport number",
"example": 100999
},
"card_number": {
"type": "string",
"description": "Card number",
"example": "9934 2312 2342 0249"
},
"phone": {
"type": "integer",
"description": "Phone number",
"example": 65999990
},
"passport_one": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Passport (sahypa 1)",
"maxLength": 2048
},
"passport_two": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (2-3-nji sahypa)",
"maxLength": 2048
},
"passport_three": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (8-9 sahypa)",
"maxLength": 2048
},
"passport_four": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (32-nji sahypa)",
"maxLength": 2048
}
},
"title": "CardPinUpdateRequest"
},
"CardRequisiteIndexResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"unique_id": {
"type": [
"string",
"null"
]
},
"card_type_id": {
"type": "string"
},
"card_number": {
"type": "string"
},
"card_month": {
"type": [
"string",
"null"
]
},
"card_year": {
"type": [
"string",
"null"
]
},
"region": {
"type": "string"
},
"branch_id": {
"type": "string"
},
"customer_name": {
"type": "string"
},
"customer_surname": {
"type": "string"
},
"customer_patronic_name": {
"type": [
"string",
"null"
]
},
"born_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"phone": {
"type": [
"string",
"null"
]
},
"passport_serie": {
"type": "string"
},
"passport_id": {
"type": "string"
},
"passport_one": {
"type": "string"
},
"passport_two": {
"type": "string"
},
"passport_three": {
"type": "string"
},
"passport_four": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": "integer"
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"unique_id",
"card_type_id",
"card_number",
"card_month",
"card_year",
"region",
"branch_id",
"customer_name",
"customer_surname",
"customer_patronic_name",
"born_at",
"phone",
"passport_serie",
"passport_id",
"passport_one",
"passport_two",
"passport_three",
"passport_four",
"notes",
"user_id",
"status",
"created_at",
"updated_at"
],
"title": "CardRequisiteIndexResource"
},
"CardRequisiteStoreRequest": {
"type": "object",
"properties": {
"card_type_id": {
"type": "integer",
"description": "Card type id (https://online.tbbank.gov.tm/api/base-app-enums)"
},
"card_number": {
"type": "string",
"example": "9934612100000243"
},
"card_month": {
"type": "string",
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12"
],
"example": "12"
},
"card_year": {
"type": "string",
"enum": [
"2024",
"2025",
"2026",
"2027",
"2028",
"2029",
"2030",
"2031",
"2032",
"2033",
"2034",
"2035",
"2036",
"2037",
"2038",
"2039",
"2040",
"2041",
"2042",
"2043",
"2044",
"2045",
"2046",
"2047",
"2048",
"2049",
"2050",
"2051",
"2052",
"2053",
"2054",
"2055",
"2056",
"2057",
"2058",
"2059",
"2060",
"2061",
"2062",
"2063",
"2064",
"2065",
"2066",
"2067",
"2068",
"2069",
"2070",
"2071",
"2072",
"2073",
"2074",
"2075",
"2076",
"2077",
"2078",
"2079",
"2080",
"2081",
"2082",
"2083",
"2084",
"2085",
"2086",
"2087",
"2088",
"2089",
"2090"
],
"example": "2049"
},
"region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
],
"example": "ag"
},
"branch_id": {
"type": "integer",
"description": "Branch id (https://online.tbbank.gov.tm/api/branches)"
},
"customer_name": {
"type": "string",
"description": "Customer name",
"example": "Mahmyt",
"maxLength": 255
},
"customer_surname": {
"type": "string",
"description": "Customer surname",
"example": "Allaberdiyev",
"maxLength": 255
},
"customer_patronic_name": {
"type": [
"string",
"null"
],
"description": "Customer patronic name",
"example": "Öwezowiç",
"maxLength": 255
},
"born_at": {
"type": "string",
"description": "Date of birth",
"example": "10.10.2000"
},
"phone": {
"type": "integer",
"description": "Phone number",
"example": 65999990
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"example": 379514
},
"passport_one": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Passport (sahypa 1)",
"maxLength": 2048
},
"passport_two": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (2-3-nji sahypa)",
"maxLength": 2048
},
"passport_three": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (8-9 sahypa)",
"maxLength": 2048
},
"passport_four": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (32-nji sahypa)",
"maxLength": 2048
}
},
"required": [
"card_type_id",
"card_number",
"card_month",
"card_year",
"region",
"branch_id",
"customer_name",
"customer_surname",
"born_at",
"phone",
"passport_serie",
"passport_id",
"passport_one",
"passport_two",
"passport_three",
"passport_four"
],
"title": "CardRequisiteStoreRequest"
},
"CardRequisiteUpdateRequest": {
"type": "object",
"properties": {
"card_type_id": {
"type": "integer",
"description": "Card type id (https://online.tbbank.gov.tm/api/base-app-enums)"
},
"card_number": {
"type": "string",
"example": "9934612100000243"
},
"card_month": {
"type": "string",
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12"
],
"example": "12"
},
"card_year": {
"type": "string",
"enum": [
"2024",
"2025",
"2026",
"2027",
"2028",
"2029",
"2030",
"2031",
"2032",
"2033",
"2034",
"2035",
"2036",
"2037",
"2038",
"2039",
"2040",
"2041",
"2042",
"2043",
"2044",
"2045",
"2046",
"2047",
"2048",
"2049",
"2050",
"2051",
"2052",
"2053",
"2054",
"2055",
"2056",
"2057",
"2058",
"2059",
"2060",
"2061",
"2062",
"2063",
"2064",
"2065",
"2066",
"2067",
"2068",
"2069",
"2070",
"2071",
"2072",
"2073",
"2074",
"2075",
"2076",
"2077",
"2078",
"2079",
"2080",
"2081",
"2082",
"2083",
"2084",
"2085",
"2086",
"2087",
"2088",
"2089",
"2090"
],
"example": "2049"
},
"region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
],
"example": "ag"
},
"branch_id": {
"type": "integer",
"description": "Branch id (https://online.tbbank.gov.tm/api/branches)"
},
"customer_name": {
"type": "string",
"description": "Customer name",
"example": "Mahmyt",
"maxLength": 255
},
"customer_surname": {
"type": "string",
"description": "Customer surname",
"example": "Allaberdiyev",
"maxLength": 255
},
"customer_patronic_name": {
"type": [
"string",
"null"
],
"description": "Customer patronic name",
"example": "Öwezowiç",
"maxLength": 255
},
"born_at": {
"type": "string",
"description": "Date of birth",
"example": "10.10.2000"
},
"phone": {
"type": "integer",
"description": "Phone number",
"example": 65999990
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"example": 379514
},
"passport_one": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Passport (sahypa 1)",
"maxLength": 2048
},
"passport_two": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (2-3-nji sahypa)",
"maxLength": 2048
},
"passport_three": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (8-9 sahypa)",
"maxLength": 2048
},
"passport_four": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (32-nji sahypa)",
"maxLength": 2048
}
},
"title": "CardRequisiteUpdateRequest"
},
"CardTransaction": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"unique_id": {
"type": [
"string",
"null"
]
},
"passport_serie": {
"type": "string"
},
"passport_id": {
"type": "string"
},
"card_number": {
"type": "string"
},
"card_month": {
"type": "string"
},
"card_year": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"deleted_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"unique_id",
"passport_serie",
"passport_id",
"card_number",
"card_month",
"card_year",
"user_id",
"created_at",
"updated_at",
"deleted_at"
],
"title": "CardTransaction"
},
"LoanOrderShowResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"unique_id": {
"type": [
"string",
"null"
]
},
"loan_amount": {
"type": [
"string",
"null"
]
},
"loan_type": {
"type": "string"
},
"region": {
"type": "string"
},
"branch": {
"type": "string"
},
"customer_name": {
"type": "string"
},
"customer_surname": {
"type": "string"
},
"customer_patronic_name": {
"type": [
"string",
"null"
]
},
"passport_address": {
"type": "string"
},
"real_address": {
"type": "string"
},
"passport_serie": {
"type": "string"
},
"passport_id": {
"type": "string"
},
"passport_given_at": {
"type": "string",
"format": "date-time"
},
"passport_given_by": {
"type": "string"
},
"born_place": {
"type": "string"
},
"born_at": {
"type": "string",
"format": "date-time"
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": "string"
},
"phone_additional": {
"type": [
"string",
"null"
]
},
"phone_home": {
"type": [
"string",
"null"
]
},
"work_region": {
"type": "string"
},
"work_province": {
"type": "string"
},
"work_company": {
"type": [
"string",
"null"
]
},
"work_company_accountant_number": {
"type": [
"string",
"null"
]
},
"work_started_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"work_salary": {
"type": [
"string",
"null"
]
},
"work_position": {
"type": [
"string",
"null"
]
},
"education": {
"type": "string"
},
"marriage_status": {
"type": "string"
},
"passport_one": {
"type": "string"
},
"passport_two": {
"type": "string"
},
"passport_three": {
"type": "string"
},
"passport_four": {
"type": "string"
},
"card_number": {
"type": [
"string",
"null"
]
},
"card_name": {
"type": [
"string",
"null"
]
},
"card_month": {
"type": [
"string",
"null"
]
},
"card_year": {
"type": [
"string",
"null"
]
},
"guarantor_name": {
"type": [
"string",
"null"
]
},
"guarantor_surname": {
"type": [
"string",
"null"
]
},
"guarantor_patronic_name": {
"type": [
"string",
"null"
]
},
"guarantor_card_number": {
"type": [
"string",
"null"
]
},
"guarantor_card_name": {
"type": [
"string",
"null"
]
},
"guarantor_card_month": {
"type": [
"string",
"null"
]
},
"guarantor_card_year": {
"type": [
"string",
"null"
]
},
"guarantor_2_name": {
"type": [
"string",
"null"
]
},
"guarantor_2_surname": {
"type": [
"string",
"null"
]
},
"guarantor_2_patronic_name": {
"type": [
"string",
"null"
]
},
"guarantor_2_card_number": {
"type": [
"string",
"null"
]
},
"guarantor_2_card_name": {
"type": [
"string",
"null"
]
},
"guarantor_2_card_month": {
"type": [
"string",
"null"
]
},
"guarantor_2_card_year": {
"type": [
"string",
"null"
]
},
"guarantor_note": {
"type": [
"string",
"null"
]
},
"guarantor_2_note": {
"type": [
"string",
"null"
]
},
"satisfiable": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"unique_id",
"loan_amount",
"loan_type",
"region",
"branch",
"customer_name",
"customer_surname",
"customer_patronic_name",
"passport_address",
"real_address",
"passport_serie",
"passport_id",
"passport_given_at",
"passport_given_by",
"born_place",
"born_at",
"email",
"phone",
"phone_additional",
"phone_home",
"work_region",
"work_province",
"work_company",
"work_company_accountant_number",
"work_started_at",
"work_salary",
"work_position",
"education",
"marriage_status",
"passport_one",
"passport_two",
"passport_three",
"passport_four",
"card_number",
"card_name",
"card_month",
"card_year",
"guarantor_name",
"guarantor_surname",
"guarantor_patronic_name",
"guarantor_card_number",
"guarantor_card_name",
"guarantor_card_month",
"guarantor_card_year",
"guarantor_2_name",
"guarantor_2_surname",
"guarantor_2_patronic_name",
"guarantor_2_card_number",
"guarantor_2_card_name",
"guarantor_2_card_month",
"guarantor_2_card_year",
"guarantor_note",
"guarantor_2_note",
"satisfiable",
"status",
"notes",
"created_at",
"updated_at"
],
"title": "LoanOrderShowResource"
},
"LoanOrderStoreRequest": {
"type": "object",
"properties": {
"loan_type": {
"type": "integer",
"description": "Loan type id (https://online.tbbank.gov.tm/api/loan-types)"
},
"loan_amount": {
"type": "integer",
"description": "Loan amount",
"example": 20000,
"maximum": 40000
},
"region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
]
},
"branch_id": {
"type": "integer",
"description": "Branch id (https://online.tbbank.gov.tm/api/branches)"
},
"customer_name": {
"type": "string",
"description": "Customer name",
"example": "Mahmyt",
"maxLength": 255
},
"customer_surname": {
"type": "string",
"description": "Customer surname",
"example": "Allaberdiyev",
"maxLength": 255
},
"customer_patronic_name": {
"type": [
"string",
"null"
],
"description": "Customer patronic name",
"example": "Öwezowiç",
"maxLength": 255
},
"born_at": {
"type": "string",
"description": "Date of birth",
"example": "2000"
},
"education": {
"type": "string",
"description": "Education (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"school_drop_out",
"school",
"middle_school",
"Unfinished_high_education",
"high_education",
"masters",
"phd"
]
},
"marriage_status": {
"type": "string",
"description": "Marriage status (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"married",
"legal_marriage",
"divorced",
"WIDOW",
"single"
]
},
"passport_address": {
"type": "string",
"description": "Passport address",
"example": "Kemine 100/190",
"maxLength": 255
},
"real_address": {
"type": "string",
"description": "Real address",
"example": "Kemine 100/200",
"maxLength": 255
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
]
},
"passport_id": {
"type": "number",
"description": "Passport number",
"example": 100999
},
"passport_given_at": {
"type": "string",
"format": "date-time",
"description": "Passport date of issue",
"example": "2024-01-10"
},
"passport_given_by": {
"type": "string",
"description": "Passport given by",
"example": "Ashgabat shaher polisiya tarapyndan",
"maxLength": 255
},
"born_place": {
"type": "string",
"description": "Born place",
"example": "Ashgabat shaher",
"maxLength": 255
},
"email": {
"type": [
"string",
"null"
],
"format": "email",
"description": "Email",
"example": "mahmyt1206@gmail.com",
"maxLength": 255
},
"phone": {
"type": "integer",
"description": "Phone number",
"example": 65999990
},
"phone_additional": {
"type": [
"integer",
"null"
],
"description": "Phone number (additional)",
"example": 61126667
},
"phone_home": {
"type": "string",
"description": "Phone number (home)",
"example": "92-92-92",
"maxLength": 255
},
"card_number": {
"type": "string",
"description": "Card number",
"example": "4434345434423442"
},
"card_name": {
"type": "string",
"description": "Name on card",
"example": "'Mahmyt Allaberdiyev'",
"maxLength": 255
},
"card_month": {
"type": "string",
"description": "Card expiration month",
"example": "06"
},
"card_year": {
"type": "string",
"description": "Card expiration year",
"example": "2040"
},
"loan_card_number": {
"type": [
"string",
"null"
],
"description": "Card number",
"example": "4434345434423442"
},
"loan_card_name": {
"type": [
"string",
"null"
],
"description": "Name on card",
"example": "'Mahmyt Allaberdiyev'",
"maxLength": 255
},
"loan_card_month": {
"type": [
"string",
"null"
],
"description": "Card expiration month",
"example": "06"
},
"loan_card_year": {
"type": [
"string",
"null"
],
"description": "Card expiration year",
"example": "2040"
},
"work_region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
]
},
"work_province_id": {
"type": "integer",
"description": "Provinces (https://online.tbbank.gov.tm/api/provinces)"
},
"work_company": {
"type": "string",
"description": "Work company name",
"example": "WebUglam HJ",
"maxLength": 255
},
"work_company_accountant_number": {
"type": "string",
"description": "HR department number",
"example": "707012",
"maxLength": 255
},
"work_position": {
"type": "string",
"description": "Work position",
"example": "Bugalter",
"maxLength": 255
},
"work_salary": {
"type": "number",
"description": "Salary",
"example": 40000
},
"work_started_at": {
"type": "string",
"format": "date-time",
"description": "Work start date",
"example": "2024-01-16"
},
"passport_one": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Passport (sahypa 1)",
"maxLength": 2048
},
"passport_two": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (2-3-nji sahypa)",
"maxLength": 2048
},
"passport_three": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (8-9 sahypa)",
"maxLength": 2048
},
"passport_four": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (32-nji sahypa)",
"maxLength": 2048
},
"guarantor_name": {
"type": "string",
"description": "Guarantor name",
"example": "Mahmyt",
"maxLength": 255
},
"guarantor_surname": {
"type": "string",
"description": "Guarantor surname",
"example": "Allaberdiev",
"maxLength": 255
},
"guarantor_patronic_name": {
"type": [
"string",
"null"
],
"description": "Guarantor surname",
"example": "Owezowic",
"maxLength": 255
},
"guarantor_card_number": {
"type": "string",
"description": "Guarantor card number",
"example": "4323344234423443"
},
"guarantor_card_name": {
"type": "string",
"description": "Guarantor name on card",
"example": "Mahmyt Allaberdiyev",
"maxLength": 255
},
"guarantor_card_month": {
"type": "string",
"description": "Guarantor Card month",
"example": "06"
},
"guarantor_card_year": {
"type": "string",
"description": "Guarantor Card year",
"example": "2040"
},
"guarantor_passport_serie": {
"type": "string",
"description": "Guarantor Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"guarantor_passport_id": {
"type": "number",
"description": "Guarantor Passport number",
"example": 100999
},
"guarantor_2_name": {
"type": "string",
"description": "2. Guarantor name",
"example": "Mahmyt",
"maxLength": 255
},
"guarantor_2_surname": {
"type": "string",
"description": "2. Guarantor surname",
"example": "Allaberdiev",
"maxLength": 255
},
"guarantor_2_patronic_name": {
"type": [
"string",
"null"
],
"description": "2. Guarantor patronic name",
"example": "Owezowich",
"maxLength": 255
},
"guarantor_2_card_number": {
"type": "string",
"description": "2. Guarantor card number",
"example": "4323344234423443"
},
"guarantor_2_card_name": {
"type": "string",
"description": "2. Guarantor name on card",
"example": "Mahmyt Allaberdiyev"
},
"guarantor_2_card_month": {
"type": "string",
"description": "2. Guarantor Card month",
"example": "06"
},
"guarantor_2_card_year": {
"type": "string",
"description": "2. Guarantor Card year",
"example": "2040"
},
"guarantor_2_passport_serie": {
"type": "string",
"description": "Guarantor Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"guarantor_2_passport_id": {
"type": "number",
"description": "Guarantor Passport number",
"example": 100999
}
},
"required": [
"loan_type",
"loan_amount",
"region",
"branch_id",
"customer_name",
"customer_surname",
"born_at",
"education",
"marriage_status",
"passport_address",
"real_address",
"passport_serie",
"passport_id",
"passport_given_at",
"passport_given_by",
"born_place",
"phone",
"phone_home",
"card_number",
"card_name",
"card_month",
"card_year",
"work_region",
"work_province_id",
"work_company",
"work_company_accountant_number",
"work_position",
"work_salary",
"work_started_at",
"passport_one",
"passport_two",
"passport_three",
"passport_four",
"guarantor_name",
"guarantor_surname",
"guarantor_card_number",
"guarantor_card_name",
"guarantor_card_month",
"guarantor_card_year",
"guarantor_passport_serie",
"guarantor_passport_id"
],
"title": "LoanOrderStoreRequest"
},
"LoanOrderUpdateRequest": {
"type": "object",
"properties": {
"loan_type": {
"type": "integer",
"description": "Loan type id (https://online.tbbank.gov.tm/api/loan-types)"
},
"loan_amount": {
"type": "integer",
"description": "Loan amount",
"example": 20000,
"maximum": 40000
},
"region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
]
},
"branch_id": {
"type": "integer",
"description": "Branch id (https://online.tbbank.gov.tm/api/branches)"
},
"customer_name": {
"type": "string",
"description": "Customer name",
"example": "Mahmyt",
"maxLength": 255
},
"customer_surname": {
"type": "string",
"description": "Customer surname",
"example": "Allaberdiyev",
"maxLength": 255
},
"customer_patronic_name": {
"type": [
"string",
"null"
],
"description": "Customer patronic name",
"example": "Öwezowiç",
"maxLength": 255
},
"born_at": {
"type": "string",
"description": "Date of birth",
"example": "2000"
},
"education": {
"type": "string",
"description": "Education (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"school_drop_out",
"school",
"middle_school",
"Unfinished_high_education",
"high_education",
"masters",
"phd"
]
},
"marriage_status": {
"type": "string",
"description": "Marriage status (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"married",
"legal_marriage",
"divorced",
"WIDOW",
"single"
]
},
"passport_address": {
"type": "string",
"description": "Passport address",
"example": "Kemine 100/190",
"maxLength": 255
},
"real_address": {
"type": "string",
"description": "Real address",
"example": "Kemine 100/200",
"maxLength": 255
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
]
},
"passport_id": {
"type": "number",
"description": "Passport number",
"example": 100999
},
"passport_given_at": {
"type": "string",
"format": "date-time",
"description": "Passport date of issue",
"example": "2024-01-10"
},
"passport_given_by": {
"type": "string",
"description": "Passport given by",
"example": "Ashgabat shaher polisiya tarapyndan",
"maxLength": 255
},
"born_place": {
"type": "string",
"description": "Born place",
"example": "Ashgabat shaher",
"maxLength": 255
},
"email": {
"type": [
"string",
"null"
],
"format": "email",
"description": "Email",
"example": "mahmyt1206@gmail.com",
"maxLength": 255
},
"phone": {
"type": "integer",
"description": "Phone number",
"example": 65999990
},
"phone_additional": {
"type": [
"integer",
"null"
],
"description": "Phone number (additional)",
"example": 61126667
},
"phone_home": {
"type": "string",
"description": "Phone number (home)",
"example": "92-92-92",
"maxLength": 255
},
"card_number": {
"type": "string",
"description": "Card number",
"example": "4434345434423442"
},
"card_name": {
"type": "string",
"description": "Name on card",
"example": "'Mahmyt Allaberdiyev'",
"maxLength": 255
},
"card_month": {
"type": "string",
"description": "Card expiration month",
"example": "06"
},
"card_year": {
"type": "string",
"description": "Card expiration year",
"example": "2040"
},
"loan_card_number": {
"type": [
"string",
"null"
],
"description": "Card number",
"example": "4434345434423442"
},
"loan_card_name": {
"type": [
"string",
"null"
],
"description": "Name on card",
"example": "'Mahmyt Allaberdiyev'",
"maxLength": 255
},
"loan_card_month": {
"type": [
"string",
"null"
],
"description": "Card expiration month",
"example": "06"
},
"loan_card_year": {
"type": [
"string",
"null"
],
"description": "Card expiration year",
"example": "2040"
},
"work_region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
]
},
"work_province_id": {
"type": "integer",
"description": "Provinces (https://online.tbbank.gov.tm/api/provinces)"
},
"work_company": {
"type": "string",
"description": "Work company name",
"example": "WebUglam HJ",
"maxLength": 255
},
"work_company_accountant_number": {
"type": "string",
"description": "HR department number",
"example": "707012",
"maxLength": 255
},
"work_position": {
"type": "string",
"description": "Work position",
"example": "Bugalter",
"maxLength": 255
},
"work_salary": {
"type": "number",
"description": "Salary",
"example": 40000
},
"work_started_at": {
"type": "string",
"format": "date-time",
"description": "Work start date",
"example": "2024-01-16"
},
"passport_one": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Passport (sahypa 1)",
"maxLength": 2048
},
"passport_two": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (2-3-nji sahypa)",
"maxLength": 2048
},
"passport_three": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (8-9 sahypa)",
"maxLength": 2048
},
"passport_four": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Pasport (32-nji sahypa)",
"maxLength": 2048
},
"guarantor_name": {
"type": "string",
"description": "Guarantor name",
"example": "Mahmyt",
"maxLength": 255
},
"guarantor_surname": {
"type": "string",
"description": "Guarantor surname",
"example": "Allaberdiev",
"maxLength": 255
},
"guarantor_patronic_name": {
"type": "string",
"description": "Guarantor surname",
"example": "Owezowic",
"maxLength": 255
},
"guarantor_card_number": {
"type": "string",
"description": "Guarantor card number",
"example": "4323344234423443"
},
"guarantor_card_name": {
"type": "string",
"description": "Guarantor name on card",
"example": "Mahmyt Allaberdiyev",
"maxLength": 255
},
"guarantor_card_month": {
"type": "string",
"description": "Guarantor Card month",
"example": "06"
},
"guarantor_card_year": {
"type": "string",
"description": "Guarantor Card year",
"example": "2040"
},
"guarantor_passport_serie": {
"type": "string",
"description": "Guarantor Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"guarantor_passport_id": {
"type": "number",
"description": "Guarantor Passport number",
"example": 100999
},
"guarantor_2_name": {
"type": "string",
"description": "2. Guarantor name",
"example": "Mahmyt",
"maxLength": 255
},
"guarantor_2_surname": {
"type": "string",
"description": "2. Guarantor surname",
"example": "Allaberdiev",
"maxLength": 255
},
"guarantor_2_patronic_name": {
"type": [
"string",
"null"
],
"description": "2. Guarantor patronic name",
"example": "Owezowich",
"maxLength": 255
},
"guarantor_2_card_number": {
"type": "string",
"description": "2. Guarantor card number",
"example": "4323344234423443"
},
"guarantor_2_card_name": {
"type": "string",
"description": "2. Guarantor name on card",
"example": "Mahmyt Allaberdiyev"
},
"guarantor_2_card_month": {
"type": "string",
"description": "2. Guarantor Card month",
"example": "06"
},
"guarantor_2_card_year": {
"type": "string",
"description": "2. Guarantor Card year",
"example": "2040"
},
"guarantor_2_passport_serie": {
"type": "string",
"description": "Guarantor Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"guarantor_2_passport_id": {
"type": "number",
"description": "Guarantor Passport number",
"example": 100999
}
},
"required": [
"card_month",
"card_year"
],
"title": "LoanOrderUpdateRequest"
},
"LoanPaidOffLetterOrderIndexResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"unique_id": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": "integer"
},
"region": {
"type": "string"
},
"branch_id": {
"type": "string"
},
"customer_name": {
"type": "string"
},
"customer_surname": {
"type": "string"
},
"customer_patronic_name": {
"type": [
"string",
"null"
]
},
"born_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"phone": {
"type": [
"string",
"null"
]
},
"passport_serie": {
"type": "string"
},
"passport_id": {
"type": "string"
},
"status": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"loan_contract_number": {
"type": [
"string",
"null"
]
},
"loan_contract_date": {
"type": [
"string",
"null"
]
},
"loan_amount": {
"type": [
"string",
"null"
]
},
"loan_reason": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"unique_id",
"user_id",
"region",
"branch_id",
"customer_name",
"customer_surname",
"customer_patronic_name",
"born_at",
"phone",
"passport_serie",
"passport_id",
"status",
"notes",
"loan_contract_number",
"loan_contract_date",
"loan_amount",
"loan_reason",
"created_at",
"updated_at"
],
"title": "LoanPaidOffLetterOrderIndexResource"
},
"LoanPaidOffLetterOrderStoreRequest": {
"type": "object",
"properties": {
"region": {
"type": "string",
"description": "Region (https://online.tbbank.gov.tm/api/base-app-enums)",
"enum": [
"ag",
"ak",
"mr",
"ah",
"lb",
"bn",
"dz"
]
},
"branch_id": {
"type": "integer",
"description": "Branch id (https://online.tbbank.gov.tm/api/branches)"
},
"customer_name": {
"type": "string",
"description": "Customer name",
"example": "Mahmyt",
"maxLength": 255
},
"customer_surname": {
"type": "string",
"description": "Customer surname",
"example": "Allaberdiyev",
"maxLength": 255
},
"customer_patronic_name": {
"type": [
"string",
"null"
],
"description": "Customer patronic name",
"example": "Öwezowiç",
"maxLength": 255
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
]
},
"passport_id": {
"type": "number",
"description": "Passport number",
"example": 100999
},
"born_at": {
"type": "string",
"description": "Date of birth",
"example": "10.10.2000"
},
"phone": {
"type": "integer",
"description": "Phone number",
"example": 65999990
},
"loan_contract_number": {
"type": "string",
"description": "Contract number",
"example": "3242358989234",
"maxLength": 255
},
"loan_contract_date": {
"type": "string",
"description": "Contract date",
"example": "20.34.23",
"maxLength": 255
},
"loan_amount": {
"type": "string",
"description": "Loan amount",
"example": "20000",
"maxLength": 255
},
"loan_reason": {
"type": "string",
"description": "Loan reason",
"example": "Puldan pul yasamak ucin",
"maxLength": 255
}
},
"required": [
"region",
"branch_id",
"customer_name",
"customer_surname",
"passport_serie",
"passport_id",
"born_at",
"phone",
"loan_contract_number",
"loan_contract_date",
"loan_amount",
"loan_reason"
],
"title": "LoanPaidOffLetterOrderStoreRequest"
},
"LoanRemainingOrder": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"passport_serie": {
"type": "string"
},
"passport_id": {
"type": "string"
},
"account_number": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"user_id": {
"type": "integer"
}
},
"required": [
"id",
"passport_serie",
"passport_id",
"account_number",
"created_at",
"updated_at",
"user_id"
],
"title": "LoanRemainingOrder"
},
"ProfileResponse": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"phone": {
"type": [
"string",
"null"
]
},
"passport_serie": {
"type": "string"
},
"passport_id": {
"type": "string"
},
"card_number": {
"type": "string"
},
"card_month": {
"type": "string"
},
"card_year": {
"type": "string"
},
"card_name": {
"type": "string"
}
},
"required": [
"name",
"phone",
"passport_serie",
"passport_id",
"card_number",
"card_month",
"card_year",
"card_name"
],
"title": "ProfileResponse"
},
"UpdateUserProfileRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Phone number to authenticate",
"example": "Mahmyt Allaberdiyev",
"maxLength": 255
},
"phone": {
"type": "integer",
"description": "Phone number to authenticate",
"example": 65707012
},
"password": {
"type": [
"string",
"null"
],
"description": "Password (leave empty to save it same)",
"example": "MyFcpassword"
},
"passport_serie": {
"type": "string",
"description": "Passport serie",
"enum": [
"I-AS",
"I-MR",
"II-MR",
"I-AH",
"II-AH",
"I-LB",
"II-LB",
"I-BN",
"II-BN",
"I-DZ",
"II-DZ"
],
"example": "I-AS"
},
"passport_id": {
"type": "number",
"description": "Passport id",
"example": 100999
},
"card_number": {
"type": "string",
"example": "9934612100000543"
},
"card_month": {
"type": "string",
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12"
],
"example": "12"
},
"card_year": {
"type": "string",
"enum": [
"2024",
"2025",
"2026",
"2027",
"2028",
"2029",
"2030",
"2031",
"2032",
"2033",
"2034",
"2035",
"2036",
"2037",
"2038",
"2039",
"2040",
"2041",
"2042",
"2043",
"2044",
"2045",
"2046",
"2047",
"2048",
"2049",
"2050",
"2051",
"2052",
"2053",
"2054",
"2055",
"2056",
"2057",
"2058",
"2059",
"2060",
"2061",
"2062",
"2063",
"2064",
"2065",
"2066",
"2067",
"2068",
"2069",
"2070",
"2071",
"2072",
"2073",
"2074",
"2075",
"2076",
"2077",
"2078",
"2079",
"2080",
"2081",
"2082",
"2083",
"2084",
"2085",
"2086",
"2087",
"2088",
"2089",
"2090"
],
"example": "2049"
},
"card_name": {
"type": "string",
"example": "Nurmuhammet Allanov",
"maxLength": 255
}
},
"required": [
"name",
"phone"
],
"title": "UpdateUserProfileRequest"
}
},
"responses": {
"ValidationException": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Errors overview."
},
"errors": {
"type": "object",
"description": "A detailed description of each field that failed validation.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"AuthenticationException": {
"description": "Unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"ModelNotFoundException": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink