{ "openapi": "3.0.1", "info": { "title": "IOLPay Payment API (Public)", "description": "Client-facing IOLPay Payment API for merchant integrations. Authenticate using X-ApiKey or JWT Bearer as documented per endpoint.", "contact": { "name": "iOLPay Support", "email": "support@iolpay.com" }, "version": "2" }, "paths": { "/payment-api/v2/order/{transactionId}": { "get": { "tags": [ "Order" ], "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderGetModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderGetModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderGetModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/order/search": { "post": { "tags": [ "Order" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OrderQueryListRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderQueryListRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderQueryListRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderQueryListRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderListModelListPaginatedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderListModelListPaginatedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderListModelListPaginatedResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/order/orderStatus/{transactionId}": { "get": { "tags": [ "Order" ], "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderGetModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderGetModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderGetModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/order": { "put": { "tags": [ "Order" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OrderPutModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderPutModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderPutModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderPutModel" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "object", "properties": { "ORDER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_CANCELLED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_PAID": { "type": "array", "items": { "type": "string" } }, "INVALID_SCHEDULED_PAYMENT_LIST": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_STATUS_CANNOT_BE_UPDATED": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_UNAVAILABLE_TO_UPDATE": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_DATE_IN_PAST": { "type": "array", "items": { "type": "string" } }, "STATUS_OF_NEW_SCHEDULED_PAYMENT_INVALID": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "MERCHANT_IS_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "NO_UPCOMING_SCHEDULED_PAYMENTS": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "USER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_REFUNDED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_VOIDED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "application/json": { "schema": { "type": "object", "properties": { "ORDER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_CANCELLED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_PAID": { "type": "array", "items": { "type": "string" } }, "INVALID_SCHEDULED_PAYMENT_LIST": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_STATUS_CANNOT_BE_UPDATED": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_UNAVAILABLE_TO_UPDATE": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_DATE_IN_PAST": { "type": "array", "items": { "type": "string" } }, "STATUS_OF_NEW_SCHEDULED_PAYMENT_INVALID": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "MERCHANT_IS_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "NO_UPCOMING_SCHEDULED_PAYMENTS": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "USER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_REFUNDED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_VOIDED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "text/json": { "schema": { "type": "object", "properties": { "ORDER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_CANCELLED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_PAID": { "type": "array", "items": { "type": "string" } }, "INVALID_SCHEDULED_PAYMENT_LIST": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_STATUS_CANNOT_BE_UPDATED": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_UNAVAILABLE_TO_UPDATE": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_DATE_IN_PAST": { "type": "array", "items": { "type": "string" } }, "STATUS_OF_NEW_SCHEDULED_PAYMENT_INVALID": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "MERCHANT_IS_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "NO_UPCOMING_SCHEDULED_PAYMENTS": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "USER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_REFUNDED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_VOIDED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/order/updateReferenceNo": { "put": { "tags": [ "Order" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OrderReferenceNoPutModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderReferenceNoPutModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderReferenceNoPutModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderReferenceNoPutModel" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "object", "properties": { "ORDER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_CANCELLED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_PAID": { "type": "array", "items": { "type": "string" } }, "INVALID_SCHEDULED_PAYMENT_LIST": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_STATUS_CANNOT_BE_UPDATED": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_UNAVAILABLE_TO_UPDATE": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_DATE_IN_PAST": { "type": "array", "items": { "type": "string" } }, "STATUS_OF_NEW_SCHEDULED_PAYMENT_INVALID": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "MERCHANT_IS_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "NO_UPCOMING_SCHEDULED_PAYMENTS": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "USER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_REFUNDED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_VOIDED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "application/json": { "schema": { "type": "object", "properties": { "ORDER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_CANCELLED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_PAID": { "type": "array", "items": { "type": "string" } }, "INVALID_SCHEDULED_PAYMENT_LIST": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_STATUS_CANNOT_BE_UPDATED": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_UNAVAILABLE_TO_UPDATE": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_DATE_IN_PAST": { "type": "array", "items": { "type": "string" } }, "STATUS_OF_NEW_SCHEDULED_PAYMENT_INVALID": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "MERCHANT_IS_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "NO_UPCOMING_SCHEDULED_PAYMENTS": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "USER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_REFUNDED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_VOIDED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "text/json": { "schema": { "type": "object", "properties": { "ORDER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_CANCELLED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_PAID": { "type": "array", "items": { "type": "string" } }, "INVALID_SCHEDULED_PAYMENT_LIST": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_STATUS_CANNOT_BE_UPDATED": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_UNAVAILABLE_TO_UPDATE": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_DATE_IN_PAST": { "type": "array", "items": { "type": "string" } }, "STATUS_OF_NEW_SCHEDULED_PAYMENT_INVALID": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "MERCHANT_IS_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "NO_UPCOMING_SCHEDULED_PAYMENTS": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "USER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_REFUNDED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_VOIDED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/order/{transactionId}/cancel/{statusDetail}": { "post": { "tags": [ "Order" ], "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statusDetail", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrderStatusDetail" } }, { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "object", "properties": { "ORDER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_CANCELLED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_PAID": { "type": "array", "items": { "type": "string" } }, "INVALID_SCHEDULED_PAYMENT_LIST": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_STATUS_CANNOT_BE_UPDATED": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_UNAVAILABLE_TO_UPDATE": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_DATE_IN_PAST": { "type": "array", "items": { "type": "string" } }, "STATUS_OF_NEW_SCHEDULED_PAYMENT_INVALID": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "MERCHANT_IS_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "NO_UPCOMING_SCHEDULED_PAYMENTS": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "USER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_REFUNDED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_VOIDED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "application/json": { "schema": { "type": "object", "properties": { "ORDER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_CANCELLED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_PAID": { "type": "array", "items": { "type": "string" } }, "INVALID_SCHEDULED_PAYMENT_LIST": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_STATUS_CANNOT_BE_UPDATED": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_UNAVAILABLE_TO_UPDATE": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_DATE_IN_PAST": { "type": "array", "items": { "type": "string" } }, "STATUS_OF_NEW_SCHEDULED_PAYMENT_INVALID": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "MERCHANT_IS_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "NO_UPCOMING_SCHEDULED_PAYMENTS": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "USER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_REFUNDED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_VOIDED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "text/json": { "schema": { "type": "object", "properties": { "ORDER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_CANCELLED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_PAID": { "type": "array", "items": { "type": "string" } }, "INVALID_SCHEDULED_PAYMENT_LIST": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_STATUS_CANNOT_BE_UPDATED": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_UNAVAILABLE_TO_UPDATE": { "type": "array", "items": { "type": "string" } }, "SCHEDULED_PAYMENT_DATE_IN_PAST": { "type": "array", "items": { "type": "string" } }, "STATUS_OF_NEW_SCHEDULED_PAYMENT_INVALID": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "MERCHANT_IS_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "NO_UPCOMING_SCHEDULED_PAYMENTS": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "USER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_REFUNDED": { "type": "array", "items": { "type": "string" } }, "ORDER_IS_VOIDED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/order/{transactionId}/email-history": { "get": { "tags": [ "Order" ], "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EmailHistoryGetModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EmailHistoryGetModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailHistoryGetModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/payment/{transactionId}": { "get": { "tags": [ "Payment" ], "parameters": [ { "name": "transactionId", "in": "query", "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentListModelProceedPaymentErrorsResultModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentListModelProceedPaymentErrorsResultModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentListModelProceedPaymentErrorsResultModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } } } } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/payment": { "get": { "tags": [ "Payment" ], "parameters": [ { "name": "PaymentStatus", "in": "query", "schema": { "$ref": "#/components/schemas/PaymentStatus" } }, { "name": "CreatedFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "CreatedTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MerchantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "TransactionId", "in": "query", "schema": { "type": "string" } }, { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ExternalId", "in": "query", "schema": { "type": "string" } }, { "name": "Currency", "in": "query", "schema": { "type": "string" } }, { "name": "CustomerEmail", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ExternalChargeId", "in": "query", "schema": { "type": "string" } }, { "name": "SaveOldInternalDetails", "in": "query", "schema": { "type": "boolean" } }, { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentListModelProceedPaymentErrorsResultModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentListModelProceedPaymentErrorsResultModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentListModelProceedPaymentErrorsResultModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } } } } }, "security": [ { "Bearer": [ ] } ] }, "post": { "tags": [ "Payment" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PaymentIntentRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PaymentIntentRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentIntentResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntentPaymentErrorsErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntentPaymentErrorsErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntentPaymentErrorsErrorResult" } } } } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Payment" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProceedPaymentResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } } } } } } }, "/payment-api/v2/payment/captures": { "post": { "tags": [ "Payment" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthStatus" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/payment/authorizations": { "post": { "tags": [ "Payment" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthStatus" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/payment/authorizations/void": { "post": { "tags": [ "Payment" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizeCreateModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthStatus" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/payment/pay-in-list": { "get": { "tags": [ "Payment" ], "parameters": [ { "name": "paymentMethodExternalId", "in": "query", "schema": { "type": "string" } }, { "name": "pubKey", "in": "query", "schema": { "type": "string" } }, { "name": "paymentProviderType", "in": "query", "schema": { "$ref": "#/components/schemas/PaymentProviderType" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentPayInList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentPayInList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentPayInList" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "object", "properties": { "CUSTOM": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "MERCHANT_SERVICE_UNAVAILABLE": { "type": "array", "items": { "type": "string" } }, "PUB_KEY_EXPIRED": { "type": "array", "items": { "type": "string" } }, "PUB_KEY_INVALID": { "type": "array", "items": { "type": "string" } }, "INVALID_AMOUNT": { "type": "array", "items": { "type": "string" } }, "INVALID_PAYMENT_METHOD": { "type": "array", "items": { "type": "string" } }, "PAYMENT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "CUSTOMER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "TRANSACTION_ALREADY_EXISTS": { "type": "array", "items": { "type": "string" } }, "CARD_COUNTRY_DOEST_NOT_MATCH": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_DONE": { "type": "array", "items": { "type": "string" } }, "CARD_DECLINED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_INTENT_PROVIDER_ERROR": { "type": "array", "items": { "type": "string" } }, "CARD_BRAND_IS_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_SUPPORTED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_LINK_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "CARD_DOES_NOT_MATCH_THE_ACCEPTED_CARD_DETAILS": { "type": "array", "items": { "type": "string" } }, "INVALID_CARD_EXPIRATION_DATE": { "type": "array", "items": { "type": "string" } }, "INVALID_CARD_FOR_PROMOTION": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_DISPUTED": { "type": "array", "items": { "type": "string" } }, "AUTH_CANCEL_FAILED": { "type": "array", "items": { "type": "string" } }, "CAPTURE_FAILED": { "type": "array", "items": { "type": "string" } }, "PARTIAL_AUTH_FAILED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_BOOKING_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "PAYMENT_BOOKING_ERROR": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_CANCELED": { "type": "array", "items": { "type": "string" } }, "AUTHENTICATION_INITIATED_FAILED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "application/json": { "schema": { "type": "object", "properties": { "CUSTOM": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "MERCHANT_SERVICE_UNAVAILABLE": { "type": "array", "items": { "type": "string" } }, "PUB_KEY_EXPIRED": { "type": "array", "items": { "type": "string" } }, "PUB_KEY_INVALID": { "type": "array", "items": { "type": "string" } }, "INVALID_AMOUNT": { "type": "array", "items": { "type": "string" } }, "INVALID_PAYMENT_METHOD": { "type": "array", "items": { "type": "string" } }, "PAYMENT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "CUSTOMER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "TRANSACTION_ALREADY_EXISTS": { "type": "array", "items": { "type": "string" } }, "CARD_COUNTRY_DOEST_NOT_MATCH": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_DONE": { "type": "array", "items": { "type": "string" } }, "CARD_DECLINED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_INTENT_PROVIDER_ERROR": { "type": "array", "items": { "type": "string" } }, "CARD_BRAND_IS_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_SUPPORTED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_LINK_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "CARD_DOES_NOT_MATCH_THE_ACCEPTED_CARD_DETAILS": { "type": "array", "items": { "type": "string" } }, "INVALID_CARD_EXPIRATION_DATE": { "type": "array", "items": { "type": "string" } }, "INVALID_CARD_FOR_PROMOTION": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_DISPUTED": { "type": "array", "items": { "type": "string" } }, "AUTH_CANCEL_FAILED": { "type": "array", "items": { "type": "string" } }, "CAPTURE_FAILED": { "type": "array", "items": { "type": "string" } }, "PARTIAL_AUTH_FAILED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_BOOKING_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "PAYMENT_BOOKING_ERROR": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_CANCELED": { "type": "array", "items": { "type": "string" } }, "AUTHENTICATION_INITIATED_FAILED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "text/json": { "schema": { "type": "object", "properties": { "CUSTOM": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "MERCHANT_SERVICE_UNAVAILABLE": { "type": "array", "items": { "type": "string" } }, "PUB_KEY_EXPIRED": { "type": "array", "items": { "type": "string" } }, "PUB_KEY_INVALID": { "type": "array", "items": { "type": "string" } }, "INVALID_AMOUNT": { "type": "array", "items": { "type": "string" } }, "INVALID_PAYMENT_METHOD": { "type": "array", "items": { "type": "string" } }, "PAYMENT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "CUSTOMER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "TRANSACTION_ALREADY_EXISTS": { "type": "array", "items": { "type": "string" } }, "CARD_COUNTRY_DOEST_NOT_MATCH": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_DONE": { "type": "array", "items": { "type": "string" } }, "CARD_DECLINED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_INTENT_PROVIDER_ERROR": { "type": "array", "items": { "type": "string" } }, "CARD_BRAND_IS_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_SUPPORTED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_LINK_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "CARD_DOES_NOT_MATCH_THE_ACCEPTED_CARD_DETAILS": { "type": "array", "items": { "type": "string" } }, "INVALID_CARD_EXPIRATION_DATE": { "type": "array", "items": { "type": "string" } }, "INVALID_CARD_FOR_PROMOTION": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_DISPUTED": { "type": "array", "items": { "type": "string" } }, "AUTH_CANCEL_FAILED": { "type": "array", "items": { "type": "string" } }, "CAPTURE_FAILED": { "type": "array", "items": { "type": "string" } }, "PARTIAL_AUTH_FAILED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_BOOKING_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "PAYMENT_BOOKING_ERROR": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_CANCELED": { "type": "array", "items": { "type": "string" } }, "AUTHENTICATION_INITIATED_FAILED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "500": { "description": "Server Error" } } } }, "/payment-api/v2/payment/redirect/{paymentId}": { "get": { "tags": [ "Payment" ], "parameters": [ { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "cancel", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success" } } } }, "/payment-api/v2/payment/sendPaymentLink": { "post": { "tags": [ "Payment" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SendPaymentEmailDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendPaymentEmailDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendPaymentEmailDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendPaymentEmailDto" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } } } } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/payment/sendPaymentLink/WhatsApp": { "post": { "tags": [ "Payment" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SendWhatsappPaymentLinkRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendWhatsappPaymentLinkRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendWhatsappPaymentLinkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendWhatsappPaymentLinkRequest" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProceedPaymentErrorsErrorResult" } } } } }, "security": [ { "Bearer": [ ] } ] } }, "/payment-api/v2/refunds": { "post": { "tags": [ "Refunds" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RefundCreateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RefundCreateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefundCreateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefundCreateModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RefundStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RefundStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefundStatus" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Refunds" ], "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "MerchantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "JWT Bearer token. Format: Bearer {token}", "required": true, "schema": { "type": "string" } }, { "name": "MerchantId", "in": "header", "description": "Target merchant identifier for JWT-authenticated admin or portal requests.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RefundListModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RefundListModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefundListModel" } } } }, "500": { "description": "Server Error" } }, "security": [ { "Bearer": [ ] } ] } } }, "components": { "schemas": { "AuthStatus": { "enum": [ "Pending", "Succeeded", "Failed" ], "type": "string" }, "AuthorizeCreateModel": { "type": "object", "properties": { "transactionId": { "type": "string", "nullable": true }, "paymentIntentId": { "type": "integer", "format": "int32", "nullable": true }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "BookingSourceType": { "enum": [ "None", "Ows", "Cendyn", "Oracle" ], "type": "string" }, "CountryDTO": { "type": "object", "properties": { "iso": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrencyDTO": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "iso": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "decimals": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EmailHistoryGetModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmailHistoryItemModel" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/EmailHistoryPaginationModel" }, "referenceType": { "type": "string", "nullable": true }, "referenceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailHistoryItemModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "to": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailHistoryPaginationModel": { "type": "object", "properties": { "limit": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EmailTemplateType": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37 ], "type": "integer", "format": "int32" }, "FeeType": { "enum": [ "DM", "IN", "FX", "APM", "RF", "FX_NSC", "AC", "Monthly", "Dispute", "Remittance", "PayoutFXC", "PayoutFXFee" ], "type": "string" }, "IntentPaymentErrorsErrorResult": { "type": "object", "properties": { "errors": { "type": "object", "properties": { "INVALID_AMOUNT": { "type": "array", "items": { "type": "string" } }, "AMOUNT_SMALLER_THAN_REQUIRED": { "type": "array", "items": { "type": "string" } }, "MERCHANT_SERVICE_UNAVAILABLE": { "type": "array", "items": { "type": "string" } }, "TRANSACTION_ALREADY_EXISTS": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "LPM_IS_INVALID": { "type": "array", "items": { "type": "string" } }, "USER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "INVALID_WALLET_ITEM": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "nullable": true }, "hasErrors": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MessageBoxTemplateType": { "enum": [ "ios_payment_link", "ios_payment_reservation", "ios_payment_manual", "ios_payment_success", "ios_payment_failure", "confirmation_letter", "online_checkin_v2", "welcome_message" ], "type": "string" }, "OrderCreatedUserDetailGetModel": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "merchantId": { "type": "integer", "format": "int64" }, "merchantName": { "type": "string", "nullable": true }, "userApiKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderGetModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "transactionId": { "type": "string", "nullable": true }, "statusId": { "$ref": "#/components/schemas/OrderStatus" }, "sourceType": { "$ref": "#/components/schemas/BookingSourceType" }, "payerDetails": { "$ref": "#/components/schemas/OrderPayerDetailsItemGetModel" }, "travelerDetails": { "$ref": "#/components/schemas/OrderTravelerDetailsItemGetModel" }, "paymentDetails": { "$ref": "#/components/schemas/OrderPaymentDetailsItemGetModel" }, "hotelDetails": { "$ref": "#/components/schemas/OrderHotelItemGetModel" }, "createdUserDetail": { "$ref": "#/components/schemas/OrderCreatedUserDetailGetModel" }, "returnUrlSuccess": { "type": "string", "nullable": true }, "returnUrlCancel": { "type": "string", "nullable": true }, "webhookUrl": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "merchantName": { "type": "string", "nullable": true }, "merchantGroupId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "OrderHotelDetailsDto": { "type": "object", "properties": { "hotelName": { "type": "string", "nullable": true }, "roomType": { "type": "string", "nullable": true }, "mealType": { "type": "string", "nullable": true }, "checkInDate": { "type": "string", "format": "date-time" }, "checkOutDate": { "type": "string", "format": "date-time" }, "ratePlanCode": { "type": "string", "nullable": true }, "ratePlanDescription": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderHotelItemGetModel": { "type": "object", "properties": { "hotelName": { "type": "string", "nullable": true }, "roomType": { "type": "string", "nullable": true }, "mealType": { "type": "string", "nullable": true }, "checkInDate": { "type": "string", "format": "date-time" }, "checkOutDate": { "type": "string", "format": "date-time" }, "ratePlanCode": { "type": "string", "nullable": true }, "ratePlanDescription": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderLineItemGetModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "itemRef": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "description": { "type": "string", "nullable": true }, "productCode": { "type": "string", "nullable": true }, "tax": { "type": "number", "format": "double" }, "amountAfterTax": { "type": "number", "format": "double" }, "pmsReferenceNo": { "type": "string", "nullable": true }, "crsReferenceNo": { "type": "string", "nullable": true }, "mealType": { "type": "string", "nullable": true }, "roomType": { "type": "string", "nullable": true }, "ratePlanCode": { "type": "string", "nullable": true }, "transactionTypeId": { "type": "integer", "format": "int32" }, "checkInDate": { "type": "string", "format": "date-time", "nullable": true }, "checkOutDate": { "type": "string", "format": "date-time", "nullable": true }, "pmsPosted": { "type": "boolean" }, "pmsPostedDate": { "type": "string", "format": "date-time", "nullable": true }, "pmsPostingProcessed": { "type": "boolean" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OrderLineItemModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "orderId": { "type": "integer", "format": "int64" }, "itemRef": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "description": { "type": "string", "nullable": true }, "productCode": { "type": "string", "nullable": true }, "tax": { "type": "number", "format": "double" }, "amountAfterTax": { "type": "number", "format": "double" }, "pmsReferenceNo": { "type": "string", "nullable": true }, "crsReferenceNo": { "type": "string", "nullable": true }, "mealType": { "type": "string", "nullable": true }, "roomType": { "type": "string", "nullable": true }, "ratePlanCode": { "type": "string", "nullable": true }, "transactionTypeId": { "type": "integer", "format": "int32" }, "checkInDate": { "type": "string", "format": "date-time", "nullable": true }, "checkOutDate": { "type": "string", "format": "date-time", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "OrderListModel": { "type": "object", "properties": { "merchantId": { "type": "integer", "format": "int32" }, "orderDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "orderType": { "type": "string", "nullable": true }, "statusName": { "type": "string", "nullable": true }, "authorizationType": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "referenceNo": { "type": "string", "nullable": true }, "payerName": { "type": "string", "nullable": true }, "payerEmail": { "type": "string", "nullable": true }, "payerPhone": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "currencyIso": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "pmsPosting": { "type": "boolean", "nullable": true }, "pmsPosted": { "type": "boolean", "nullable": true }, "pmsPostedDate": { "type": "string", "format": "date-time", "nullable": true }, "paymentDate": { "type": "string", "format": "date-time", "nullable": true }, "isVcc": { "type": "boolean", "nullable": true }, "checkInDate": { "type": "string", "format": "date-time", "nullable": true }, "checkOutDate": { "type": "string", "format": "date-time", "nullable": true }, "createUser": { "type": "string", "nullable": true }, "updateUser": { "type": "string", "nullable": true }, "updateAt": { "type": "string", "format": "date-time", "nullable": true }, "statusId": { "type": "integer", "format": "int32" }, "statusCode": { "type": "string", "nullable": true }, "statusDetailId": { "type": "integer", "format": "int32", "nullable": true }, "statusDetailName": { "type": "string", "nullable": true }, "minPaymentProcessedDate": { "type": "string", "format": "date-time", "nullable": true }, "minPaymentDueDate": { "type": "string", "format": "date-time", "nullable": true }, "paymentError": { "type": "string", "nullable": true }, "pmsReferenceNo": { "type": "string", "nullable": true }, "paymentLinkExpiryDate": { "type": "string", "format": "date-time", "nullable": true }, "totalAmountProcessed": { "type": "number", "format": "double", "nullable": true }, "totalAmountRefunded": { "type": "number", "format": "double", "nullable": true }, "payoutType": { "type": "string", "nullable": true }, "ratePlanCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderListModelListPaginatedResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderListModel" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "OrderPayerDetailsItemGetModel": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int64" }, "payerTitle": { "type": "string", "nullable": true }, "payerName": { "type": "string", "nullable": true }, "payerEmail": { "type": "string", "nullable": true }, "payerCountry": { "type": "string", "nullable": true }, "payerPhone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderPaymentDetailsItemGetModel": { "type": "object", "properties": { "referenceNo": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "orderDate": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "description": { "type": "string", "nullable": true }, "serviceDate": { "type": "string", "format": "date-time", "nullable": true }, "paymentDate": { "type": "string", "format": "date-time", "nullable": true }, "cancelDate": { "type": "string", "format": "date-time", "nullable": true }, "mode": { "$ref": "#/components/schemas/PaymentMode" }, "statementSuffix": { "type": "string", "nullable": true }, "imageLink": { "type": "string", "nullable": true }, "submitLabel": { "type": "string", "nullable": true }, "orderFor": { "type": "string", "nullable": true }, "isVcc": { "type": "boolean" }, "pmsPosting": { "type": "boolean" }, "pmsPosted": { "type": "boolean" }, "pmsPostedDate": { "type": "string", "format": "date-time", "nullable": true }, "pmsPostingProcessed": { "type": "boolean" }, "pmsRefundPostingProcessed": { "type": "boolean" }, "pmsRefundPosted": { "type": "boolean" }, "merchantId": { "type": "integer", "format": "int32" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "paymentSchedule": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledPaymentItemGetModel" }, "nullable": true }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemGetModel" }, "nullable": true }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPaymentItemGetModel" }, "nullable": true }, "paymentLinks": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPaymentLinkItemGetModel" }, "nullable": true } }, "additionalProperties": false }, "OrderPaymentDetailsItemModel": { "type": "object", "properties": { "referenceNo": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "orderDate": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "paymentDate": { "type": "string", "format": "date-time", "nullable": true }, "mode": { "$ref": "#/components/schemas/PaymentMode" }, "statementSuffix": { "type": "string", "nullable": true }, "imageLink": { "type": "string", "nullable": true }, "submitLabel": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "paymentSchedule": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledPaymentItemModel" }, "nullable": true }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemModel" }, "nullable": true } }, "additionalProperties": false }, "OrderPaymentFailDetailsItemGetModel": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "networkStatus": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "riskLevel": { "type": "string", "nullable": true }, "sellerMessage": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "paymentMethod": { "$ref": "#/components/schemas/OrderPaymentMethodItemGetModel" } }, "additionalProperties": false }, "OrderPaymentFeeItemGetModel": { "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/FeeType" }, "fixedValue": { "type": "number", "format": "double" }, "variableValue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "OrderPaymentItemGetModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "scheduledPaymentId": { "type": "integer", "format": "int64", "nullable": true }, "currencyIso": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "netAmount": { "type": "number", "format": "double" }, "paymentCurrencyIso": { "type": "string", "nullable": true }, "paymentAmount": { "type": "number", "format": "double" }, "exchangeRate": { "type": "number", "format": "double", "nullable": true }, "feePercAmount": { "type": "number", "format": "double", "nullable": true }, "paymentProcessedDate": { "type": "string", "format": "date-time" }, "payoutAvailableDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/PaymentStatus" }, "externalId": { "type": "string", "nullable": true }, "varianceAmount": { "type": "number", "format": "double", "nullable": true }, "autoConverted": { "type": "boolean", "nullable": true }, "type": { "$ref": "#/components/schemas/PaymentIntentType" }, "isDirect": { "type": "boolean" }, "authCode": { "type": "string", "nullable": true }, "paymentMethod": { "$ref": "#/components/schemas/OrderPaymentMethodItemGetModel" }, "fees": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPaymentFeeItemGetModel" }, "nullable": true }, "failures": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPaymentFailDetailsItemGetModel" }, "nullable": true }, "refunds": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPaymentRefundItemGetModel" }, "nullable": true } }, "additionalProperties": false }, "OrderPaymentLinkItemGetModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "paymentIntentId": { "type": "integer", "format": "int64" }, "paymentLink": { "type": "string", "nullable": true }, "paymentLinkKey": { "type": "string", "nullable": true }, "encryptedPubKey": { "type": "string", "nullable": true }, "expiryDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OrderPaymentMethodItemGetModel": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "brand": { "type": "string", "nullable": true }, "brandProductCode": { "type": "string", "nullable": true }, "issueCountry": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "last4": { "type": "string", "nullable": true }, "expMonth": { "type": "integer", "format": "int64" }, "expYear": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "OrderPaymentRefundItemGetModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "externalId": { "type": "string", "nullable": true }, "paymentIntentId": { "type": "integer", "format": "int64" }, "orderId": { "type": "integer", "format": "int64" }, "status": { "$ref": "#/components/schemas/RefundStatus" }, "created": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "requestedAmount": { "type": "number", "format": "double" }, "requestedCurrency": { "type": "string", "nullable": true }, "usAmountRequested": { "type": "number", "format": "double" }, "usAmountRefunded": { "type": "number", "format": "double" }, "createUserId": { "type": "string", "format": "uuid", "nullable": true }, "createdUserName": { "type": "string", "nullable": true }, "scheduledPaymentId": { "type": "integer", "format": "int64", "nullable": true }, "orderItemId": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "OrderPutModel": { "type": "object", "properties": { "transactionId": { "type": "string", "nullable": true }, "paymentDetails": { "$ref": "#/components/schemas/OrderPaymentDetailsItemModel" }, "returnUrlSuccess": { "type": "string", "nullable": true }, "returnUrlCancel": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderQueryListRequest": { "type": "object", "properties": { "merchantIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "statusIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "createDateStart": { "type": "string", "format": "date-time", "nullable": true }, "createDateEnd": { "type": "string", "format": "date-time", "nullable": true }, "dueDateStart": { "type": "string", "format": "date-time", "nullable": true }, "dueDateEnd": { "type": "string", "format": "date-time", "nullable": true }, "paymentDateStart": { "type": "string", "format": "date-time", "nullable": true }, "paymentDateEnd": { "type": "string", "format": "date-time", "nullable": true }, "pmsPaymentDateStart": { "type": "string", "format": "date-time", "nullable": true }, "pmsPaymentDateEnd": { "type": "string", "format": "date-time", "nullable": true }, "checkInDateStart": { "type": "string", "format": "date-time", "nullable": true }, "checkInDateEnd": { "type": "string", "format": "date-time", "nullable": true }, "checkOutDateStart": { "type": "string", "format": "date-time", "nullable": true }, "checkOutDateEnd": { "type": "string", "format": "date-time", "nullable": true }, "isVcc": { "type": "boolean" }, "companyName": { "type": "string", "nullable": true }, "pmsReferenceNo": { "type": "string", "nullable": true }, "daysLimit": { "type": "integer", "format": "int32", "nullable": true }, "ratePlanCode": { "type": "string", "nullable": true }, "pageNumber": { "type": "integer", "format": "int32", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "sortBy": { "type": "string", "nullable": true }, "sortDirection": { "type": "string", "nullable": true }, "searchTerm": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderReferenceNoPutLineItemModel": { "type": "object", "properties": { "itemRef": { "type": "string", "nullable": true }, "pmsLocator": { "type": "string", "nullable": true }, "crsLocator": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderReferenceNoPutModel": { "type": "object", "properties": { "transactionId": { "type": "string", "nullable": true }, "paymentDetails": { "$ref": "#/components/schemas/OrderReferenceNoPutPaymentDetailsItemModel" } }, "additionalProperties": false }, "OrderReferenceNoPutPaymentDetailsItemModel": { "type": "object", "properties": { "referenceNo": { "type": "string", "nullable": true }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReferenceNoPutLineItemModel" }, "nullable": true } }, "additionalProperties": false }, "OrderStatus": { "enum": [ "FuturePayment", "PartiallyPaid", "Paid", "PartiallyRefunded", "Refunded", "Cancelled", "CancelledWithPayments", "CancelledAndRefunded", "PendingPayment", "UserActionRequired", "LinkExpired", "VCCPayment", "Tokenized", "Disputed", "Voided" ], "type": "string" }, "OrderStatusDetail": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "OrderTravelerDetailsItemGetModel": { "type": "object", "properties": { "travelerName": { "type": "string", "nullable": true }, "travelerEmail": { "type": "string", "nullable": true }, "travelerAddress": { "type": "string", "nullable": true }, "travelerCity": { "type": "string", "nullable": true }, "travelerTitle": { "type": "string", "nullable": true }, "travelerPhone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentExchangeRateItemModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "currencyFrom": { "type": "string", "nullable": true }, "currencyTo": { "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "PaymentIntentAcceptedCardDetails": { "type": "object", "properties": { "brand": { "type": "array", "items": { "type": "string" }, "nullable": true }, "issuer": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tier": { "type": "array", "items": { "type": "string" }, "nullable": true }, "funding": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PaymentIntentDetailsRequest": { "required": [ "amount", "currency", "mode", "orderDate", "referenceNo" ], "type": "object", "properties": { "referenceNo": { "minLength": 1, "type": "string" }, "currency": { "minLength": 1, "type": "string" }, "country": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "currency" }, "orderDate": { "type": "string", "format": "date" }, "paymentDate": { "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 1000, "type": "string", "nullable": true }, "mode": { "$ref": "#/components/schemas/PaymentMode" }, "statementSuffix": { "type": "string", "nullable": true }, "imageLink": { "type": "string", "nullable": true }, "submitLabel": { "type": "string", "nullable": true }, "transactionTypeId": { "type": "string", "nullable": true }, "pmsPosting": { "type": "boolean" }, "paymentToken": { "type": "string", "nullable": true }, "promoCode": { "type": "string", "nullable": true }, "paymentLinkExpiryDate": { "type": "string", "format": "date-time", "nullable": true }, "presignedPaymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodType" }, "nullable": true }, "hotelDetails": { "$ref": "#/components/schemas/OrderHotelDetailsDto" }, "subscription": { "$ref": "#/components/schemas/PaymentIntentSubscription" }, "paymentSchedule": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntentPaymentSchedule" }, "nullable": true }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntentLineItemsRequest" }, "nullable": true }, "acceptedCardDetails": { "$ref": "#/components/schemas/PaymentIntentAcceptedCardDetails" }, "payNowIsShown": { "type": "boolean", "nullable": true }, "bookingSourceMappingId": { "type": "integer", "format": "int64", "nullable": true }, "sourceType": { "$ref": "#/components/schemas/BookingSourceType" } }, "additionalProperties": false }, "PaymentIntentLineItemsRequest": { "required": [ "amount", "currency", "itemRef", "productCode" ], "type": "object", "properties": { "itemRef": { "minLength": 1, "type": "string" }, "currency": { "minLength": 1, "type": "string" }, "amount": { "type": "number", "format": "currency" }, "description": { "maxLength": 1000, "type": "string", "nullable": true }, "productCode": { "minLength": 1, "type": "string" }, "tax": { "type": "number", "format": "currency", "nullable": true }, "amountAfterTax": { "type": "number", "format": "currency", "nullable": true }, "pmsLocator": { "type": "string", "nullable": true }, "crsLocator": { "type": "string", "nullable": true }, "mealType": { "type": "string", "nullable": true }, "roomType": { "type": "string", "nullable": true }, "ratePlanCode": { "type": "string", "nullable": true }, "transactionTypeId": { "type": "integer", "format": "int32" }, "checkInDate": { "type": "string", "format": "date-time", "nullable": true }, "checkOutDate": { "type": "string", "format": "date-time", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "paymentSchedule": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntentPaymentSchedule" }, "nullable": true } }, "additionalProperties": false }, "PaymentIntentPayerDetailsRequest": { "required": [ "payerCountry", "payerEmail", "payerName" ], "type": "object", "properties": { "payerTitle": { "type": "string", "nullable": true }, "payerName": { "minLength": 1, "type": "string" }, "payerEmail": { "minLength": 1, "type": "string" }, "payerAddress": { "type": "string", "nullable": true }, "payerCity": { "type": "string", "nullable": true }, "payerCountry": { "minLength": 1, "type": "string" }, "payerPostCode": { "type": "string", "nullable": true }, "payerPhone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentIntentPaymentSchedule": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "PaymentIntentRequestDto": { "required": [ "transactionId" ], "type": "object", "properties": { "transactionId": { "minLength": 1, "type": "string" }, "payerDetails": { "$ref": "#/components/schemas/PaymentIntentPayerDetailsRequest" }, "travelerDetails": { "$ref": "#/components/schemas/PaymentIntentTravelerDetailsRequest" }, "paymentDetails": { "$ref": "#/components/schemas/PaymentIntentDetailsRequest" }, "language": { "type": "string", "nullable": true }, "returnUrlSuccess": { "type": "string", "nullable": true }, "returnUrlCancel": { "type": "string", "nullable": true }, "webhookUrl": { "type": "string", "nullable": true }, "emailRequired": { "type": "boolean", "nullable": true }, "version": { "$ref": "#/components/schemas/PaymentLinkVersion" } }, "additionalProperties": false }, "PaymentIntentResponseDto": { "type": "object", "properties": { "encryptedPubKey": { "type": "string", "nullable": true }, "paymentLinkKey": { "type": "string", "nullable": true }, "paymentLink": { "type": "string", "nullable": true }, "returnUrlSuccess": { "type": "string", "nullable": true }, "returnUrlCancel": { "type": "string", "nullable": true }, "paymentLinkExpiryDate": { "type": "string", "format": "date-time" }, "paymentIntentId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "PaymentIntentSubscription": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/SubscriptionType" }, "to": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PaymentIntentTravelerDetailsRequest": { "type": "object", "properties": { "travelerName": { "type": "string", "nullable": true }, "travelerEmail": { "type": "string", "nullable": true }, "travelerAddress": { "type": "string", "nullable": true }, "travelerCity": { "type": "string", "nullable": true }, "travelerTitle": { "type": "string", "nullable": true }, "travelerPhone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentIntentType": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "PaymentItemModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "externalId": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true }, "paymentMethodId": { "type": "integer", "format": "int64" }, "customerId": { "type": "integer", "format": "int64" }, "customerEmail": { "type": "string", "nullable": true }, "merchantId": { "type": "integer", "format": "int32" }, "currencyIso": { "type": "string", "nullable": true }, "countryIso": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "orderId": { "type": "integer", "format": "int64" }, "status": { "$ref": "#/components/schemas/PaymentStatus" }, "createdAt": { "type": "string", "format": "date-time" }, "paymentDate": { "type": "string", "format": "date-time" }, "ip": { "type": "string", "nullable": true }, "referenceNo": { "type": "string", "nullable": true }, "paymentProcessedDate": { "type": "string", "format": "date-time" }, "merchantName": { "type": "string", "nullable": true }, "customerName": { "type": "string", "nullable": true }, "order": { "$ref": "#/components/schemas/PaymentOrderItemModel" }, "exchangeRate": { "$ref": "#/components/schemas/PaymentExchangeRateItemModel" } }, "additionalProperties": false }, "PaymentLinkVersion": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "PaymentListModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentItemModel" }, "nullable": true } }, "additionalProperties": false }, "PaymentListModelProceedPaymentErrorsResultModel": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/PaymentListModel" }, "errors": { "type": "object", "properties": { "CUSTOM": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "MERCHANT_SERVICE_UNAVAILABLE": { "type": "array", "items": { "type": "string" } }, "PUB_KEY_EXPIRED": { "type": "array", "items": { "type": "string" } }, "PUB_KEY_INVALID": { "type": "array", "items": { "type": "string" } }, "INVALID_AMOUNT": { "type": "array", "items": { "type": "string" } }, "INVALID_PAYMENT_METHOD": { "type": "array", "items": { "type": "string" } }, "PAYMENT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "CUSTOMER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "TRANSACTION_ALREADY_EXISTS": { "type": "array", "items": { "type": "string" } }, "CARD_COUNTRY_DOEST_NOT_MATCH": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_DONE": { "type": "array", "items": { "type": "string" } }, "CARD_DECLINED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_INTENT_PROVIDER_ERROR": { "type": "array", "items": { "type": "string" } }, "CARD_BRAND_IS_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_SUPPORTED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_LINK_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "CARD_DOES_NOT_MATCH_THE_ACCEPTED_CARD_DETAILS": { "type": "array", "items": { "type": "string" } }, "INVALID_CARD_EXPIRATION_DATE": { "type": "array", "items": { "type": "string" } }, "INVALID_CARD_FOR_PROMOTION": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_DISPUTED": { "type": "array", "items": { "type": "string" } }, "AUTH_CANCEL_FAILED": { "type": "array", "items": { "type": "string" } }, "CAPTURE_FAILED": { "type": "array", "items": { "type": "string" } }, "PARTIAL_AUTH_FAILED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_BOOKING_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "PAYMENT_BOOKING_ERROR": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_CANCELED": { "type": "array", "items": { "type": "string" } }, "AUTHENTICATION_INITIATED_FAILED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "nullable": true }, "hasErrors": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaymentMethodType": { "enum": [ "Card", "EvyPay", "AliPay", "WeChatPay", "Giropay", "GooglePay", "ApplePay", "Tamara", "Przelewy24", "Ideal", "Sofort", "Bancontact", "Multibanco", "Eps", "AliPayCN", "PostFinance", "Paypal" ], "type": "string" }, "PaymentMode": { "enum": [ "Payment", "PayLater", "Token", "Terminal", "Authorize" ], "type": "string" }, "PaymentOrderItemModel": { "type": "object", "properties": { "publicId": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true }, "referenceNo": { "type": "string", "nullable": true }, "currencyIso": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "orderDate": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "serviceDate": { "type": "string", "format": "date-time", "nullable": true }, "paymentDate": { "type": "string", "format": "date-time", "nullable": true }, "cancelDate": { "type": "string", "format": "date-time", "nullable": true }, "mode": { "$ref": "#/components/schemas/PaymentMode" }, "statementSuffix": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "PaymentPayInList": { "type": "object", "properties": { "currencyToPayIn": { "type": "string", "nullable": true }, "country": { "$ref": "#/components/schemas/CountryDTO" }, "currencyList": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyDTO" }, "nullable": true }, "warningMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentProviderType": { "enum": [ "Stripe", "CitiBank", "Checkout", "EvyPay", "Mpgs", "PayGate" ], "type": "string" }, "PaymentStatus": { "enum": [ "RequiresPaymentMethod", "RequiresConfirmation", "RequiresAction", "Processing", "RequiresCapture", "Canceled", "Succeeded", "Scheduled", "PartialRefund", "Refund", "DisputedNeedsResponse", "DisputedUnderReview", "DisputedChargeRefunded", "DisputedWon", "DisputedLost", "DisputedCanceled", "DisputedExpired", "DisputedWarningClosed", "DisputedAccepted", "DisputedArbitrationSentToScheme", "DisputedEvidenceAcknowledgedByScheme", "DisputedEvidenceSubmitted", "DisputedResolved", "Voided", "DisputedEvidenceRequired", "DisputedArbitrationEvidenceSubmitted", "DisputedArbitrationWon", "DisputedArbitrationLost" ], "type": "string" }, "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": { } }, "ProceedPaymentCardItemRequestDto": { "required": [ "cardNumber", "expirationMonth", "expirationYear" ], "type": "object", "properties": { "cardNumber": { "minLength": 1, "type": "string" }, "cardHolderName": { "type": "string", "nullable": true }, "cvc": { "type": "string", "nullable": true }, "expirationMonth": { "type": "integer", "format": "int32" }, "expirationYear": { "type": "integer", "format": "int32" }, "brand": { "type": "string", "nullable": true }, "countryIso": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProceedPaymentErrorsErrorResult": { "type": "object", "properties": { "errors": { "type": "object", "properties": { "CUSTOM": { "type": "array", "items": { "type": "string" } }, "MERCHANT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "MERCHANT_SERVICE_UNAVAILABLE": { "type": "array", "items": { "type": "string" } }, "PUB_KEY_EXPIRED": { "type": "array", "items": { "type": "string" } }, "PUB_KEY_INVALID": { "type": "array", "items": { "type": "string" } }, "INVALID_AMOUNT": { "type": "array", "items": { "type": "string" } }, "INVALID_PAYMENT_METHOD": { "type": "array", "items": { "type": "string" } }, "PAYMENT_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "CUSTOMER_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "TRANSACTION_ALREADY_EXISTS": { "type": "array", "items": { "type": "string" } }, "CARD_COUNTRY_DOEST_NOT_MATCH": { "type": "array", "items": { "type": "string" } }, "AUTH_HEADER_IS_MISSING": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_DONE": { "type": "array", "items": { "type": "string" } }, "CARD_DECLINED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_INTENT_PROVIDER_ERROR": { "type": "array", "items": { "type": "string" } }, "CARD_BRAND_IS_NOT_ALLOWED": { "type": "array", "items": { "type": "string" } }, "CURRENCY_NOT_SUPPORTED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_LINK_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "CARD_DOES_NOT_MATCH_THE_ACCEPTED_CARD_DETAILS": { "type": "array", "items": { "type": "string" } }, "INVALID_CARD_EXPIRATION_DATE": { "type": "array", "items": { "type": "string" } }, "INVALID_CARD_FOR_PROMOTION": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_DISPUTED": { "type": "array", "items": { "type": "string" } }, "AUTH_CANCEL_FAILED": { "type": "array", "items": { "type": "string" } }, "CAPTURE_FAILED": { "type": "array", "items": { "type": "string" } }, "PARTIAL_AUTH_FAILED": { "type": "array", "items": { "type": "string" } }, "PAYMENT_BOOKING_NOT_FOUND": { "type": "array", "items": { "type": "string" } }, "PAYMENT_BOOKING_ERROR": { "type": "array", "items": { "type": "string" } }, "PAYMENT_ALREADY_CANCELED": { "type": "array", "items": { "type": "string" } }, "AUTHENTICATION_INITIATED_FAILED": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "nullable": true }, "hasErrors": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProceedPaymentRequestDto": { "required": [ "pubKey" ], "type": "object", "properties": { "pubKey": { "minLength": 1, "type": "string" }, "paymentMethodId": { "type": "string", "nullable": true }, "paymentMethodType": { "$ref": "#/components/schemas/PaymentMethodType" }, "currency": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "saveCard": { "type": "boolean" }, "zip": { "type": "string", "nullable": true }, "card": { "$ref": "#/components/schemas/ProceedPaymentCardItemRequestDto" }, "paymentSchedule": { "type": "array", "items": { "$ref": "#/components/schemas/ProceedPaymentScheduledPaymentDto" }, "nullable": true }, "isFullOrderAmountPaid": { "type": "boolean" }, "brand": { "type": "string", "nullable": true }, "cardDesciption": { "type": "string", "nullable": true }, "forceAuth": { "type": "boolean", "nullable": true }, "paymentProviderType": { "$ref": "#/components/schemas/PaymentProviderType" }, "useZeroAmount": { "type": "boolean", "nullable": true }, "recurringPayment": { "type": "boolean", "nullable": true }, "tokenData": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProceedPaymentResponseDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/PaymentStatus" }, "paymentType": { "$ref": "#/components/schemas/PaymentIntentType" }, "clientSecret": { "type": "string", "nullable": true }, "paymentMethodExternalId": { "type": "string", "nullable": true }, "accountPublicKey": { "type": "string", "nullable": true }, "accountId": { "type": "string", "nullable": true }, "confirmation3dsDevelopmentLink": { "type": "string", "nullable": true }, "metadata3ds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProceedPaymentScheduledPaymentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "currencyToPay": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RefundCreateModel": { "type": "object", "properties": { "transactionId": { "type": "string", "nullable": true }, "paymentIntentId": { "type": "integer", "format": "int32", "nullable": true }, "amount": { "type": "number", "format": "double" }, "scheduledPaymentId": { "type": "integer", "format": "int64", "nullable": true }, "orderItemId": { "type": "integer", "format": "int64", "nullable": true }, "paymentProvider": { "$ref": "#/components/schemas/PaymentProviderType" }, "saveOldInternalDetails": { "type": "boolean" } }, "additionalProperties": false }, "RefundItemModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "externalId": { "type": "string", "nullable": true }, "paymentIntentId": { "type": "integer", "format": "int64" }, "orderId": { "type": "integer", "format": "int64" }, "status": { "$ref": "#/components/schemas/RefundStatus" }, "created": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "requestedAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "RefundListModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RefundItemModel" }, "nullable": true }, "total": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "RefundStatus": { "enum": [ "Pending", "Succeeded", "Failed", "Canceled" ], "type": "string" }, "ScheduledPaymentItemGetModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "label": { "type": "string", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" }, "amountInOrderCurrency": { "type": "number", "format": "double", "nullable": true }, "currencyToPay": { "type": "string", "nullable": true }, "amountInCurrencyToPay": { "type": "number", "format": "double", "nullable": true }, "exchangeRate": { "type": "number", "format": "double", "nullable": true }, "status": { "$ref": "#/components/schemas/ScheduledPaymentStatus" }, "orderItemId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ScheduledPaymentItemModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "label": { "type": "string", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" }, "amountInOrderCurrency": { "type": "number", "format": "double", "nullable": true }, "currencyToPay": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/ScheduledPaymentStatus" } }, "additionalProperties": false }, "ScheduledPaymentStatus": { "enum": [ "Pending", "Paid", "Failed", "Cancelled", "Refunded" ], "type": "string" }, "SendPaymentEmailDto": { "type": "object", "properties": { "merchantId": { "type": "integer", "format": "int64" }, "paymentIntentId": { "type": "integer", "format": "int64" }, "transactionId": { "type": "string", "nullable": true }, "emailType": { "$ref": "#/components/schemas/EmailTemplateType" } }, "additionalProperties": false }, "SendWhatsappPaymentLinkRequest": { "required": [ "merchantId", "paymentIntentId" ], "type": "object", "properties": { "merchantId": { "type": "integer", "format": "int64" }, "paymentIntentId": { "type": "integer", "format": "int64" }, "template": { "$ref": "#/components/schemas/MessageBoxTemplateType" } }, "additionalProperties": false }, "SubscriptionType": { "enum": [ "Monthly", "Yearly" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Bearer token for portal and admin access.", "scheme": "bearer", "bearerFormat": "JWT" }, "ApiKey": { "type": "apiKey", "description": "Merchant API key. Use pubKey only for public access, or pubKey:secretKey for merchant access.", "name": "X-ApiKey", "in": "header" } } } }