{ "openapi": "3.0.1", "info": { "title": "Api.Gateway v1 - (production)", "version": "v1" }, "paths": { "/api/addresses/{correlationId}/trading": { "get": { "tags": [ "Address" ], "parameters": [ { "name": "correlationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.AddressResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.AddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.AddressResponse" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "Address" ], "parameters": [ { "name": "correlationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CreateAddressRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CreateAddressRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CreateAddressRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CreateAddressRequest" } } } }, "responses": { "201": { "description": "Created" } } } }, "/api/AddressAggregator/{locationGuid}/{rewnalGuid}/trading": { "get": { "tags": [ "AddressAggregator" ], "parameters": [ { "name": "locationGuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rewnalGuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Audit/search": { "get": { "tags": [ "Audit" ], "parameters": [ { "name": "TopicName", "in": "query", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Authorization/{employeeEmail}/{primaryPrincipalEmail}/authtoken": { "get": { "tags": [ "Authorization" ], "parameters": [ { "name": "employeeEmail", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "primaryPrincipalEmail", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Authorization/{contactEmail}": { "get": { "tags": [ "Authorization" ], "parameters": [ { "name": "contactEmail", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "acceptCreated", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Billing/mid/{mid}/customerId/{customerId}": { "get": { "tags": [ "Billing" ], "parameters": [ { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Billing/mid/{mid}/customerId/{customerId}/invoiceId/{invoiceId}": { "get": { "tags": [ "Billing" ], "parameters": [ { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Billing/GetAll/{customerId}/{mid}": { "get": { "tags": [ "Billing" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/Billing/GetLocationBill/{customerId}/{mid}": { "get": { "tags": [ "Billing" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Billing.BillablePeriodDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Billing.BillablePeriodDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Billing.BillablePeriodDto" } } } } } }, "deprecated": true } }, "/api/Billing/Download/pdf/{customerId}/{mid}/{year}/{month}": { "get": { "tags": [ "Billing" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/v2/BusinessFunding/{customerId}": { "get": { "tags": [ "BusinessFunding" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.BusinessFunding.BusinessFundingWithYouLendViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.BusinessFunding.BusinessFundingWithYouLendViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.BusinessFunding.BusinessFundingWithYouLendViewModel" } } } }, "404": { "description": "Not Found" } } } }, "/api/cancellationrebate": { "post": { "tags": [ "CancellationRebate" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.SubmittedCancellationRebateSaveRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.SubmittedCancellationRebateSaveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.SubmittedCancellationRebateSaveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.SubmittedCancellationRebateSaveRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/cancellationrebate/CancellationRebateLocationInfo/{locationId}": { "get": { "tags": [ "CancellationRebate" ], "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateLocationInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateLocationInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateLocationInfo" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/cancellationrebate/{cancellationRebateId}/approve": { "post": { "tags": [ "CancellationRebate" ], "parameters": [ { "name": "cancellationRebateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateApproveRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateApproveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateApproveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateApproveRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/cancellationrebate/{cancellationRebateId}/decline": { "post": { "tags": [ "CancellationRebate" ], "parameters": [ { "name": "cancellationRebateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateDeclineRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateDeclineRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateDeclineRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CancellationRebateDeclineRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/change-of-bank": { "post": { "tags": [ "ChangeOfBank" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.ChangeOfBankRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.ChangeOfBankRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.ChangeOfBankRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.ChangeOfBankRequestModel" } } } }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable Content" }, "404": { "description": "Not Found" } } } }, "/api/change-of-bank/location/{locationId}": { "get": { "tags": [ "ChangeOfBank" ], "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.ChangeOfBankLocationInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.ChangeOfBankLocationInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.ChangeOfBankLocationInfo" } } } }, "404": { "description": "Not Found" } } } }, "/api/change-of-bank/principals/{customerId}": { "get": { "tags": [ "ChangeOfBank" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.ChangeOfBankPrincipal" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.ChangeOfBankPrincipal" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.ChangeOfBankPrincipal" } } } } }, "404": { "description": "Not Found" } } } }, "/api/change-of-bank/{requestId}/confirm": { "post": { "tags": [ "ChangeOfBank" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/change-of-bank/{requestId}/cancel": { "post": { "tags": [ "ChangeOfBank" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.CancelDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.CancelDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.CancelDetails" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.CancelDetails" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/change-of-bank/esignature/location/{locationId}/agreements": { "get": { "tags": [ "ChangeOfBankESignature" ], "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Services.HttpClients.Interfaces.ESignatureAgreement" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Services.HttpClients.Interfaces.ESignatureAgreement" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Services.HttpClients.Interfaces.ESignatureAgreement" } } } } }, "404": { "description": "Not Found" } } } }, "/api/change-of-bank/esignature/location/{locationGuid}/merchant/{merchantGuid}/agreement/{requestId}/contract/{fileName}": { "get": { "tags": [ "ChangeOfBankESignature" ], "parameters": [ { "name": "locationGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "merchantGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } } } }, "/api/change-of-bank/esignature/location/{locationGuid}/merchant/{merchantGuid}/agreement/{requestId}/{fileName}": { "get": { "tags": [ "ChangeOfBankESignature" ], "parameters": [ { "name": "locationGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "merchantGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } } } }, "/api/client-identification/validate/bank-account/uk": { "get": { "tags": [ "ClientIdentification" ], "parameters": [ { "name": "AccountNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SortCode", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ClientIdentification.BankBranch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ClientIdentification.BankBranch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ClientIdentification.BankBranch" } } } }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable Content" } } } }, "/api/client-identification/validate/bank-account/international": { "get": { "tags": [ "ClientIdentification" ], "parameters": [ { "name": "Iban", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ClientIdentification.BankBranch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ClientIdentification.BankBranch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ClientIdentification.BankBranch" } } } }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable Content" } } } }, "/api/connect-cloud-accounts/{correlationId}": { "get": { "tags": [ "ConnectCloudAccounts" ], "parameters": [ { "name": "correlationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } } } }, "400": { "description": "Bad Request" } } }, "post": { "tags": [ "ConnectCloudAccounts" ], "parameters": [ { "name": "correlationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccountCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccountCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccountCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccountCreateRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "ConnectCloudAccounts" ], "parameters": [ { "name": "correlationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccountPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccountPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccountPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccountPatch" } } } }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/api/connect-cloud-accounts/unsent-confirmation-emails": { "get": { "tags": [ "ConnectCloudAccounts" ], "parameters": [ { "name": "opportunityIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } } } } } } } }, "/api/connect-cloud-accounts/from/{fromCorrelationId}/to/{toCorrelationId}": { "post": { "tags": [ "ConnectCloudAccounts" ], "parameters": [ { "name": "fromCorrelationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "toCorrelationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/api/connect-cloud-accounts/{correlationId}/terminals": { "patch": { "tags": [ "ConnectCloudAccounts" ], "parameters": [ { "name": "correlationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/api/connect-cloud-accounts/customer/{customerId}": { "get": { "tags": [ "ConnectCloudAccounts" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } } } } }, "400": { "description": "Bad Request" } } } }, "/api/order-pay/contacts/{contactId}": { "get": { "tags": [ "Contacts" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.OrderAndPay.Contact" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.OrderAndPay.Contact" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.OrderAndPay.Contact" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/order-pay/customer/{customerId}/contacts": { "get": { "tags": [ "Contacts" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.OrderAndPay.Contact" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.OrderAndPay.Contact" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.OrderAndPay.Contact" } } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/customer-accounts/{customerId}": { "get": { "tags": [ "CustomerAccounts" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageStart", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeAllLocationStatuses", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Account" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Account" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Account" } } } } } } } }, "/api/search/customers": { "post": { "tags": [ "CustomerSearch" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.CustomerSearchParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.CustomerSearchParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.CustomerSearchParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.CustomerSearchParams" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.CustomerSearchResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.CustomerSearchResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.CustomerSearchResults" } } } } } } }, "/api/search/customers/duplicates": { "post": { "tags": [ "CustomerSearch" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.DuplicateCustomerSearchParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.DuplicateCustomerSearchParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.DuplicateCustomerSearchParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.DuplicateCustomerSearchParams" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.CustomerScore" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.CustomerScore" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.CustomerScore" } } } } } } } }, "/api/Email": { "post": { "tags": [ "Email" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.SendEmailRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.SendEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.SendEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.SendEmailRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/api/esignature/webhook/agreements": { "get": { "tags": [ "ESignature" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "ESignature" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Services.ESignatures.WebhookPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Services.ESignatures.WebhookPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Services.ESignatures.WebhookPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Services.ESignatures.WebhookPayload" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/events/{merchantId}": { "get": { "tags": [ "EventAggregator" ], "parameters": [ { "name": "merchantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.EventResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.EventResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.EventResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/Feedback": { "post": { "tags": [ "Feedback" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.FeedbackModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.FeedbackModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.FeedbackModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.FeedbackModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v2/FirstDataBill/GetAggregateBills/{customerId}/{mid}": { "get": { "tags": [ "FirstDataBill" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v2/FirstDataBill/Download/pdf/{customerId}/{mid}/{id}": { "get": { "tags": [ "FirstDataBill" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/home/card-orders": { "get": { "tags": [ "Home" ], "responses": { "200": { "description": "OK" } } } }, "/api/transfer/instant/CustomerStatus/{customerId}": { "get": { "tags": [ "InstantTransfer" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCustomerStatusResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCustomerStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCustomerStatusResponse" } } } } } } }, "/api/transfer/instant/Details/customer/{customerId}": { "get": { "tags": [ "InstantTransfer" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferMerchantDetails" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferMerchantDetails" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferMerchantDetails" } } } } } } } }, "/api/transfer/instant/Details/customer/{customerId}/merchant/{merchantId}": { "get": { "tags": [ "InstantTransfer" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "merchantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferFees" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferFees" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferFees" } } } } } } }, "/api/transfer/instant/Create": { "post": { "tags": [ "InstantTransfer" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCreateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCreateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCreateResponse" } } } } } } }, "/api/transfer/instant/History/customer/{customerId}": { "get": { "tags": [ "InstantTransfer" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCustomerHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCustomerHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferCustomerHistory" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/transfer/instant/History/{id}/customer/{customerId}": { "get": { "tags": [ "InstantTransfer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferHistoryItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferHistoryItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferHistoryItem" } } } } } } }, "/api/transfer/instant/Qualification/{customerId}": { "get": { "tags": [ "InstantTransfer" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferQualificationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferQualificationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferQualificationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/api/transfer/instant/Signup/{customerId}": { "post": { "tags": [ "InstantTransfer" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferSignUpResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferSignUpResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferSignUpResponse" } } } } } } }, "/api/Invoice/SendInvoiceEmail": { "get": { "tags": [ "Invoice" ], "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "returnUrl", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/addresses/legacy/{mothershipAddressGuid}": { "get": { "tags": [ "LegacyAddress" ], "parameters": [ { "name": "mothershipAddressGuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LegacyAddressResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LegacyAddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LegacyAddressResponse" } } } }, "404": { "description": "Not Found" } } } }, "/api/addresses/legacy/{correlationId}/trading": { "post": { "tags": [ "LegacyAddress" ], "parameters": [ { "name": "correlationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LegacyCreateAddressRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LegacyCreateAddressRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LegacyCreateAddressRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LegacyCreateAddressRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LegacyAddressResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LegacyAddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LegacyAddressResponse" } } } } } } }, "/api/location-terminals/{id}": { "get": { "tags": [ "LocationTerminal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.LocationTerminal" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.LocationTerminal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.LocationTerminal" } } } } } }, "put": { "tags": [ "LocationTerminal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.LocationTerminal" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.LocationTerminal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.LocationTerminal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.LocationTerminal" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/api/search/partners": { "post": { "tags": [ "PartnerSearch" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchParams" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchResults`1[[Api.Gateway.Model.Search.Partner.Partner, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchResults`1[[Api.Gateway.Model.Search.Partner.Partner, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchResults`1[[Api.Gateway.Model.Search.Partner.Partner, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/pci-compliance/onboarding": { "post": { "tags": [ "PciCompliance" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PciCompliance.PciCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PciCompliance.PciCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PciCompliance.PciCustomer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PciCompliance.PciCustomer" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/Ping": { "get": { "tags": [ "Ping" ], "responses": { "200": { "description": "OK" } } } }, "/api/PrincipalUser/customers": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "showAll", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.CustomerViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.CustomerViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.CustomerViewModel" } } } } } } }, "/api/PrincipalUser/customers/{customerId}/locations": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "showAll", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.LocationViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.LocationViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.LocationViewModel" } } } } } } }, "/api/PrincipalUser/customers/{customerId}/locations/{locationId}": { "patch": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "locationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LocationPatchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LocationPatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LocationPatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.LocationPatchRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/PrincipalUser/contact": { "get": { "tags": [ "PrincipalUser" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.ContactViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.ContactViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.ContactViewModel" } } } } } } }, "/api/PrincipalUser/DateRangePresets/{locationId}": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/api/PrincipalUser/DateRangePresets": { "get": { "tags": [ "PrincipalUser" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/api/PrincipalUser/SummaryByLocation/{locationId}/{dateRange}": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "schema": { "type": "string" } }, { "name": "LocationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "DateRange", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } } } } } } }, "/api/PrincipalUser/SummaryByLocation/{locationId}/from/{fromDate}/to/{toDate}": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "schema": { "type": "string" } }, { "name": "LocationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } } } } } } }, "/api/PrincipalUser/SummaryByCustomer/{customerId}/{dateRange}": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } } } } } } }, "/api/PrincipalUser/SummaryByCustomer/{customerId}/from/{fromDate}/to/{toDate}": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" } } } } } } }, "/api/PrincipalUser/LocationSummariesByCustomer/{customerId}/{dateRange}": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResultSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResultSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResultSet" } } } } } } }, "/api/PrincipalUser/LocationSummariesByCustomer/{customerId}/from/{fromDate}/to/{toDate}": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResultSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResultSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResultSet" } } } } } } }, "/api/PrincipalUser/NetSalesCard/{customerId}/from/{fromDate}/to/{toDate}": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } } }, "/api/PrincipalUser/NetSalesCard/{customerId}/{dateRange}": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } } }, "/api/PrincipalUser/TransactionsByLocation": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.TransactionSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.TransactionSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.TransactionSearchResult" } } } } } } }, "/api/PrincipalUser/TransactionsByCustomer": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.TransactionSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.TransactionSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.TransactionSearchResult" } } } } } } }, "/api/PrincipalUser/TransactionsByLocation/Csv": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PrincipalUser/TransactionsByLocation/Pdf": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PrincipalUser/TransactionsByCustomer/Pdf": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PrincipalUser/TransactionsByLocation/email": { "post": { "tags": [ "PrincipalUser" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.SearchModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.SearchModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.SearchModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.SearchModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/PrincipalUser/TransactionsByLocation/SummaryEmail": { "post": { "tags": [ "PrincipalUser" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.SearchModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.SearchModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.SearchModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.SearchModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/PrincipalUser/ChartsByLocation/{locationId}/from/{fromDate}/to/{toDate}/type/{viewType}": { "get": { "tags": [ "PrincipalUser" ], "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Group.Enums.ViewType" } }, { "name": "fromDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "toDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "minCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/refunds/pending/teams/{teamId}": { "get": { "tags": [ "Refund" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.PendingRefund" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.PendingRefund" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.PendingRefund" } } } } } } } }, "/api/remote-payments/onboard-to-connect-e": { "post": { "tags": [ "RemotePayments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToConnectERequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToConnectERequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToConnectERequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToConnectERequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/remote-payments/onboard-to-cybersource": { "post": { "tags": [ "RemotePayments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourceRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourceRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/search/suggestions": { "post": { "tags": [ "SearchSuggestion" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Suggestions.SuggestionSearchParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Suggestions.SuggestionSearchParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Suggestions.SuggestionSearchParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Suggestions.SuggestionSearchParams" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Suggestions.SearchSuggestion" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Suggestions.SearchSuggestion" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Suggestions.SearchSuggestion" } } } } } } } }, "/api/terminalordering": { "get": { "tags": [ "TerminalOrdering" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/till-rolls/transactions": { "get": { "tags": [ "TillRolls" ], "parameters": [ { "name": "fromMonth", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toMonth", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "acquirer", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.Acquirer" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.MonthlyMidTransactionCount" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.MonthlyMidTransactionCount" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.MonthlyMidTransactionCount" } } } } } } } }, "/api/v2/Transactions/ByLocation/{locationId}": { "get": { "tags": [ "Transactions" ], "parameters": [ { "name": "locationId", "in": "query", "schema": { "type": "string" } }, { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "schema": { "type": "string" } }, { "name": "LocationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v2/Transactions/ByCustomer/{customerId}": { "get": { "tags": [ "Transactions" ], "parameters": [ { "name": "customerId", "in": "query", "schema": { "type": "string" } }, { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v2/Transactions/ByLocation/{locationId}/Pdf": { "get": { "tags": [ "Transactions" ], "parameters": [ { "name": "locationId", "in": "query", "schema": { "type": "string" } }, { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "schema": { "type": "string" } }, { "name": "LocationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v2/Transactions/ByCustomer/{customerId}/Pdf": { "get": { "tags": [ "Transactions" ], "parameters": [ { "name": "customerId", "in": "query", "schema": { "type": "string" } }, { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v2/Transactions/ByLocation/{locationId}/Csv": { "get": { "tags": [ "Transactions" ], "parameters": [ { "name": "locationId", "in": "query", "schema": { "type": "string" } }, { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "schema": { "type": "string" } }, { "name": "LocationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v2/Transactions/ByCustomer/{customerId}/Csv": { "get": { "tags": [ "Transactions" ], "parameters": [ { "name": "customerId", "in": "query", "schema": { "type": "string" } }, { "name": "PageOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" } }, { "name": "Field", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, { "name": "TodayIs", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MinCashbackAmount", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "LocationId", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "TransactionType", "in": "query", "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" } }, { "name": "CardTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" } } }, { "name": "Schemes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/User/emailsToExclude": { "get": { "tags": [ "User" ], "parameters": [ { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.EmailExcludeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.EmailExcludeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.EmailExcludeResponse" } } } } } } }, "/api/User/unsubscribe/{userId}/{apiKey}": { "get": { "tags": [ "User" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.UnsubscribeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.UnsubscribeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.UnsubscribeResponse" } } } } } } }, "/api/search/users": { "post": { "tags": [ "UserSearch" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchParams" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchResults`1[[Api.Gateway.Model.Search.User.User, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchResults`1[[Api.Gateway.Model.Search.User.User, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchResults`1[[Api.Gateway.Model.Search.User.User, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/Version/supported": { "get": { "tags": [ "Version" ], "parameters": [ { "name": "os", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.OperatingSystemEnum" } }, { "name": "version", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Versioning.VersionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Versioning.VersionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Api.Gateway.Model.Versioning.VersionResponse" } } } } } } }, "/api/YouLendWebhook": { "post": { "tags": [ "YouLendWebhook" ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "Api.Gateway.ClientIdentification.BankBranch": { "type": "object", "properties": { "branchName": { "type": "string", "nullable": true }, "institutionName": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.AddressResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "flatAptSuite": { "type": "string", "nullable": true }, "houseNumber": { "type": "string", "nullable": true }, "houseName": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true }, "townName": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "lastUpdatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Api.Gateway.Model.Billing.BillablePeriodDto": { "type": "object", "properties": { "year": { "type": "integer", "format": "int32" }, "months": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CancellationRebateApproveRequest": { "type": "object", "properties": { "username": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CancellationRebateDeclineRequest": { "type": "object", "properties": { "username": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CancellationRebateLocationInfo": { "type": "object", "properties": { "tradingName": { "type": "string", "nullable": true }, "acquirerLocationMID": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.ChangeOfBank.BankDetails": { "type": "object", "properties": { "accountNumber": { "type": "string", "nullable": true }, "sortCode": { "type": "string", "nullable": true }, "iban": { "type": "string", "nullable": true }, "bankName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.ChangeOfBank.CancelDetails": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.ChangeOfBank.ChangeOfBankLocationInfo": { "type": "object", "properties": { "locationId": { "type": "string", "nullable": true }, "requestId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "type": "string", "nullable": true }, "current": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.BankDetails" }, "requested": { "$ref": "#/components/schemas/Api.Gateway.Model.ChangeOfBank.BankDetails" }, "legalName": { "type": "string", "nullable": true }, "tradingName": { "type": "string", "nullable": true }, "mid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.ChangeOfBank.ChangeOfBankPrincipal": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "salutation": { "type": "string", "nullable": true }, "forename": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "contactType": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "isPrimary": { "type": "boolean", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Api.Gateway.Model.ChangeOfBank.ChangeOfBankRequestModel": { "type": "object", "properties": { "merchantId": { "type": "string", "format": "uuid" }, "locationId": { "type": "string", "format": "uuid" }, "accountNumber": { "type": "string", "nullable": true }, "sortCode": { "type": "string", "nullable": true }, "iban": { "type": "string", "nullable": true }, "signatoryEmail": { "type": "string", "nullable": true }, "signatoryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.ConnectAccount": { "type": "object", "properties": { "correlationId": { "type": "string", "format": "uuid" }, "accountName": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "apiKey": { "type": "string", "nullable": true }, "hostName": { "type": "string", "nullable": true }, "defaultCurrency": { "type": "string", "nullable": true }, "vendSecret": { "type": "string", "nullable": true }, "ports": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccountPort" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.ConnectAccountCreateRequest": { "required": [ "correlationId", "customerId", "defaultCurrency", "merchantLocatorId" ], "type": "object", "properties": { "merchantLocatorId": { "minLength": 1, "type": "string" }, "defaultCurrency": { "minLength": 1, "type": "string" }, "correlationId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "merchantTradingName": { "type": "string", "nullable": true }, "opportunityLocation": { "type": "string", "nullable": true }, "opportunityLocatorId": { "type": "string", "nullable": true }, "softwareHouseLocatorId": { "type": "string", "nullable": true }, "softwareHouseTradingName": { "type": "string", "nullable": true }, "skipped": { "type": "boolean" } }, "additionalProperties": false }, "Api.Gateway.Model.ConnectAccountPatch": { "type": "object", "properties": { "correlationId": { "type": "string", "format": "uuid" }, "confirmationEmailSentToSoftwareHouse": { "type": "boolean" } }, "additionalProperties": false }, "Api.Gateway.Model.ConnectAccountPort": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Api.Gateway.Model.CreateAddressRequest": { "type": "object", "properties": { "flatAptSuite": { "type": "string", "nullable": true }, "houseNumber": { "type": "string", "nullable": true }, "houseName": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true }, "townName": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.Account": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.AccountSummary" }, "detail": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.AccountDetail" }, "alerts": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Alerts.AccountAlert" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.AccountBilling": { "type": "object", "properties": { "amexMerchantId": { "type": "string", "nullable": true }, "epayMerchantId": { "type": "string", "nullable": true }, "headOfficeMerchantId": { "type": "string", "nullable": true }, "acquirer": { "type": "string", "nullable": true }, "lessor": { "type": "string", "nullable": true }, "lifetimeRevenue": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "owner": { "type": "string", "nullable": true }, "applicationId": { "type": "string", "nullable": true }, "opportunityId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.AccountDetail": { "type": "object", "properties": { "accountBilling": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.AccountBilling" }, "connectDetails": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Connect.ConnectDetails" }, "terminals": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Terminal" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.AccountSummary": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Address" }, "tradingName": { "type": "string", "nullable": true }, "merchantNumber": { "type": "string", "nullable": true }, "acquirer": { "type": "string", "nullable": true }, "transactionType": { "type": "string", "nullable": true }, "accountStatus": { "type": "string", "nullable": true }, "accountStatusDate": { "type": "string", "format": "date-time", "nullable": true }, "pciStatus": { "type": "string", "nullable": true }, "leaseDurationMonths": { "type": "integer", "format": "int32" }, "leaseRemainingMonths": { "type": "integer", "format": "int32", "nullable": true }, "opportunityLocatorId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.Address": { "type": "object", "properties": { "flatAptSuite": { "type": "string", "nullable": true }, "houseNumber": { "type": "string", "nullable": true }, "houseName": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true }, "townName": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "county": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.County" }, "country": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Country" } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.Alerts.AccountAlert": { "type": "object", "properties": { "alertType": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.AccountAlertType" }, "description": { "type": "string", "nullable": true }, "actionable": { "type": "boolean" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.Connect.ConnectDetails": { "type": "object", "properties": { "reseller": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Connect.Partner" }, "softwareHouse": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Connect.Partner" }, "partnershipManager": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Connect.PartnershipManager" }, "partnershipDevelopmentManager": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.Connect.PartnershipDevelopmentManager" }, "connectAccount": { "$ref": "#/components/schemas/Api.Gateway.Model.ConnectAccount" } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.Connect.Partner": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.Connect.PartnershipDevelopmentManager": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.Connect.PartnershipManager": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.Country": { "type": "object", "properties": { "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.County": { "type": "object", "properties": { "countyName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.LocationTerminal": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "locationId": { "type": "string", "format": "uuid" }, "terminalId": { "type": "string", "nullable": true }, "terminalSerial": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "opportunityLocatorId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "statusChangeDate": { "type": "string", "format": "date-time" }, "promotion": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "leaseDurationMonths": { "type": "integer", "format": "int32" }, "leaseRemainingMonths": { "type": "integer", "format": "int32" }, "terminalType": { "type": "string", "nullable": true }, "terminalModelId": { "type": "integer", "format": "int32" }, "leaseFormat": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.LeaseFormat" }, "merchantNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.Terminal": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.TerminalModel" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.TerminalGroup" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.TerminalGroup": { "type": "object", "properties": { "terminalType": { "type": "string", "nullable": true }, "instances": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.CustomerSnapshot.LocationTerminal" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.CustomerSnapshot.TerminalModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "vendor": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "fieldDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.EmailExcludeResponse": { "type": "object", "properties": { "activeUserEmails": { "type": "array", "items": { "type": "string" }, "nullable": true }, "count": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Api.Gateway.Model.EmailProperty": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "isJson": { "type": "boolean" } }, "additionalProperties": false }, "Api.Gateway.Model.Enum.AccountAlertType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Enum.Acquirer": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Enum.DateRangePreset": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Enum.FeedbackSource": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Enum.FeedbackType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Enum.LeaseFormat": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Enum.SearchType": { "enum": [ "Customer", "Partner", "User" ], "type": "string" }, "Api.Gateway.Model.EventResponse": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.FeedbackModel": { "required": [ "body", "source", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.FeedbackType" }, "source": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.FeedbackSource" }, "body": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Api.Gateway.Model.FileAttachment": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "fileContent": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.CreateTransferErrorType": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.InstantTransfer.InstantTransferCreateRequest": { "required": [ "amount", "customerId", "merchantId" ], "type": "object", "properties": { "customerId": { "minLength": 1, "type": "string" }, "merchantId": { "minLength": 1, "type": "string" }, "amount": { "minimum": 1, "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferCreateResponse": { "type": "object", "properties": { "merchantId": { "type": "string", "nullable": true }, "isSuccessful": { "type": "boolean" }, "reference": { "type": "string", "nullable": true }, "transferredAmount": { "type": "integer", "format": "int64" }, "errorType": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.CreateTransferErrorType" }, "errorDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferCustomerHistory": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true }, "multiLocation": { "type": "boolean" }, "transfers": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferHistoryGroup" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferCustomerStatusResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferStatusEnum" }, "isMultiLocation": { "type": "boolean" }, "numberOfLocations": { "type": "integer", "format": "int32" }, "availableToTransfer": { "type": "integer", "format": "int64" }, "currencyIsoCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferFees": { "type": "object", "properties": { "merchantId": { "type": "string", "nullable": true }, "netSales": { "type": "integer", "format": "int64" }, "availableToTransfer": { "type": "integer", "format": "int64" }, "transferFee": { "type": "integer", "format": "int64" }, "transferFeePercentage": { "type": "number", "format": "float" }, "percentageToInstantTransfer": { "type": "number", "format": "float" }, "totalTransferable": { "type": "integer", "format": "int64" }, "currencyIsoCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferHistoryGroup": { "type": "object", "properties": { "year": { "type": "integer", "format": "int32" }, "month": { "type": "integer", "format": "int32" }, "totalAmount": { "type": "integer", "format": "int64" }, "currencyIsoCode": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferHistorySummary" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferHistoryItem": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "locationMid": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" }, "totalAmount": { "type": "integer", "format": "int64" }, "transferFee": { "type": "integer", "format": "int64" }, "transferFeePercentage": { "type": "number", "format": "float" }, "currencyIsoCode": { "type": "string", "nullable": true }, "totalAfterFees": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferHistorySummary": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "locationMid": { "type": "string", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" }, "amount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferMerchantDetails": { "type": "object", "properties": { "merchantId": { "type": "string", "nullable": true }, "netSales": { "type": "integer", "format": "int64" }, "availableToTransfer": { "type": "integer", "format": "int64" }, "status": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferStatusEnum" }, "currencyIsoCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferQualificationResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Api.Gateway.Model.InstantTransfer.InstantTransferQualificationStatus" }, "locationMids": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isMultiLocation": { "type": "boolean" } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferQualificationStatus": { "enum": [ "NotExist", "NotQualified", "Qualified", "Pending", "Approved", "Declined" ], "type": "string" }, "Api.Gateway.Model.InstantTransfer.InstantTransferSignUpResponse": { "type": "object", "properties": { "isSuccessful": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.InstantTransfer.InstantTransferStatusEnum": { "enum": [ "NotExist", "Disabled", "Enabled" ], "type": "string" }, "Api.Gateway.Model.LegacyAddressResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "flatAptSuite": { "type": "string", "nullable": true }, "houseNumber": { "type": "string", "nullable": true }, "houseName": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true }, "townName": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "mothershipAddressGuid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.LegacyCreateAddressRequest": { "type": "object", "properties": { "flatAptSuite": { "type": "string", "nullable": true }, "houseNumber": { "type": "string", "nullable": true }, "houseName": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true }, "townName": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "mothershipAddressGuid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.LessorAcquirer": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.LessorAcquirerRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.LocationPatchRequest": { "type": "object", "properties": { "nickname": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.MonthlyMidTransactionCount": { "type": "object", "properties": { "mid": { "type": "string", "nullable": true }, "month": { "type": "string", "format": "date-time" }, "transactionCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Api.Gateway.Model.OperatingSystemEnum": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.OrderAndPay.Contact": { "type": "object", "properties": { "contactId": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.OrderAndPay.Customer" }, "nullable": true }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.OrderAndPay.Location" }, "nullable": true }, "actionedAt": { "type": "string", "format": "date-time" }, "ownedBy": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Api.Gateway.Model.OrderAndPay.Customer": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "actionedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Api.Gateway.Model.OrderAndPay.Location": { "type": "object", "properties": { "locationId": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "actionedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Api.Gateway.Model.PendingRefund": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "zendeskTicketId": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true }, "country": { "type": "string", "nullable": true }, "tradingName": { "type": "string", "nullable": true }, "mid": { "type": "string", "nullable": true }, "lessorAcquirers": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.LessorAcquirer" }, "nullable": true }, "username": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Common.Contact": { "type": "object", "properties": { "contactId": { "type": "string", "format": "uuid" }, "fullName": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "mobilePhoneNumber": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Common.PhoneNumber" }, "mainPhoneNumber": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Common.PhoneNumber" }, "isPrimary": { "type": "boolean" } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Common.PhoneNumber": { "type": "object", "properties": { "phoneNumberId": { "type": "string", "format": "uuid", "nullable": true }, "number": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Common.UserBase": { "type": "object", "properties": { "userGuid": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Customer.ApplicationInfo": { "type": "object", "properties": { "applicationId": { "type": "string", "format": "uuid" }, "bankReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Customer.BusinessInfo": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "postCode": { "type": "string", "nullable": true }, "businessInfoType": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.BusinessInfoType" } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Customer.BusinessInfoType": { "enum": [ "None", "Customer", "Location", "Legal" ], "type": "string" }, "Api.Gateway.Model.Search.Customer.Customer": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true }, "isLive": { "type": "boolean" }, "status": { "type": "string", "nullable": true }, "updateDate": { "type": "string", "format": "date-time" }, "locatorId": { "type": "string", "nullable": true }, "companyRegistrationNumber": { "type": "string", "nullable": true }, "registeredCharityNumber": { "type": "string", "nullable": true }, "sicCode": { "type": "string", "nullable": true }, "owner": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Common.UserBase" }, "thompsonCode": { "type": "string", "nullable": true }, "opportunityLocatorIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "renewalLocatorIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "phoneNumber": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Common.PhoneNumber" }, "faxNumber": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Common.PhoneNumber" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Common.Contact" }, "nullable": true }, "softwareHouseName": { "type": "string", "nullable": true }, "businessInfo": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.BusinessInfo" }, "nullable": true }, "locationInfos": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.LocationInfo" }, "nullable": true }, "applicationInfos": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.ApplicationInfo" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Customer.CustomerScore": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true }, "score": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Customer.CustomerSearchParams": { "type": "object", "properties": { "query": { "type": "string", "nullable": true }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "explainHits": { "type": "boolean" }, "environment": { "type": "string", "nullable": true }, "includeLiveCount": { "type": "boolean" }, "liveOnly": { "type": "boolean" }, "includeOwnedCount": { "type": "boolean" }, "ownedOnly": { "type": "boolean" } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Customer.CustomerSearchResults": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "hits": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchHit`1[[Api.Gateway.Model.Search.Customer.Customer, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "nullable": true }, "liveCount": { "type": "integer", "format": "int64", "nullable": true }, "ownedCount": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Customer.DuplicateCustomerSearchParams": { "type": "object", "properties": { "countryKey": { "type": "integer", "format": "int32", "nullable": true }, "companyRegistrationNumbers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "businessNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "emailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "phoneNumbers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "postcodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "surnames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "excludeCustomerIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "minScore": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Customer.LocationInfo": { "type": "object", "properties": { "opportunityId": { "type": "string", "format": "uuid" }, "opportunityLocatorId": { "type": "string", "nullable": true }, "depositAccount": { "type": "string", "nullable": true }, "depositIban": { "type": "string", "nullable": true }, "feesAccount": { "type": "string", "nullable": true }, "feesIban": { "type": "string", "nullable": true }, "acquirerLocationMid": { "type": "string", "nullable": true }, "amexMid": { "type": "string", "nullable": true }, "epayMid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Partner.Partner": { "type": "object", "properties": { "partnerCompanyKey": { "type": "string", "nullable": true }, "partnerType": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "postCode": { "type": "string", "nullable": true }, "primaryContact": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Common.Contact" }, "updateDate": { "type": "string", "format": "date-time" }, "emailAddress": { "type": "string", "nullable": true }, "connectionTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "installPreference": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "statusDate": { "type": "string", "format": "date-time", "nullable": true }, "isLive": { "type": "boolean" }, "locatorId": { "type": "string", "nullable": true }, "partnershipManager": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.User.User" }, "developmentManager": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.User.User" }, "integrationLocatorIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.SearchHit`1[[Api.Gateway.Model.Search.Customer.Customer, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "score": { "type": "number", "format": "double", "nullable": true }, "item": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Customer.Customer" }, "explanation": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.SearchHit`1[[Api.Gateway.Model.Search.Partner.Partner, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "score": { "type": "number", "format": "double", "nullable": true }, "item": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Partner.Partner" }, "explanation": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.SearchHit`1[[Api.Gateway.Model.Search.User.User, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "score": { "type": "number", "format": "double", "nullable": true }, "item": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.User.User" }, "explanation": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.SearchParams": { "type": "object", "properties": { "query": { "type": "string", "nullable": true }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "explainHits": { "type": "boolean" }, "environment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.SearchResults`1[[Api.Gateway.Model.Search.Partner.Partner, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "hits": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchHit`1[[Api.Gateway.Model.Search.Partner.Partner, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.SearchResults`1[[Api.Gateway.Model.Search.User.User, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "hits": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.SearchHit`1[[Api.Gateway.Model.Search.User.User, Api.Gateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Suggestions.SearchSuggestion": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.SearchType" }, "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.Suggestions.SuggestionSearchParams": { "type": "object", "properties": { "query": { "type": "string", "nullable": true }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "explainHits": { "type": "boolean" }, "environment": { "type": "string", "nullable": true }, "searchTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.SearchType" }, "nullable": true }, "preferredAllocations": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Search.User.User": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "userGuid": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "mobilePhoneNumber": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Common.PhoneNumber" }, "officePhoneNumber": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Common.PhoneNumber" }, "virtualLineNumber": { "$ref": "#/components/schemas/Api.Gateway.Model.Search.Common.PhoneNumber" }, "jobTitle": { "type": "string", "nullable": true }, "managers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "terminationDate": { "type": "string", "format": "date-time", "nullable": true }, "departments": { "type": "array", "items": { "type": "string" }, "nullable": true }, "teams": { "type": "array", "items": { "type": "string" }, "nullable": true }, "office": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "Api.Gateway.Model.SendEmailRequest": { "type": "object", "properties": { "uniqueId": { "type": "string", "nullable": true }, "senderEmailAddress": { "type": "string", "nullable": true }, "recipientEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ccEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "bccEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "subject": { "type": "string", "nullable": true }, "templateName": { "type": "string", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.EmailProperty" }, "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.FileAttachment" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.SubmittedCancellationRebateSaveRequest": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "nullable": true }, "zendeskTicketId": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "sortCode": { "type": "string", "nullable": true }, "iban": { "type": "string", "nullable": true }, "bic": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "lessorAcquirerRequests": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.LessorAcquirerRequest" }, "nullable": true }, "locationId": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "teamName": { "type": "string", "nullable": true }, "teamId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.TerminalRemotePayments.OnboardToConnectERequest": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true }, "mid": { "type": "string", "nullable": true }, "amexMid": { "type": "string", "nullable": true }, "merchantName": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "locatorId": { "type": "string", "nullable": true }, "gatewayUsername": { "type": "string", "nullable": true }, "gatewayPassword": { "type": "string", "nullable": true }, "mcc": { "type": "string", "nullable": true }, "acquirerMid": { "type": "string", "nullable": true }, "merchantUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourceAddress": { "type": "object", "properties": { "houseNameNumber": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "locality": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "countryIsoAlpha3": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourceContact": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "phoneNumber": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourcePhoneNumber" } }, "additionalProperties": false }, "Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourcePhoneNumber": { "type": "object", "properties": { "internationalCallingCode": { "type": "string", "nullable": true }, "telephoneNumber": { "type": "string", "nullable": true }, "countryIsoAlpha3": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourceRequest": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true }, "ownerReferenceId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "merchantId": { "type": "string", "nullable": true }, "accountId": { "type": "string", "nullable": true }, "mid": { "type": "string", "nullable": true }, "tid": { "type": "string", "nullable": true }, "amexEnabled": { "type": "boolean" }, "amexSeNumber": { "type": "string", "nullable": true }, "amexBusinessCode": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourceAddress" }, "contact": { "$ref": "#/components/schemas/Api.Gateway.Model.TerminalRemotePayments.OnboardToCybersourceContact" }, "websiteUrl": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.TerminalResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "serialNo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Transaction.Aggregate.AggregatedDataItem": { "type": "object", "properties": { "netSales": { "type": "integer", "format": "int64" }, "cashback": { "type": "integer", "format": "int64" }, "sales": { "type": "integer", "format": "int64" }, "totalRefund": { "type": "integer", "format": "int64" }, "transactionsTaken": { "type": "integer", "format": "int64" }, "refundsCount": { "type": "integer", "format": "int64" }, "salesCount": { "type": "integer", "format": "int64" }, "averageSale": { "type": "number", "format": "double" }, "highestSale": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataItem" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResultSet": { "type": "object", "properties": { "locationSummaryMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Aggregate.AggregatedDataResult" }, "nullable": true, "readOnly": true }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Transaction.Group.Enums.ViewType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Transaction.Search.Enums.CardType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Transaction.Search.Enums.Scheme": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Transaction.Search.Enums.SortField": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Transaction.Search.Enums.SortOrder": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Transaction.Search.Enums.TransactionType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Api.Gateway.Model.Transaction.Search.SearchModel": { "type": "object", "properties": { "todayIs": { "type": "string", "format": "date-time", "nullable": true }, "minCashbackAmount": { "type": "integer", "format": "int32", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "locationId": { "type": "string", "nullable": true }, "dateRange": { "$ref": "#/components/schemas/Api.Gateway.Model.Enum.DateRangePreset" }, "fromDate": { "type": "string", "format": "date-time" }, "toDate": { "type": "string", "format": "date-time" }, "transactionType": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" }, "cardTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.CardType" }, "nullable": true }, "schemes": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.Scheme" }, "nullable": true }, "pageOffset": { "type": "integer", "format": "int32", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "order": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortOrder" }, "field": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.SortField" } }, "additionalProperties": false }, "Api.Gateway.Model.Transaction.Search.TransactionItemModel": { "type": "object", "properties": { "locationID": { "type": "string", "nullable": true }, "merchantID": { "type": "integer", "format": "int64" }, "terminalID": { "type": "string", "nullable": true }, "acquirerReferenceNumber": { "type": "string", "nullable": true }, "hash": { "type": "integer", "format": "int32" }, "transactionDateTime": { "type": "string", "format": "date-time" }, "transactionType": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.Enums.TransactionType" }, "cardType": { "type": "string", "nullable": true }, "scheme": { "type": "string", "nullable": true }, "maskedPAN": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "amount": { "type": "integer", "format": "int64" }, "cashback": { "type": "integer", "format": "int64" }, "hasTime": { "type": "boolean" }, "interchangeCostsAvailability": { "type": "string", "nullable": true }, "transactionIdAvailability": { "type": "string", "nullable": true }, "transactionID": { "type": "string", "nullable": true }, "interchangeFeeCost": { "type": "integer", "format": "int64", "nullable": true }, "interchangeFeeIsSeparate": { "type": "boolean", "nullable": true }, "assessmentFeeCost": { "type": "integer", "format": "int64", "nullable": true }, "cardProcessingFeeCost": { "type": "integer", "format": "int64", "nullable": true }, "totalFeeCost": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Transaction.Search.TransactionSearchResult": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "netSales": { "type": "integer", "format": "int64" }, "cashback": { "type": "integer", "format": "int64" }, "totalCount": { "type": "integer", "format": "int64" }, "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Model.Transaction.Search.TransactionItemModel" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.UnsubscribeResponse": { "type": "object", "properties": { "updated": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Model.Versioning.VersionResponse": { "type": "object", "properties": { "isSupported": { "type": "boolean" } }, "additionalProperties": false }, "Api.Gateway.Services.ESignatures.Agreement": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Services.ESignatures.WebhookPayload": { "type": "object", "properties": { "webhookId": { "type": "string", "nullable": true }, "webhookNotificationId": { "type": "string", "nullable": true }, "event": { "type": "string", "nullable": true }, "eventDate": { "type": "string", "nullable": true }, "agreement": { "$ref": "#/components/schemas/Api.Gateway.Services.ESignatures.Agreement" } }, "additionalProperties": false }, "Api.Gateway.Services.HttpClients.Interfaces.ESignatureAgreement": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "eSignId": { "type": "string", "nullable": true }, "toName": { "type": "string", "nullable": true }, "toEmail": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "updateDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "contracts": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.Services.HttpClients.Interfaces.ESignatureContract" }, "nullable": true } }, "additionalProperties": false }, "Api.Gateway.Services.HttpClients.Interfaces.ESignatureContract": { "type": "object", "properties": { "eSignContractId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.ViewModel.BusinessFunding.Approved": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.ViewModel.BusinessFunding.BusinessFundingWithYouLendViewModel": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.BusinessFunding.BusinessFundingWthYouLendStatus" }, "prequalified": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.BusinessFunding.Prequalified" }, "approved": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.BusinessFunding.Approved" } }, "additionalProperties": false }, "Api.Gateway.ViewModel.BusinessFunding.BusinessFundingWthYouLendStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Api.Gateway.ViewModel.BusinessFunding.Prequalified": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "url": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.ViewModel.PciCompliance.MerchantPrincipal": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.ViewModel.PciCompliance.PciAddress": { "type": "object", "properties": { "address1": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "address3": { "type": "string", "nullable": true }, "address4": { "type": "string", "nullable": true }, "address5": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.ViewModel.PciCompliance.PciCustomer": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true }, "mid": { "type": "string", "nullable": true }, "tradingName": { "type": "string", "nullable": true }, "tradingAddress": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PciCompliance.PciAddress" }, "businessPhoneNumber": { "type": "string", "nullable": true }, "mcc": { "type": "string", "nullable": true }, "ecom": { "type": "boolean" }, "accountOpened": { "type": "string", "format": "date-time" }, "principal": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PciCompliance.MerchantPrincipal" } }, "additionalProperties": false }, "Api.Gateway.ViewModel.PrincipalUser.AddressViewModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "flatAptSuite": { "type": "string", "nullable": true }, "houseNumber": { "type": "string", "nullable": true }, "houseName": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true }, "townName": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "lastUpdatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Api.Gateway.ViewModel.PrincipalUser.BusinessFundingViewModel": { "type": "object", "properties": { "prequalifiedAmount": { "type": "number", "format": "double" }, "url": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.ViewModel.PrincipalUser.ContactViewModel": { "type": "object", "properties": { "contactId": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Api.Gateway.ViewModel.PrincipalUser.CustomerViewModel": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true }, "customerName": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean", "nullable": true }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.LocationViewModel" }, "nullable": true }, "businessFunding": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.BusinessFundingViewModel" }, "locator": { "type": "string", "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Api.Gateway.ViewModel.PrincipalUser.LocationViewModel": { "type": "object", "properties": { "hasValidStatus": { "type": "boolean", "readOnly": true }, "locationId": { "type": "string", "nullable": true }, "tradingName": { "type": "string", "nullable": true }, "nickname": { "type": "string", "nullable": true }, "acquirerLocationMID": { "type": "string", "nullable": true }, "acquirer": { "type": "string", "nullable": true }, "amexMerchantId": { "type": "string", "nullable": true }, "currencyISOCode": { "type": "string", "nullable": true }, "typeOfTransaction": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "ecommWebURL": { "type": "string", "nullable": true }, "applicationId": { "type": "string", "nullable": true }, "liveAt": { "type": "string", "format": "date-time", "nullable": true }, "hasBeenValid": { "type": "boolean" }, "currentStatus": { "type": "string", "nullable": true }, "mcc": { "type": "string", "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time" }, "tradingAddress": { "$ref": "#/components/schemas/Api.Gateway.ViewModel.PrincipalUser.AddressViewModel" }, "country": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean", "nullable": true }, "collectTransactionsAvailable": { "type": "boolean" } }, "additionalProperties": false }, "Microsoft.AspNetCore.Mvc.ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }