{ "openapi": "3.0.4", "info": { "title": "Merchant External API", "version": "1.0" }, "paths": { "/Secure/BankTransfer/Single": { "post": { "tags": [ "BankTransfer" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BankTransferRequestDto" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BankTransferRequestDto" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BankTransferRequestDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/BankTransfer/Multiple": { "post": { "tags": [ "BankTransfer" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BankTransferRequestDto" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BankTransferRequestDto" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BankTransferRequestDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/BankTransfer/BankingDetails": { "get": { "tags": [ "BankTransfer" ], "parameters": [ { "name": "bankReference", "in": "query", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/BulkPaymentRequests/Create": { "post": { "tags": [ "BulkPaymentRequests" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BulkPaymentRequestDto" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BulkPaymentRequestDto" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BulkPaymentRequestDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/BulkPaymentRequests/Compress": { "post": { "tags": [ "BulkPaymentRequests" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentRequestDto" } } }, "text/json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentRequestDto" } } }, "application/*+json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentRequestDto" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/BulkPaymentRequests/Decompress": { "post": { "tags": [ "BulkPaymentRequests" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BulkPaymentRequestCompressed" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BulkPaymentRequestCompressed" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/BulkPaymentRequestCompressed" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/BulkPaymentRequests/GetBulkJobByReference": { "get": { "tags": [ "BulkPaymentRequests" ], "parameters": [ { "name": "reference", "in": "query", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/get": { "get": { "tags": [ "Error" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/status500": { "get": { "tags": [ "Error" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/FloatTopUp/CreateFloatTopUpReferenceRequest": { "post": { "tags": [ "FloatTopUp" ], "parameters": [ { "name": "amount", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/FloatTopUp/GetFloatBalanceInfo": { "get": { "tags": [ "FloatTopUp" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/GetTransactionByReference": { "get": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "transactionReference", "in": "query", "schema": { "type": "string" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/GetTransactionByRequestId": { "get": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "requestId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/GetTransactionByReferenceDate": { "get": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "transactionReference", "in": "query", "schema": { "type": "string" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean" } }, { "name": "transactionDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/GetTransaction": { "get": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/GetBanks": { "get": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/PostPaymentRequest": { "post": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/IntPaymentRequest": { "post": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UniBridgeMerchantRequest" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UniBridgeMerchantRequest" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UniBridgeMerchantRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/PostAndSendPaymentRequest": { "post": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/SendPaymentRequestModel" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/SendPaymentRequestModel" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/SendPaymentRequestModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/GetTransactionReport": { "get": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/GetTransactionReportByStatusDate": { "get": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "statusStartDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "statusEndDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/PwaPostPaymentRequest": { "post": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/AddMerchantRequestPaymentSource": { "post": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestPayerSource" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestPayerSource" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestPayerSource" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/MerchantApiV1/TransactionDetailsByMerchantRequestId": { "get": { "tags": [ "MerchantApiV" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "merchantRequestIds", "in": "query", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDetailsDTO" } } }, "application/json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDetailsDTO" } } }, "text/json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDetailsDTO" } } } } } } } }, "/Secure/Payouts/GetPayouts": { "post": { "tags": [ "Payouts" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/PayoutsFilterModel" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/PayoutsFilterModel" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/PayoutsFilterModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/Payouts/GetPayoutByReference": { "post": { "tags": [ "Payouts" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/PayoutsFilterModel" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/PayoutsFilterModel" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/PayoutsFilterModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/ProviderResult": { "post": { "tags": [ "ProviderResult" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantProviderResultModel" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantProviderResultModel" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantProviderResultModel" } } } }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "ProviderResult" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Refunds/Submit": { "post": { "tags": [ "Refund" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefundRequest" } } }, "text/json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefundRequest" } } }, "application/*+json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefundRequest" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/Refunds/GetRefunds": { "get": { "tags": [ "Refund" ], "parameters": [ { "name": "refundDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Refunds/GetRefund": { "get": { "tags": [ "Refund" ], "parameters": [ { "name": "refundId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Refunds/GetRefundsByTransactionId": { "get": { "tags": [ "Refund" ], "parameters": [ { "name": "transactionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Request/ExpireMerchantRequest": { "post": { "tags": [ "Request" ], "parameters": [ { "name": "requestId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Request/GetRequestTransactionsByRequestId": { "get": { "tags": [ "Request" ], "parameters": [ { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "Id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/GetTransactionByReference": { "get": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "transactionReference", "in": "query", "schema": { "type": "string" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/GetTransactionByRequestId": { "get": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "requestId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/GetTransactionByReferenceDate": { "get": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "transactionReference", "in": "query", "schema": { "type": "string" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean" } }, { "name": "transactionDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/GetTransaction": { "get": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/GetBanks": { "get": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/PostPaymentRequest": { "post": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/IntPaymentRequest": { "post": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UniBridgeMerchantRequest" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UniBridgeMerchantRequest" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UniBridgeMerchantRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/PostAndSendPaymentRequest": { "post": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/SendPaymentRequestModel" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/SendPaymentRequestModel" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/SendPaymentRequestModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/GetTransactionReport": { "get": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/GetTransactionReportByStatusDate": { "get": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "statusStartDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "statusEndDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/PwaPostPaymentRequest": { "post": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/AddMerchantRequestPaymentSource": { "post": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestPayerSource" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestPayerSource" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestPayerSource" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/Transactions/TransactionDetailsByMerchantRequestId": { "get": { "tags": [ "SecureTransactions" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "merchantRequestIds", "in": "query", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDetailsDTO" } } }, "application/json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDetailsDTO" } } }, "text/json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDetailsDTO" } } } } } } } }, "/Secure/Settlements": { "get": { "tags": [ "Settlement" ], "parameters": [ { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Settlements/PaymentAdvice/{settlementId}": { "get": { "tags": [ "Settlement" ], "parameters": [ { "name": "settlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Secure/Settlements/GetSiteSettlements": { "get": { "tags": [ "Settlement" ], "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/ShopifyWebhook/ShopRedact": { "post": { "tags": [ "ShopifyWebhook" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/ShopRedact" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/ShopRedact" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/ShopRedact" } } } }, "responses": { "200": { "description": "OK" } } } }, "/ShopifyWebhook/CustomersRedact": { "post": { "tags": [ "ShopifyWebhook" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/CustomerDataRedact" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/CustomerDataRedact" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/CustomerDataRedact" } } } }, "responses": { "200": { "description": "OK" } } } }, "/ShopifyWebhook/CustomersDataRequest": { "post": { "tags": [ "ShopifyWebhook" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/CustomerDataRequest" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/CustomerDataRequest" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/CustomerDataRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/token": { "post": { "tags": [ "Token" ], "parameters": [ { "name": "ApiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "grant_type": { "type": "string" }, "SiteCode": { "type": "string" } } }, "encoding": { "grant_type": { "style": "form" }, "SiteCode": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Token" ], "parameters": [ { "name": "ApiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "grant_type": { "type": "string" }, "SiteCode": { "type": "string" } } }, "encoding": { "grant_type": { "style": "form" }, "SiteCode": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/GetTransactionByReference": { "get": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "transactionReference", "in": "query", "schema": { "type": "string" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/GetTransactionByRequestId": { "get": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "requestId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/GetTransactionByReferenceDate": { "get": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "transactionReference", "in": "query", "schema": { "type": "string" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean" } }, { "name": "transactionDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/GetTransaction": { "get": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "isTest", "in": "query", "schema": { "type": "boolean" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/GetBanks": { "get": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/PostPaymentRequest": { "post": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } } } }, "responses": { "200": { "description": "OK" } } } }, "/IntPaymentRequest": { "post": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UniBridgeMerchantRequest" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UniBridgeMerchantRequest" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UniBridgeMerchantRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/PostAndSendPaymentRequest": { "post": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/SendPaymentRequestModel" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/SendPaymentRequestModel" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/SendPaymentRequestModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/GetTransactionReport": { "get": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/GetTransactionReportByStatusDate": { "get": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "siteCode", "in": "query", "schema": { "type": "string" } }, { "name": "statusStartDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "statusEndDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/PwaPostPaymentRequest": { "post": { "tags": [ "Transaction" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestFields" } } } }, "responses": { "200": { "description": "OK" } } } }, "/AddMerchantRequestPaymentSource": { "post": { "tags": [ "Transaction" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestPayerSource" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestPayerSource" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/MerchantRequestPayerSource" } } } }, "responses": { "200": { "description": "OK" } } } }, "/TransactionDetailsByMerchantRequestId": { "get": { "tags": [ "Transaction" ], "parameters": [ { "name": "apiKey", "in": "header", "schema": { "type": "string" } }, { "name": "merchantRequestIds", "in": "query", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDetailsDTO" } } }, "application/json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDetailsDTO" } } }, "text/json; x-api-version=1.0": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDetailsDTO" } } } } } } } }, "/Secure/UserTransaction/AddUserTransaction": { "post": { "tags": [ "UserTransactionHistory" ], "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UserMerchantRequestModel" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UserMerchantRequestModel" } }, "application/*+json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/UserMerchantRequestModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Secure/UserTransaction/GetUserTransactionHistory": { "get": { "tags": [ "UserTransactionHistory" ], "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "BankTransferRequestDto": { "type": "object", "properties": { "siteCode": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "transactionReference": { "type": "string", "nullable": true }, "bankReference": { "type": "string", "nullable": true }, "optional1": { "type": "string", "nullable": true }, "optional2": { "type": "string", "nullable": true }, "optional3": { "type": "string", "nullable": true }, "optional4": { "type": "string", "nullable": true }, "optional5": { "type": "string", "nullable": true }, "customer": { "type": "string", "nullable": true }, "cancelUrl": { "type": "string", "nullable": true }, "successUrl": { "type": "string", "nullable": true }, "notifyUrl": { "type": "string", "nullable": true }, "expiryDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "customerCellphoneNumber": { "type": "string", "nullable": true }, "bankId": { "type": "string", "format": "uuid", "nullable": true }, "hashCheck": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkPaymentRequestCompressed": { "type": "object", "properties": { "compressedData": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkPaymentRequestDto": { "type": "object", "properties": { "jobReference": { "type": "string", "nullable": true }, "notifyUrl": { "type": "string", "nullable": true }, "compressedData": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CorrespondenceType": { "enum": [ "Sms", "Email", "WhatsApp" ], "type": "string" }, "Customer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerDataRedact": { "type": "object", "properties": { "shop_id": { "type": "integer", "format": "int32" }, "shop_domain": { "type": "string", "nullable": true }, "customer": { "$ref": "#/components/schemas/Customer" }, "orders_to_redact": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "CustomerDataRequest": { "type": "object", "properties": { "shop_id": { "type": "integer", "format": "int32" }, "shop_domain": { "type": "string", "nullable": true }, "orders_requested": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "customer": { "$ref": "#/components/schemas/Customer" }, "data_request": { "$ref": "#/components/schemas/DataRequest" } }, "additionalProperties": false }, "Data": { "type": "object", "properties": { "apiId": { "type": "string", "nullable": true }, "apiMessageId": { "type": "string", "nullable": true }, "clientMessageId": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "charge": { "type": "string", "nullable": true }, "messageStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DataRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MerchantProviderResultModel": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data" } }, "additionalProperties": false }, "MerchantRequestFields": { "required": [ "countryCode", "currencyCode", "hashCheck", "siteCode" ], "type": "object", "properties": { "siteCode": { "maxLength": 50, "minLength": 0, "type": "string" }, "amount": { "maximum": 2147483647, "minimum": 0, "type": "number", "format": "double" }, "transactionReference": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "countryCode": { "maxLength": 100, "minLength": 0, "type": "string" }, "currencyCode": { "maxLength": 10, "minLength": 0, "type": "string" }, "bankReference": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "hashCheck": { "maxLength": 250, "minLength": 0, "type": "string" }, "cancelUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "errorUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "successUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "notifyUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "customer": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "optional1": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "optional2": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "optional3": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "optional4": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "optional5": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "isTest": { "type": "boolean" }, "bankId": { "type": "string", "format": "uuid", "nullable": true }, "bankAccountNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "branchCode": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "bankAccountName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "payeeDisplayName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "isPublicRecipient": { "type": "boolean", "nullable": true }, "selectedBankId": { "type": "string", "format": "uuid", "nullable": true }, "expiryDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "allowVariableAmount": { "type": "boolean" }, "variableAmountMin": { "type": "number", "format": "double", "nullable": true }, "variableAmountMax": { "type": "number", "format": "double", "nullable": true }, "originalSiteCode": { "type": "string", "nullable": true }, "generateShortUrl": { "type": "boolean", "nullable": true }, "userAgent": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "registerTokenProfile": { "type": "boolean", "nullable": true }, "tokenNotificationUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "tokenDeletedNotificationUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "tokenProfileId": { "type": "string", "format": "uuid", "nullable": true }, "token": { "type": "string", "nullable": true }, "thirdProviderId": { "type": "string", "format": "uuid", "nullable": true }, "generateZeroRatedLink": { "type": "boolean", "nullable": true }, "userId": { "type": "string", "format": "uuid", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "profileId": { "type": "string", "format": "uuid", "nullable": true }, "customerIdentifier": { "type": "string", "nullable": true }, "customerCellphoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantRequestPayerSource": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "merchantRequestId": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "clientSourceName": { "type": "string", "nullable": true }, "clientSourceVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentRequestDto": { "type": "object", "properties": { "siteCode": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "transactionReference": { "type": "string", "nullable": true }, "bankReference": { "type": "string", "nullable": true }, "isTest": { "type": "boolean" }, "allowVariableAmount": { "type": "boolean", "nullable": true }, "variableAmountMin": { "type": "number", "format": "double", "nullable": true }, "variableAmountMax": { "type": "number", "format": "double", "nullable": true }, "recipientAddress": { "type": "string", "nullable": true }, "optional1": { "type": "string", "nullable": true }, "optional2": { "type": "string", "nullable": true }, "optional3": { "type": "string", "nullable": true }, "optional4": { "type": "string", "nullable": true }, "optional5": { "type": "string", "nullable": true }, "customer": { "type": "string", "nullable": true }, "cancelUrl": { "type": "string", "nullable": true }, "errorUrl": { "type": "string", "nullable": true }, "successUrl": { "type": "string", "nullable": true }, "notifyUrl": { "type": "string", "nullable": true }, "bankId": { "type": "string", "format": "uuid", "nullable": true }, "bankAccountNumber": { "type": "string", "nullable": true }, "branchCode": { "type": "string", "nullable": true }, "bankAccountName": { "type": "string", "nullable": true }, "branchName": { "type": "string", "nullable": true }, "payeeDisplayName": { "type": "string", "nullable": true }, "expiryDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "correspondenceType": { "$ref": "#/components/schemas/CorrespondenceType" }, "paymentLink": { "type": "string", "nullable": true }, "errors": { "type": "string", "nullable": true }, "jobId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "PayoutField": { "enum": [ "Amount", "MerchantReference", "CustomerBankReference", "BranchCode", "CreatedDate" ], "type": "string" }, "PayoutsFilterModel": { "type": "object", "properties": { "pageSize": { "type": "integer", "format": "int32" }, "pageIndex": { "type": "integer", "format": "int32", "nullable": true }, "sortDirection": { "$ref": "#/components/schemas/SortOrder" }, "sortField": { "$ref": "#/components/schemas/PayoutField" }, "searchFields": { "type": "array", "items": { "$ref": "#/components/schemas/PayoutField" }, "nullable": true }, "searchString": { "type": "string", "nullable": true }, "bank": { "type": "string", "format": "uuid", "nullable": true }, "minAmount": { "type": "number", "format": "double", "nullable": true }, "maxAmount": { "type": "number", "format": "double", "nullable": true }, "dateFrom": { "type": "string", "format": "date-time", "nullable": true }, "dateTo": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/Status" }, "subStatus": { "$ref": "#/components/schemas/SubStatus" }, "isRtc": { "type": "boolean" } }, "additionalProperties": false }, "RefundRequest": { "required": [ "hashCheck" ], "type": "object", "properties": { "transactionId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "refundReason": { "type": "string", "nullable": true }, "notifyUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "hashCheck": { "type": "string", "nullable": true }, "isTest": { "type": "boolean" }, "isRtc": { "type": "boolean", "default": false } }, "additionalProperties": false }, "SendPaymentRequestModel": { "type": "object", "properties": { "requestFields": { "$ref": "#/components/schemas/MerchantRequestFields" }, "correspondenceType": { "$ref": "#/components/schemas/CorrespondenceType" }, "address": { "maxLength": 250, "type": "string", "nullable": true } }, "additionalProperties": false }, "ShopRedact": { "type": "object", "properties": { "shop_id": { "type": "integer", "format": "int32" }, "shop_domain": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SortOrder": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "Status": { "enum": [ "PayoutReceived", "Verification", "SubmittedForProcessing", "PayoutProcessingError", "PayoutComplete", "PayoutPendingInvestigation", "CancellationPending", "PayoutReturned", "PayoutCancelled" ], "type": "string" }, "SubStatus": { "enum": [ "Payout_Unclassified", "Payout_ValidationFailed", "Verification_Pending", "Verification_Failed", "Verification_Success", "Verification_Error", "Verification_AccountNumberDecryptionFailed", "Verification_Success_Awaiting_Funds", "Verification_Success_Awaiting_Submission", "SubmittedForProcessing_PayoutAddedToBatch", "SubmittedForProcessing_PayoutSubmittedToBank", "SubmittedForProcessing_PayoutSubmittedToPpi", "PayoutProcessingError_PayoutRejected", "PayoutProcessingError_PayoutCancelled", "PayoutProcessingError_Insufficient_Balance", "PayoutProcessingError_PayoutInternalError", "PayoutProcessingError_InvalidAccountNumber", "PayoutPendingInvestigation_AmountMismatch", "PayoutReturned_Unpaid", "Cancellation_AddedToBatch", "Cancellation_SubmittedToBank", "Cancellation_RejectedByBank", "Cancellation_AccountNumberValidationFailed", "Cancellation_PayoutAlreadyProcessed", "Cancellation_CancelledByMerchantBeforeBankSubmission", "Cancellation_CancelledByMerchant" ], "type": "string" }, "TransactionDetailsDTO": { "type": "object", "properties": { "merchantRequestId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "bankReference": { "type": "string", "nullable": true }, "siteCode": { "type": "string", "nullable": true }, "sideCodeId": { "type": "string", "format": "uuid" }, "merchantId": { "type": "string", "format": "uuid" }, "siteName": { "type": "string", "nullable": true }, "merchantName": { "type": "string", "nullable": true }, "transactionStatusId": { "type": "integer", "format": "int32", "nullable": true }, "transactionStatusDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "UniBridgeMerchantRequest": { "required": [ "countryCode", "currencyCode", "hashCheck", "siteCode" ], "type": "object", "properties": { "siteCode": { "maxLength": 50, "minLength": 0, "type": "string" }, "amount": { "maximum": 2147483647, "minimum": 0, "type": "number", "format": "double" }, "transactionReference": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "countryCode": { "maxLength": 100, "minLength": 0, "type": "string" }, "currencyCode": { "maxLength": 10, "minLength": 0, "type": "string" }, "bankReference": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "hashCheck": { "maxLength": 250, "minLength": 0, "type": "string" }, "cancelUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "errorUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "successUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "notifyUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "customer": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "optional1": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "optional2": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "optional3": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "optional4": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "optional5": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "isTest": { "type": "boolean" }, "bankId": { "type": "string", "format": "uuid", "nullable": true }, "bankAccountNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "branchCode": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "bankAccountName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "payeeDisplayName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "isPublicRecipient": { "type": "boolean", "nullable": true }, "selectedBankId": { "type": "string", "format": "uuid", "nullable": true }, "expiryDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "allowVariableAmount": { "type": "boolean" }, "variableAmountMin": { "type": "number", "format": "double", "nullable": true }, "variableAmountMax": { "type": "number", "format": "double", "nullable": true }, "originalSiteCode": { "type": "string", "nullable": true }, "generateShortUrl": { "type": "boolean", "nullable": true }, "userAgent": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "registerTokenProfile": { "type": "boolean", "nullable": true }, "tokenNotificationUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "tokenDeletedNotificationUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "tokenProfileId": { "type": "string", "format": "uuid", "nullable": true }, "token": { "type": "string", "nullable": true }, "thirdProviderId": { "type": "string", "format": "uuid", "nullable": true }, "generateZeroRatedLink": { "type": "boolean", "nullable": true }, "userId": { "type": "string", "format": "uuid", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "profileId": { "type": "string", "format": "uuid", "nullable": true }, "customerIdentifier": { "type": "string", "nullable": true }, "customerCellphoneNumber": { "type": "string", "nullable": true }, "customerEmailAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserMerchantRequestModel": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "merchantRequestId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Bearer Authentication with JWT Token", "scheme": "Bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "BankTransfer" }, { "name": "BulkPaymentRequests" }, { "name": "Error" }, { "name": "FloatTopUp" }, { "name": "MerchantApiV" }, { "name": "Payouts" }, { "name": "ProviderResult" }, { "name": "Refund" }, { "name": "Request" }, { "name": "SecureTransactions" }, { "name": "Settlement" }, { "name": "ShopifyWebhook" }, { "name": "Token" }, { "name": "Transaction" }, { "name": "UserTransactionHistory" } ] }