{ "openapi": "3.0.1", "info": { "title": "SkipCash API", "version": "v1" }, "servers": [ { "url": "https://api.skipcash.app:80" } ], "paths": { "/api/Accounts": { "get": { "tags": [ "Accounts" ], "summary": "This method provides basic information about account.", "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Other": { "put": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOtherAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOtherAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOtherAccountRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Cards": { "get": { "tags": [ "Accounts" ], "summary": "This method provides list of cards which are related to the account.", "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Accounts" ], "summary": "This method provides possibility to add new card to account.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddCardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddCardRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Cards/Token": { "get": { "tags": [ "Accounts" ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Cards/cs": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "PaRes": { "type": "string", "nullable": true } } }, "encoding": { "PaRes": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Cards/{id}": { "put": { "tags": [ "Accounts" ], "summary": "This method provides possibility to update card's properties.", "parameters": [ { "name": "id", "in": "path", "description": "Card Id", "required": true, "schema": { "type": "string", "description": "Card Id", "format": "uuid" } } ], "requestBody": { "description": "Card object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCardRequest" } } } }, "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Accounts" ], "summary": "This method provides possibility to Delete card.", "parameters": [ { "name": "id", "in": "path", "description": "Card Id", "required": true, "schema": { "type": "string", "description": "Card Id", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Cards/Verification/{id}": { "post": { "tags": [ "Accounts" ], "summary": "This method provides possibility to verify card against payment gate.", "parameters": [ { "name": "id", "in": "path", "description": "Card id.", "required": true, "schema": { "type": "string", "description": "Card id.", "format": "uuid" } } ], "requestBody": { "description": "Request to verify card.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardVerificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CardVerificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CardVerificationRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Delete": { "post": { "tags": [ "Accounts" ], "summary": "This method provides possibility to delete account.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteAccountRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/DeleteOther/{id}": { "post": { "tags": [ "Accounts" ], "summary": "This method provides possibility to delete account.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteAccountRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Email": { "put": { "tags": [ "Accounts" ], "summary": "This method provide possibility to update email.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Email/Success": { "get": { "tags": [ "Accounts" ], "summary": "This method provides possibility to confirm email.", "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Email/Confirm/{confirmationValue}": { "get": { "tags": [ "Accounts" ], "parameters": [ { "name": "confirmationValue", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Email/Validate": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateEmailRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Email/TurnOfNewsletters/{id}": { "get": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Email/Confirmed/{id}": { "get": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Login": { "post": { "tags": [ "Accounts" ], "summary": "this method provides possibility to log in to application via User name and password or PIN", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginConfirmRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginConfirmRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginConfirmRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/ExtLogin": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginConfirmRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginConfirmRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginConfirmRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Login/Cashier": { "post": { "tags": [ "Accounts" ], "summary": "This method provides possibility for BranchManager or Group manager to login as cashier", "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Login/Verify": { "post": { "tags": [ "Accounts" ], "summary": "This method provides possibility for BranchManager or Group manager to login as shopper", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Register": { "post": { "tags": [ "Accounts" ], "summary": "This method provides possibility to register new user.", "requestBody": { "description": "Contains properties which are available for the user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Password": { "post": { "tags": [ "Accounts" ], "summary": "This method provides possibility to set password.", "requestBody": { "description": "Password.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Password/Validate": { "post": { "tags": [ "Accounts" ], "summary": "This method provides possibility to validate password.", "requestBody": { "description": "The request with password.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidatePasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidatePasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidatePasswordRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Password/UnAuthorizedChange/{email}": { "get": { "tags": [ "Accounts" ], "summary": "This method provides possibility to reset password.", "parameters": [ { "name": "email", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Password/Reset/Success": { "get": { "tags": [ "Accounts" ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Password/Reset/{id}": { "post": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Password": { "type": "string", "nullable": true }, "PasswordConfirm": { "type": "string", "nullable": true } } }, "encoding": { "Password": { "style": "form" }, "PasswordConfirm": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } }, "get": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Password/Reset": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Password/Set": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Phone/Validate": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidatePhoneRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidatePhoneRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidatePhoneRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Phone/Confirm": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmPhoneRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfirmPhoneRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConfirmPhoneRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Phone/CheckShopperPhone": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckShopperPhoneRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CheckShopperPhoneRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CheckShopperPhoneRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Phone": { "put": { "tags": [ "Accounts" ], "summary": "This method provides possibility to set phone number.", "requestBody": { "description": "Phone number.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidatePhoneRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidatePhoneRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidatePhoneRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Foto": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ContentType": { "type": "string", "nullable": true }, "ContentDisposition": { "type": "string", "nullable": true }, "Headers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "Length": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "FileName": { "type": "string", "nullable": true } } }, "encoding": { "ContentType": { "style": "form" }, "ContentDisposition": { "style": "form" }, "Headers": { "style": "form" }, "Length": { "style": "form" }, "Name": { "style": "form" }, "FileName": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Accounts" ], "responses": { "200": { "description": "Success" } } }, "get": { "tags": [ "Accounts" ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/image": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ContentType": { "type": "string", "nullable": true }, "ContentDisposition": { "type": "string", "nullable": true }, "Headers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "Length": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "FileName": { "type": "string", "nullable": true }, "fileTypeId": { "type": "integer", "format": "int32" }, "resourceId": { "type": "string", "format": "uuid", "nullable": true } } }, "encoding": { "ContentType": { "style": "form" }, "ContentDisposition": { "style": "form" }, "Headers": { "style": "form" }, "Length": { "style": "form" }, "Name": { "style": "form" }, "FileName": { "style": "form" }, "fileTypeId": { "style": "form" }, "resourceId": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/UserStatus/{id}": { "post": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeUserStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeUserStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeUserStatusRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/ValidateToken": { "get": { "tags": [ "Accounts" ], "summary": "Returns lias of available foto sizes.", "parameters": [ { "name": "appVersion", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/faq": { "get": { "tags": [ "Accounts" ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Language": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetLanguageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetLanguageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetLanguageRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/FastPayment": { "put": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFastPaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetFastPaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetFastPaymentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/FastPaymentGlobal": { "put": { "tags": [ "Accounts" ], "parameters": [ { "name": "enable", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Organizations": { "get": { "tags": [ "Accounts" ], "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/Organization": { "put": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssignOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AssignOrganizationRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Accounts/random-status": { "post": { "tags": [ "Accounts" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "time", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Categories": { "get": { "tags": [ "Categories" ], "parameters": [ { "name": "language", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Coupons": { "get": { "tags": [ "Coupons" ], "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/{id}": { "get": { "tags": [ "Coupons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Coupons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCouponRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCouponRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCouponRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/Merchant/CashDesk/{id}/available": { "get": { "tags": [ "Coupons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/UsageCount": { "get": { "tags": [ "Coupons" ], "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/Merchant/Payment/{id}": { "get": { "tags": [ "Coupons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/{id}/Logo": { "post": { "tags": [ "Coupons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ContentType": { "type": "string", "nullable": true }, "ContentDisposition": { "type": "string", "nullable": true }, "Headers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "Length": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "FileName": { "type": "string", "nullable": true } } }, "encoding": { "ContentType": { "style": "form" }, "ContentDisposition": { "style": "form" }, "Headers": { "style": "form" }, "Length": { "style": "form" }, "Name": { "style": "form" }, "FileName": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } }, "get": { "tags": [ "Coupons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/signup": { "get": { "tags": [ "Coupons" ], "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/dashboard": { "get": { "tags": [ "Coupons" ], "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/categories": { "get": { "tags": [ "Coupons" ], "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/company-name": { "get": { "tags": [ "Coupons" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/company": { "post": { "tags": [ "Coupons" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouponCompanySearchFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CouponCompanySearchFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CouponCompanySearchFilter" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Coupons/company/{id}": { "get": { "tags": [ "Coupons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/payer/auth/generate-token": { "post": { "tags": [ "CreditCard" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerAuthCaptureContext" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayerAuthCaptureContext" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayerAuthCaptureContext" } } } }, "responses": { "200": { "description": "Success" } } } }, "/payer/auth/setup": { "post": { "tags": [ "CreditCard" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerAuthSetupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayerAuthSetupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayerAuthSetupRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/payer/auth/enrollment": { "post": { "tags": [ "CreditCard" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerAuthEnrollmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayerAuthEnrollmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayerAuthEnrollmentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/payer/auth/validation": { "post": { "tags": [ "CreditCard" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerAuthValidationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayerAuthValidationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayerAuthValidationRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/payer/auth/bin-validation": { "post": { "tags": [ "CreditCard" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerAuthBinValidation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayerAuthBinValidation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayerAuthBinValidation" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Files/upload": { "post": { "tags": [ "Files" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ContentType": { "type": "string", "nullable": true }, "ContentDisposition": { "type": "string", "nullable": true }, "Headers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "Length": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "FileName": { "type": "string", "nullable": true }, "fileTypeId": { "type": "integer", "format": "int32" }, "resourceId": { "type": "string", "format": "uuid", "nullable": true } } }, "encoding": { "ContentType": { "style": "form" }, "ContentDisposition": { "style": "form" }, "Headers": { "style": "form" }, "Length": { "style": "form" }, "Name": { "style": "form" }, "FileName": { "style": "form" }, "fileTypeId": { "style": "form" }, "resourceId": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Files/upload-image": { "post": { "tags": [ "Files" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ContentType": { "type": "string", "nullable": true }, "ContentDisposition": { "type": "string", "nullable": true }, "Headers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "Length": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "FileName": { "type": "string", "nullable": true }, "fileTypeId": { "type": "integer", "format": "int32" }, "resourceId": { "type": "string", "format": "uuid", "nullable": true } } }, "encoding": { "ContentType": { "style": "form" }, "ContentDisposition": { "style": "form" }, "Headers": { "style": "form" }, "Length": { "style": "form" }, "Name": { "style": "form" }, "FileName": { "style": "form" }, "fileTypeId": { "style": "form" }, "resourceId": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Files/{id}": { "delete": { "tags": [ "Files" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Files/download-apk": { "get": { "tags": [ "Files" ], "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/MerchantDetails": { "get": { "tags": [ "Merchants" ], "summary": "This method provides List of Branches and Branches Users info", "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/Settings": { "put": { "tags": [ "Merchants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MerchantSettingsRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/{id}/Logo": { "get": { "tags": [ "Merchants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Merchants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ContentType": { "type": "string", "nullable": true }, "ContentDisposition": { "type": "string", "nullable": true }, "Headers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "Length": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "FileName": { "type": "string", "nullable": true } } }, "encoding": { "ContentType": { "style": "form" }, "ContentDisposition": { "style": "form" }, "Headers": { "style": "form" }, "Length": { "style": "form" }, "Name": { "style": "form" }, "FileName": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/MerchantMap": { "post": { "tags": [ "Merchants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantMapData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantMapData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MerchantMapData" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/LegalDocuments": { "get": { "tags": [ "Merchants" ], "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/LegalDocument": { "post": { "tags": [ "Merchants" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Version": { "type": "string", "nullable": true }, "FileTypeId": { "type": "integer", "format": "int32" }, "File": { "type": "string", "format": "binary", "nullable": true }, "ValidFrom": { "type": "string", "format": "date-time" }, "FileType.FileTypeId": { "type": "integer", "format": "int32" }, "FileType.IsLegalDocument": { "type": "boolean" }, "FileType.IsImage": { "type": "boolean" }, "FileType.AllowMultipleFilesOnSameIdentifer": { "type": "boolean" } } }, "encoding": { "Version": { "style": "form" }, "FileTypeId": { "style": "form" }, "File": { "style": "form" }, "ValidFrom": { "style": "form" }, "FileType.FileTypeId": { "style": "form" }, "FileType.IsLegalDocument": { "style": "form" }, "FileType.IsImage": { "style": "form" }, "FileType.AllowMultipleFilesOnSameIdentifer": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/{id}/SignupDocument": { "post": { "tags": [ "Merchants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/DeleteFile/{id}": { "post": { "tags": [ "Merchants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/ChangeUserPassword": { "post": { "tags": [ "Merchants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantPasswordChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantPasswordChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MerchantPasswordChangeRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/ChangeUserName": { "post": { "tags": [ "Merchants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantUserNameChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantUserNameChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MerchantUserNameChangeRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/BankAccount": { "get": { "tags": [ "Merchants" ], "parameters": [ { "name": "merchantId", "in": "query", "schema": { "type": "string", "format": "uuid", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/Status/{id}": { "post": { "tags": [ "Merchants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCompanyStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeCompanyStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeCompanyStatusRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/Test": { "get": { "tags": [ "Merchants" ], "responses": { "200": { "description": "Success" } } } }, "/api/Merchants/opkc": { "put": { "tags": [ "Merchants" ], "responses": { "200": { "description": "Success" } } } }, "/api/MerchantsBranches/QR/{code}": { "get": { "tags": [ "MerchantsBranches" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/MerchantsBranches": { "post": { "tags": [ "MerchantsBranches" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantBranchesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantBranchesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MerchantBranchesRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/MerchantsBranches/{id}": { "get": { "tags": [ "MerchantsBranches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/MerchantsBranches/BranchDetails": { "get": { "tags": [ "MerchantsBranches" ], "responses": { "200": { "description": "Success" } } } }, "/nfc": { "get": { "tags": [ "Nfc" ], "responses": { "200": { "description": "Success" } } } }, "/api/Notifications": { "get": { "tags": [ "Notifications" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOnlinePaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOnlinePaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOnlinePaymentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/update": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentAmountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentAmountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentAmountRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/update-card": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCardPaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCardPaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCardPaymentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/mit": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMITPaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMITPaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMITPaymentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/capture": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CyberCaptureAndReversalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CyberCaptureAndReversalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CyberCaptureAndReversalRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/capture-reversals": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CyberCaptureAndReversalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CyberCaptureAndReversalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CyberCaptureAndReversalRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/refund": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundOnlinePaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefundOnlinePaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefundOnlinePaymentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/{id}": { "options": { "tags": [ "OnlinePayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } }, "get": { "tags": [ "OnlinePayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/details": { "get": { "tags": [ "OnlinePayments" ], "parameters": [ { "name": "custom1", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "transactionId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/apple/{id}/pay-mc": { "options": { "tags": [ "OnlinePayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "OnlinePayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplePayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplePayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplePayRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/apple/{id}/pay": { "options": { "tags": [ "OnlinePayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "OnlinePayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplePayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplePayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplePayRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/subscription/cancel": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CancelSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/cancel/{id}": { "post": { "tags": [ "OnlinePayments" ], "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/debit-card/{id}": { "post": { "tags": [ "OnlinePayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/gp/pay": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GooglePayMerchantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GooglePayMerchantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GooglePayMerchantRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/gp/status/{id}": { "get": { "tags": [ "OnlinePayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/gp/setup": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GooglePaySetup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GooglePaySetup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GooglePaySetup" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/gp/enroll": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GooglePayEnrollmentMerchantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GooglePayEnrollmentMerchantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GooglePayEnrollmentMerchantRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/gp/validate": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GooglePayEnrollmentMerchantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GooglePayEnrollmentMerchantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GooglePayEnrollmentMerchantRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/resetRecurring": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOnlinePaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOnlinePaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOnlinePaymentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/payments/transactionData": { "post": { "tags": [ "OnlinePayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionDataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransactionDataRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/pay/{id}": { "get": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlinePaymentUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnlinePaymentUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OnlinePaymentUpdateRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/pay/sample/form": { "get": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "responses": { "200": { "description": "Success" } } } }, "/pay/{id}/payLater": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/pay/{id}/payLater/response": { "get": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/pay/{id}/debit": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/pay/dc/res": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "responses": { "200": { "description": "Success" } } } }, "/pay/cs": { "get": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "responses": { "200": { "description": "Success" } } } }, "/pay/cs/setup": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "responses": { "200": { "description": "Success" } } } }, "/pay/cs/enroll": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlinePaymentEnrollmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnlinePaymentEnrollmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OnlinePaymentEnrollmentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/pay/cs/returnUrl/{id}": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/pay/cs/validate": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "responses": { "200": { "description": "Success" } } } }, "/token/cardDetails/{id}": { "get": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { } } }, "application/json": { "schema": { "type": "array", "items": { } } }, "text/json": { "schema": { "type": "array", "items": { } } } } } } } }, "/token/delete/{id}": { "delete": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/pay/cs/proc": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "responses": { "200": { "description": "Success" } } } }, "/pay/{id}/receipt": { "get": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/pay/{id}/validateSession": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppleValidateSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AppleValidateSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AppleValidateSessionRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/pay/{id}/applePay": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplePayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplePayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplePayRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/pay/{id}/googlePay": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GooglePayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GooglePayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GooglePayRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/pay/{id}/googlePay/res": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/pay/{id}/googlePay/status": { "get": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/cancel/{id}": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/case/{id}": { "get": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/case/{id}/status": { "get": { "tags": [ "OnlinePaymentsWithCardinalStandard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/pay2/{id}": { "get": { "tags": [ "OnlinePaymentsWithCardinalStandardTest" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/pay2/verify": { "post": { "tags": [ "OnlinePaymentsWithCardinalStandardTest" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlinePaymentCardinalStandardVerifyTestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnlinePaymentCardinalStandardVerifyTestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OnlinePaymentCardinalStandardVerifyTestModel" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/webhooks/paylater": { "post": { "tags": [ "PayLaterWebhook" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayLaterWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayLaterWebhookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayLaterWebhookRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Payments": { "post": { "tags": [ "Payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentRequestOld" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentRequestOld" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePaymentRequestOld" } } } }, "responses": { "200": { "description": "Success" } } }, "get": { "tags": [ "Payments" ], "parameters": [ { "name": "type", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Payments/{id}": { "put": { "tags": [ "Payments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentRequest" } } } }, "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Payments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Payments/{id}/pay": { "post": { "tags": [ "Payments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Payments/{id}/enroll": { "post": { "tags": [ "Payments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PayRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Payments/{id}/validate": { "post": { "tags": [ "Payments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Payments/{transactionId}/Rate": { "post": { "tags": [ "Payments" ], "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RateRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Payments/{id}/reject": { "post": { "tags": [ "Payments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectPaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RejectPaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RejectPaymentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Payments/{Id}": { "get": { "tags": [ "Payments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Payments/{transactionId}/receipt-id": { "post": { "tags": [ "Payments" ], "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiptIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReceiptIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReceiptIdRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Payments2": { "post": { "tags": [ "Payments2" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePaymentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Payments2/{id}": { "put": { "tags": [ "Payments2" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Payments2/assign-shopper": { "put": { "tags": [ "Payments2" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignShopperRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssignShopperRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AssignShopperRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Payments2/{Id}": { "get": { "tags": [ "Payments2" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Reports/MerchantPaymentReport": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportsFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportsFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportsFilter" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/TapToPhone": { "post": { "tags": [ "TapToPhone" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TapToPhoneTransactionDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TapToPhoneTransactionDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TapToPhoneTransactionDTO" } } } }, "responses": { "200": { "description": "Success" } } }, "get": { "tags": [ "TapToPhone" ], "parameters": [ { "name": "ReqUserId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "PaymentStatus", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "DateFrom", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "DateTo", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "CompanyId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "UniqueId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Transactions": { "post": { "tags": [ "Transactions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransactionRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Transactions/{id}": { "get": { "tags": [ "Transactions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Transactions/{id}/Receipt": { "post": { "tags": [ "Transactions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Transactions/{id}/Refund": { "post": { "tags": [ "Transactions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundTransactionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefundTransactionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefundTransactionRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Transactions/{id}/RefundAdmin": { "post": { "tags": [ "Transactions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefundRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefundRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Transactions/SpendingReport": { "get": { "tags": [ "Transactions" ], "parameters": [ { "name": "year", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Transactions/EarningReport": { "get": { "tags": [ "Transactions" ], "parameters": [ { "name": "year", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Transactions/EarningReport/{id}": { "get": { "tags": [ "Transactions" ], "parameters": [ { "name": "year", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Transactions/SetWasSeen": { "post": { "tags": [ "Transactions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetWasSeenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetWasSeenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetWasSeenRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/Transactions/tas": { "post": { "tags": [ "Transactions" ], "responses": { "200": { "description": "Success" } } } }, "/api/Transactions/ore": { "post": { "tags": [ "Transactions" ], "responses": { "200": { "description": "Success" } } } } }, "components": { "schemas": { "UpdateAccountRequest": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateOtherAccountRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "role": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "customAuthGroupId": { "type": "string", "format": "uuid", "nullable": true }, "google2Fa": { "type": "boolean" }, "terminalId": { "type": "string", "nullable": true }, "cashierMerchantId": { "type": "string", "nullable": true }, "activationCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddCardRequest": { "type": "object", "properties": { "cardNumber": { "type": "string", "nullable": true }, "cardToken": { "type": "string", "nullable": true }, "cardType": { "type": "integer", "format": "int32" }, "cardHolderName": { "type": "string", "nullable": true }, "expiration": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "referenceId": { "type": "string", "nullable": true }, "fingerprintSessionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateCardRequest": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "setAsDefault": { "type": "boolean" } }, "additionalProperties": false }, "CardVerificationRequest": { "type": "object", "properties": { "paRes": { "type": "string", "nullable": true }, "fingerprintSessionId": { "type": "string", "nullable": true }, "jwt": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteAccountRequest": { "type": "object", "properties": { "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangeEmailRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "type": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ValidateEmailRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LoginConfirmRequest": { "type": "object", "properties": { "login": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "appVersion": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LoginRequest": { "type": "object", "properties": { "login": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "appVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegisterRequest": { "type": "object", "properties": { "language": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "cashierMerchantId": { "type": "string", "nullable": true }, "terminalId": { "type": "string", "nullable": true }, "activationCode": { "type": "string", "nullable": true }, "customAuthGroupId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ChangePasswordRequest": { "type": "object", "properties": { "oldPassword": { "type": "string", "nullable": true }, "newPassword": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "deviceType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidatePasswordRequest": { "type": "object", "properties": { "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidatePhoneRequest": { "type": "object", "properties": { "phoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConfirmPhoneRequest": { "type": "object", "properties": { "phoneNumber": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CheckShopperPhoneRequest": { "type": "object", "properties": { "phoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangeUserStatusRequest": { "type": "object", "properties": { "statusId": { "type": "integer", "format": "int32" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetLanguageRequest": { "type": "object", "properties": { "language": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetFastPaymentRequest": { "type": "object", "properties": { "amount": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "tipEnabled": { "type": "boolean" }, "tipAmount": { "type": "integer", "format": "int32" }, "confirmAmount": { "type": "boolean" } }, "additionalProperties": false }, "AssignOrganizationRequest": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "employeeId": { "type": "string", "nullable": true }, "qatarId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateCouponRequest": { "type": "object", "properties": { "isDisabled": { "type": "boolean" } }, "additionalProperties": false }, "CouponCompanySearchFilter": { "type": "object", "properties": { "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "PayerAuthCaptureContext": { "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid" }, "flexTargetOrigin": { "type": "string", "nullable": true }, "clientId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "PayerAuthSetupRequest": { "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid" }, "amount": { "type": "string", "nullable": true }, "totalAmount": { "type": "string", "nullable": true }, "transientToken": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "type": "string", "nullable": true }, "custom6": { "type": "string", "nullable": true }, "custom7": { "type": "string", "nullable": true }, "custom8": { "type": "string", "nullable": true }, "custom9": { "type": "string", "nullable": true }, "custom10": { "type": "string", "nullable": true }, "isRecurring": { "type": "boolean" }, "planName": { "type": "string", "nullable": true }, "frequency": { "type": "string", "nullable": true }, "interval": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "allowedFailedAttempts": { "type": "string", "nullable": true }, "tokenizeCard": { "type": "boolean" }, "tokenId": { "type": "string", "format": "uuid", "nullable": true }, "firstPaymentAmount": { "type": "string", "nullable": true }, "isFirstPayment": { "type": "boolean" }, "isCapture": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PayerAuthEnrollmentRequest": { "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid" }, "referenceId": { "type": "string", "format": "uuid" }, "transientToken": { "type": "string", "nullable": true }, "returnURL": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PayerAuthValidationRequest": { "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid" }, "referenceId": { "type": "string", "format": "uuid" }, "transientToken": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PayerAuthBinValidation": { "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid" }, "transientToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantSettingsRequest": { "type": "object", "properties": { "requestPayments": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "MerchantMapData": { "type": "object", "properties": { "merchantId": { "type": "string", "format": "uuid" }, "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } }, "additionalProperties": false }, "MerchantPasswordChangeRequest": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "newPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantUserNameChangeRequest": { "type": "object", "properties": { "oldUserName": { "type": "string", "nullable": true }, "newUserName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangeCompanyStatusRequest": { "type": "object", "properties": { "statusId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MerchantBranchesRequest": { "type": "object", "properties": { "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "CreateOnlinePaymentRequest": { "type": "object", "properties": { "uid": { "type": "string", "nullable": true }, "keyId": { "type": "string", "format": "uuid" }, "amount": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "type": "string", "nullable": true }, "custom6": { "type": "string", "nullable": true }, "custom7": { "type": "string", "nullable": true }, "custom8": { "type": "string", "nullable": true }, "custom9": { "type": "string", "nullable": true }, "custom10": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "webHookUrl": { "type": "string", "nullable": true }, "returnUrl": { "type": "string", "nullable": true }, "isRecurring": { "type": "boolean" }, "isCapture": { "type": "boolean", "nullable": true }, "tokenId": { "type": "string", "nullable": true }, "planName": { "type": "string", "nullable": true }, "firstPaymentAmount": { "type": "string", "nullable": true }, "isFirstPayment": { "type": "boolean" }, "frequency": { "type": "string", "nullable": true }, "interval": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "allowedFailedAttempts": { "type": "string", "nullable": true }, "caseId": { "type": "string", "nullable": true }, "recurringSubscriptionId": { "type": "string", "format": "uuid" }, "showSaveCard": { "type": "boolean", "nullable": true }, "onlyDebitCard": { "type": "boolean", "nullable": true }, "mit": { "type": "boolean", "nullable": true }, "expirationDate": { "type": "string", "nullable": true }, "sendSMS": { "type": "boolean" }, "sendEmail": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid", "nullable": true }, "showCardType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdatePaymentAmountRequest": { "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "amount": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateCardPaymentRequest": { "type": "object", "properties": { "uid": { "type": "string", "nullable": true }, "keyId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "type": "string", "nullable": true }, "custom6": { "type": "string", "nullable": true }, "custom7": { "type": "string", "nullable": true }, "custom8": { "type": "string", "nullable": true }, "custom9": { "type": "string", "nullable": true }, "custom10": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "recurringSubscriptionId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateMITPaymentRequest": { "type": "object", "properties": { "uid": { "type": "string", "nullable": true }, "keyId": { "type": "string", "format": "uuid" }, "amount": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "type": "string", "nullable": true }, "custom6": { "type": "string", "nullable": true }, "custom7": { "type": "string", "nullable": true }, "custom8": { "type": "string", "nullable": true }, "custom9": { "type": "string", "nullable": true }, "custom10": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "webHookUrl": { "type": "string", "nullable": true }, "returnUrl": { "type": "string", "nullable": true }, "tokenId": { "type": "string", "nullable": true }, "caseId": { "type": "string", "nullable": true }, "sendSMS": { "type": "boolean" }, "sendEmail": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CyberCaptureAndReversalRequest": { "required": [ "keyId", "paymentId" ], "type": "object", "properties": { "paymentId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid" }, "reason": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "RefundOnlinePaymentRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ApplePayHeaders": { "type": "object", "properties": { "ephemeralPublicKey": { "type": "string", "nullable": true }, "publicKeyHash": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApplePayPaymentData": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true }, "signature": { "type": "string", "nullable": true }, "header": { "$ref": "#/components/schemas/ApplePayHeaders" } }, "additionalProperties": false }, "ApplePayPaymentMethod": { "type": "object", "properties": { "network": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApplePayToken": { "type": "object", "properties": { "paymentData": { "$ref": "#/components/schemas/ApplePayPaymentData" }, "paymentMethod": { "$ref": "#/components/schemas/ApplePayPaymentMethod" } }, "additionalProperties": false }, "OnlinePaymentDeviceDataCollected": { "type": "object", "properties": { "browserLanguage": { "type": "string", "nullable": true }, "colorDepth": { "type": "integer", "format": "int32", "nullable": true }, "screenHeight": { "type": "integer", "format": "int32", "nullable": true }, "screenWidth": { "type": "integer", "format": "int32", "nullable": true }, "timeDifference": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ApplePayRequest": { "type": "object", "properties": { "token": { "$ref": "#/components/schemas/ApplePayToken" }, "deviceData": { "$ref": "#/components/schemas/OnlinePaymentDeviceDataCollected" }, "ip": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CancelSubscriptionRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "GooglePayMerchantRequest": { "type": "object", "properties": { "token": { "type": "string", "nullable": true }, "deviceData": { "$ref": "#/components/schemas/OnlinePaymentDeviceDataCollected" }, "uid": { "type": "string", "nullable": true }, "keyId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "GooglePaySetup": { "type": "object", "properties": { "uid": { "type": "string", "nullable": true }, "keyId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "paymentToken": { "type": "string", "nullable": true }, "cardNetwork": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GooglePayEnrollmentMerchantRequest": { "type": "object", "properties": { "body": { "type": "string", "nullable": true }, "uid": { "type": "string", "nullable": true }, "keyId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "paymentToken": { "type": "string", "nullable": true }, "cardNetwork": { "type": "string", "nullable": true }, "deviceData": { "$ref": "#/components/schemas/OnlinePaymentDeviceDataCollected" } }, "additionalProperties": false }, "TransactionDataRequest": { "type": "object", "properties": { "clientId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid" }, "dateFrom": { "type": "string", "format": "date-time", "nullable": true }, "dateTo": { "type": "string", "format": "date-time", "nullable": true }, "page": { "type": "integer", "format": "int32", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "pageIndex": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "OnlinePaymentUpdateRequest": { "type": "object", "properties": { "cardholderName": { "type": "string", "nullable": true }, "cardPan": { "type": "string", "nullable": true }, "cardToken": { "type": "string", "nullable": true }, "cardExpiration": { "type": "string", "nullable": true }, "flexError": { "type": "string", "nullable": true }, "binError": { "type": "string", "nullable": true }, "cardinalError": { "type": "string", "nullable": true }, "applePayError": { "type": "string", "nullable": true }, "googlePayError": { "type": "string", "nullable": true }, "checkboxCard": { "type": "boolean" } }, "additionalProperties": false }, "OnlinePaymentEnrollmentRequest": { "type": "object", "properties": { "body": { "type": "string", "nullable": true }, "deviceData": { "$ref": "#/components/schemas/OnlinePaymentDeviceDataCollected" } }, "additionalProperties": false }, "AppleValidateSessionRequest": { "type": "object", "properties": { "validationURL": { "type": "string", "nullable": true }, "merchantURL": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GooglePayRequest": { "type": "object", "properties": { "token": { "type": "string", "nullable": true }, "deviceData": { "$ref": "#/components/schemas/OnlinePaymentDeviceDataCollected" } }, "additionalProperties": false }, "OnlinePaymentCardinalStandardVerifyTestModel": { "type": "object", "properties": { "verificatinJwt": { "type": "string", "nullable": true }, "authorizationJwt": { "type": "string", "nullable": true }, "cardPan": { "type": "string", "nullable": true }, "cardToken": { "type": "string", "nullable": true }, "expirationYear": { "type": "integer", "format": "int32" }, "expirationMonth": { "type": "integer", "format": "int32" }, "cardCvv": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PayLaterWebhookRequest": { "type": "object", "properties": { "merchantId": { "type": "string", "nullable": true }, "orderId": { "type": "string", "nullable": true }, "paylaterRef": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "signature": { "type": "string", "nullable": true }, "txHash": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatePaymentRequestOld": { "type": "object", "properties": { "type": { "type": "integer", "format": "int32" }, "cashDeskId": { "type": "string", "format": "uuid", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "source": { "type": "integer", "format": "int32" }, "coupons": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "PaymentSource": { "type": "object", "properties": { "source": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "UpdatePaymentRequest": { "type": "object", "properties": { "price": { "type": "number", "format": "double", "nullable": true }, "acceptedCoupons": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "rejectedCoupons": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "tip": { "type": "number", "format": "double", "nullable": true }, "requestedCoupons": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "assignShopper": { "type": "boolean" }, "source": { "$ref": "#/components/schemas/PaymentSource" } }, "additionalProperties": false }, "PayRequest": { "type": "object", "properties": { "tip": { "type": "number", "format": "double", "nullable": true }, "cardId": { "type": "string", "format": "uuid" }, "fingerprintSessionId": { "type": "string", "nullable": true }, "fastPayment": { "type": "boolean" }, "referenceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidateRequest": { "type": "object", "properties": { "fingerprintSessionId": { "type": "string", "nullable": true }, "authenticationTransactionId": { "type": "string", "nullable": true }, "signedPares": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RateRequest": { "type": "object", "properties": { "rate": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RejectPaymentRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReceiptIdRequest": { "type": "object", "properties": { "receiptId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatePaymentRequest": { "type": "object", "properties": { "type": { "type": "integer", "format": "int32" }, "cashDeskId": { "type": "string", "format": "uuid", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "source": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AssignShopperRequest": { "type": "object", "properties": { "cashierId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "TablePage": { "type": "object", "properties": { "size": { "type": "integer", "format": "int32" }, "index": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TableSort": { "type": "object", "properties": { "column": { "type": "string", "nullable": true }, "order": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportsFilter": { "type": "object", "properties": { "draw": { "type": "integer", "format": "int32" }, "page": { "$ref": "#/components/schemas/TablePage" }, "searchTerm": { "type": "string", "nullable": true }, "sort": { "$ref": "#/components/schemas/TableSort" }, "dateFrom": { "type": "string", "format": "date-time", "nullable": true }, "dateTo": { "type": "string", "format": "date-time", "nullable": true }, "clientId": { "type": "string", "format": "uuid" }, "visaTransactionId": { "type": "string", "nullable": true }, "branch": { "type": "string", "nullable": true }, "cashierName": { "type": "string", "nullable": true }, "shopperFirstName": { "type": "string", "nullable": true }, "shopperLastName": { "type": "string", "nullable": true }, "shopperEmail": { "type": "string", "nullable": true }, "shopperPhoneNumber": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "statusId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "orderId": { "type": "string", "nullable": true }, "typeName": { "type": "string", "nullable": true }, "createdByFullName": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TapToPhoneTransactionDTO": { "type": "object", "properties": { "reqUserId": { "type": "string", "format": "uuid" }, "cardNumber": { "type": "string", "nullable": true }, "cardScheme": { "type": "string", "nullable": true }, "merchantId": { "type": "string", "format": "uuid" }, "transactionId": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" }, "paymentStatus": { "type": "integer", "format": "int32" }, "companyId": { "type": "string", "format": "uuid" }, "paymentGateway": { "type": "integer", "format": "int32" }, "refundId": { "type": "string", "nullable": true }, "refundAmount": { "type": "number", "format": "double" }, "refundDate": { "type": "string", "nullable": true }, "refundType": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TransactionRequest": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time", "nullable": true }, "to": { "type": "string", "format": "date-time", "nullable": true }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "limit": { "type": "integer", "format": "int32", "nullable": true }, "amountFrom": { "type": "number", "format": "double", "nullable": true }, "amountTo": { "type": "number", "format": "double", "nullable": true }, "onlyDiscounts": { "type": "boolean" }, "type": { "type": "integer", "format": "int32", "nullable": true }, "wasSeenByShopper": { "type": "boolean", "nullable": true }, "wasSeenByCashier": { "type": "boolean", "nullable": true }, "source": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RefundTransactionRequest": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "RefundRequest": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "isFullPaymentRefund": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SetWasSeenRequest": { "type": "object", "properties": { "transactionId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please enter into field the word 'Bearer' following by space and JWT", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }