{ "openapi": "3.0.3", "info": { "title": "ARISE Platform - API Reference Guide", "version": "v1.0.0", "description": "Last updated: 4.28.2026 4:19 PM\n", "x-logo": { "url": "https://api.redocly.com/registry/assets/aurora-payments---arise-gateway/sample/v1/logo-horizontal.svg" } }, "servers": [ { "url": "https://api.uat.arise.risewithaurora.com", "description": "Sandbox environment" }, { "url": "https://api.arise.risewithaurora.com", "description": "Production environment" } ], "security": [ { "Bearer": [] } ], "tags": [ { "name": "Getting Started", "description": "The following is an overview for using the Aurora API suite and making endpoint calls.\nGetting started has the following steps:\n* Creating an Aurora Payments Account\n* Creating an API Key\n* Developing in the Sandbox Environment\n* Going Live\n\n# Creating an Aurora Payments Account\n

\n Before using the Aurora API suite, you must have an account created for you.\n If you are new to Aurora or are interested in using the Aurora Payments API suite, contact the appropriate team below:\n\n* ISVs (independent software vendors): isvsales@risewithaurora.com\n* Individual Merchant Integrators: insidedevsales@risewithaurora.com\n\nThe appropriate sales team will create your user account and help customize access based on your integration requirements.\nYou will be assigned an account name.\nThis will be a registered account on the Aurora Merchant Portal [Sandbox](https://uat.arise.risewithaurora.com).\nUpon first login, you will create your account password.\n\nIf you are already a registered merchant and have technical or operational questions, contact the Aurora Integrations Support Team: isvsupport@risewithaurora.com\n\n# Creating an API Key\n

\nAfter registering an Aurora account, an API key is required.\n\nAn API key is a pair of credentials, the client Id and the client secret, that together uniquely identifies and authenticates a specific account.\nThe API key is important in that it is needed to create an API token.\nAn API token is required to use each Aurora API endpoint.\n\nEach merchant account requires at least one active and valid API key.
\nTo create an API key, see [Creating an API Key](https://developer.dev.arise.risewithaurora.com/docs/getting-started/api-authentication).\n\nAPI keys may also be explicitly deleted as needed.\nThis deletion may be part of a periodic key rotation, as your security procedures require.\nWe recommended deleting an API key if you suspect that the client secret is compromised.\nIn either case, a new API key can be created.
\nTo delete an API key, see [Deleting an API Key](https://developer.dev.arise.risewithaurora.com/docs/getting-started/api-authentication).\n\n# Developing in the Sandbox Environment\nYou will work with your Aurora support team developing workflows and tools.\nThis will be in the sandbox account for development and testing.\nThe sandbox account is a fully isolated account that mirrors production behavior.\nIt does not process real transactions.\nIt is used to validate your integration before going live.\n\n# Going Live\nWhen your product is ready to be deployed live, the Aurora support team will work with you to ensure compliance.\nThis compliance follows the production readiness checklist.\nIt ensures the best and optimal developer, client, and customer experience.\n\nFor more information and details about the production readiness checklist, see [Production Go-Live Guide](https://developer.dev.arise.risewithaurora.com/docs/launch/go-live)." }, { "name": "Merchant API Keys", "description": "The partner has the capability to manage API keys for their merchants.\nThis includes creating and deleting API keys.\n\nThis is the same managing capability as through the partner panel.\nThe partner can manage the API keys for their individual merchants.\nAPI keys are not interchangeable from among different merchants, even if they are each associated with the same partner.\nMerchants cannot use API keys from any other merchant.\nStandalone merchants, those merchants not having associated partners, manage their API keys directly.\n\nAn API key is required only if application or account needs to integrate with the API suite.\nThe number of API keys is determined by the partner or standalone merchants.\nFor more information about API keys, see Creating an API Key.\n\nThe importance of API keys is that they are used to create API tokens, needed to make endpoint calls.\nTo generate an API token, see Generating an API Token.\n\nThis API group is a collection of endpoints used to manage API keys.\nIt can be used for the following:\n* To list available keys, see `GET /pay-api/v1/merchants/tokens`\n* To create an API key, see `POST /pay-api/v1/merchants/tokens`\n* To delete and API key, see `DELETE /pay-api/v1/merchants/tokens/{{clientId}}`\n" }, { "name": "API Suite Fundamentals", "description": "The following sections are general information required for using the Aurora API suite.\n\n# BaseURL Environments\nAurora provides different environments to run endpoints\n\n\n**Sandbox**
\nThe sandbox environment is for development and testing.\nNo payments, charges, or invoices will be enforced.\nIt is a fully isolated account that mirrors production behavior.\n\nIt is used to validate your integration before going live.\nYou will work with your Aurora support team developing workflows and tools.\n\nbaseURL: `https://api.uat.arise.risewithaurora.com`\n\n**Production**
\nUse the production environment for deploying the payment system live to clients.\nAll payments, charges, or invoices will be enforced.\n\nWhen your product is ready to be deployed live, the Aurora support team will work with you to ensure compliance.\nThis compliance follows the production readiness checklist.\nIt ensures the best and optimal developer, client, and customer experience.\n\nFor more information and details about the production readiness checklist, see [Production Go-Live Guide](https://developer.dev.arise.risewithaurora.com/docs/launch/go-live).\n\nbaseURL: `https://api.arise.risewithaurora.com`\n\n**Using the baseURL**
\nUse the baseURL instead of the placeholder noted in each endpoint.\nFor example, an endpoint may be described as in the endpoint documentation as:
\n`POST {{baseURL}}/pay-api/v1/customers`\n\nTo make this call in the sandbox environment, use:
\n`POST https://api.uat.arise.risewithaurora.com/pay-api/v1/customers`\n\nTo make this call in the production environment, use:
\n`POST https://api.arise.risewithaurora.com/pay-api/v1/customers`\n\n# Generating an API Token\n

\nAn API token is required for each endpoint use.\nAn API token can only be created after an account is created, registered, and at least one API key has been created.\n\nThe API token is an authorization token needed for each for endpoint.\nIt is an encrypted string that combines the client Id and client secret from an API key (created earlier).\nIt contains authentication and authorization coding.\nThis includes any privileges the user or account affords.\nBeing encrypted means the API token is safe to expose in frontend code.\nThe API token is time-sensitive and expires after an amount of time.\n\nIt may be created as needed.\nWe recommend generating a new API token before each endpoint use.\nThis ensures the API token will be valid for each call.\n\nThe API token is an OAuth 2.0 Client Credentials authorization flow.\nThe Client Credentials Flow is an OAuth 2.0 authorization Bearer grant.\nThis means a server-side application obtains an access token using its client credentials (client ID and client secret) to protect resources.\n\n

Generating the API Token

\nAn API token is created for the environment it will be used in.\nThere are two available Aurora environments.\n\n**Production**
\nUse the production environment for deploying the payment system live to clients.\nAll payments, charges, or invoices will be enforced.
\nEndpoint: `POST https://oauth.arise.risewithaurora.com/oauth2/token`\n\n**Sandbox**
\nUse the sandbox environment for development and testing.\nNo payments, charges, or invoices will be enforced.
\nEndpoint: `POST https://oauth.uat.arise.risewithaurora.com/oauth2/token`\n\nThe sandbox and production environments API tokens use the same API key and differentiated only by the environment endpoint.\nThe two API tokens types are not interchangeable and cannot be used in an environment different than they were created for.\n\nThe API key that was created in the initial account registration is needed to create an API token.\nThe **client ID** and **client secret** are used together to create an API token.\n\nIn the `POST` request, include the following as the request body:\n\n| Parameter Name | Example | Notes |\n|----------------|-----------------------------|-----------------------------------------------------|\n| grant_type | `client_credentials` | It must be this literal value. |\n| scope | `offline_access` | It must be this literal value. |\n| client_id | 594838709594...38697242c | The client ID from the API key for the account. |\n| client_secret | 9eb2c6859daa4...d8ae5da02a9 | The client secret from the API key for the account. |\n\nThe following is an example of the complete request for the sandbox environment:\n ```bash\n curl -X POST 'https://oauth.uat.arise.risewithaurora.com/oauth2/token' \\\n -u '594838709594...38697242c:9eb2c6859daa4...d8ae5da9' \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'grant_type=client_credentials&scope=offline_access'\n ```\n\nThe following example is passed back in the response body:\n ```json\n {\n \"access_token\": \"u7BYwJx26U1lT...TZpKvndLCC4\",\n \"refresh_token\": \"def50200newrefresh123456789\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n }\n ```\n\nThe response body:\n\n| Field Name | Description |\n|----------------|------------------------------------------------------------------------------------------------------------------|\n| access_token | The JWT (JSON web token) access token to include as the API request Authorization header field of each endpoint. |\n| refresh_token | The JWT (JSON web token) refresh access token. |\n| token_type | Always `Bearer`. |\n| expires_in | The `access_token`'s lifetime in seconds.

For example, 900 (seconds) is 15 minutes. |\n\n

Using the Access Token

\n\nThe token endpoint returns both an `access_token` and a `refresh_token`.\nThe lifespan of the `access_token` is indicated by the `expires_in` value.\nThe lifespan of the `refresh_token` is set by OAuth standards.\n\nClients are encouraged to use either token as needed.\nFor example, it may be easier to call for a new `access_token` before each user-initiated action.\nThe `access_token` may also be left to expire, and then use `refresh_token` procedures to continue.\nAlternatively, mobile phones apps may need to use the `refresh_token` to avoid consistently signing back in. \n\nIn the endpoint header, use the following `access_token` format:\n```html\n\"Authorization\": \"Bearer: u7BYwJx26U1lT...TZpKvndLCC4\"\n```\n\nThe following example creates a new access token:\n ```bash\n curl 'https://api.uat.arise.risewithaurora.com/pay-api/v1/transactions' \\\n -H 'Authorization: Bearer u7BYwJx26U1lT...TZpKvndLCC44' \\\n -H 'Accept: application/json'\n ```\nAs a reminder, always secure your client ID and especially your client secret.\nNever expose the client secret in client-side code or public repositories.\nIt should be kept private and secure.\nIf it is suspected that the client secret has been compromised, the owning API key must be deleted.\nA new API key can then be created\n\n

Error Responses

\n\nIf authentication fails, the token endpoint returns an error.\nThe following are commonly encountered errors.\n\n| HTTP Status | Common Cause |\n|------------------|---------------------------------------------------------------------------|\n| 400 Bad Request | Missing or invalid grant_type, or malformed request body. |\n| 401 Unauthorized | The API token has likely expired. Create a new one and retry the request. |\n\n# Payment Flow\n

\n The following is a generalized workflow.\n\n### Approving a Purchase Request\n1) The customer completes their shopping experience on the merchant's website by selecting the products or services.\n They navigate to the checkout page on the merchant's website.\n1) They enter their personal and payment information. This could include card details, or net banking information.\n1) The merchant's website captures these details, formatting the details as needed to conform to Aurora payment gateway requirements.\n1) This sensitive data is transmitted by a secure connection (HTTPS) to the Aurora payment gateway.\n The Aurora payment gateway is a service that makes authorization and sale by cards or ACH (automated clearing house, an electronic network used by financial institutions to process direct deposits).\n1) Upon receiving this information, the Aurora payment gateway further routes this payment data to the processing center, such as TSYS.\n1) This entity communicates with the customer's bank to get authorization or denial for the payment.\n The processing center determines if the payment is approved, that is, if there are sufficient funds or credit available in the customer's account.\n\n### Acknowledging a Purchase Request\n1) After the transaction is processed, the processing center sends back a response to the Aurora payment gateway.\n This response includes details of the transaction, such as whether it was approved or declined.\n1) The Aurora payment gateway relays this information back to the merchant's website.\n1) The merchant's website receives this information and displays a message or signal for the customer.\n Depending on whether the transaction was approved or declined, the appropriate message is displayed to the customer.\n For instance:
\n If transaction was successful, a confirmation message is shown, usually with a transaction ID and other details.
\n If it was declined, the customer is informed and typically asked to try another payment method.\n\n# Supported Card Types\n

\n The following credit cards and formats are supported.\n\n- Diners Club: Card numbers are typically 14 or 16 digits long.\n- Discover: Card numbers are typically 16 digits long.\n- JCB: Card numbers are typically 16 digits long.\n- MasterCard: Card numbers are typically 16 digits long.\n- VISA: Card numbers are typically 13 or 16 digits long.\n\n# Aurora-Defined Enums\n

\n The following are Aurora-defined enumerations and indices used in endpoint fields.\n\n
\nAccount Holder Types\n\n| id | name |\n|----|----------|\n| 1 | Business |\n| 2 | Personal |\n
\n\n
\nAccount Types\n\n| id | name |\n|----|----------|\n| 1 | Checking |\n| 2 | Savings |\n
\n\n
\nAffiliate Statuses\n\n| id | name |\n|----|-----------|\n| 1 | Active |\n| 2 | Suspended |\n
\n\n
\nAffiliate Business Model Types\n\n| id | name |\n|----|----------------------|\n| 1 | SingleAffiliateModel |\n| 2 | SubAffiliateModel |\n
\n\n
\nBusiness Categories\n\n| id | name |\n|----|------------------------------|\n| 1 | WebDeveloper |\n| 2 | IndependentSoftwareVendor |\n| 3 | IndependentSalesOrganization |\n
\n\n
\nCard Types\n\n\n| id | name |\n|----|-----------------|\n| 1 | Visa |\n| 2 | MasterCard |\n| 3 | AmericanExpress |\n| 4 | DinersClub |\n| 5 | Discover |\n| 6 | JCB |\n
\n\n
\nCountries\n\n\n| id | isoCode | name |\n|-----|---------|------------------------------------------------------|\n| 1 | US | United States |\n| 2 | CA | Canada |\n| 3 | PR | Puerto Rico |\n| 4 | AF | Afghanistan |\n| 5 | AX | Åland Islands |\n| 6 | AL | Albania |\n| 7 | DZ | Algeria |\n| 8 | AS | American Samoa |\n| 9 | AD | Andorra |\n| 10 | AO | Angola |\n| 11 | AI | Anguilla |\n| 12 | AQ | Antarctica |\n| 13 | AG | Antigua and Barbuda |\n| 14 | AR | Argentina |\n| 15 | AM | Armenia |\n| 16 | AW | Aruba |\n| 17 | AU | Australia |\n| 18 | AT | Austria |\n| 19 | AZ | Azerbaijan |\n| 20 | BS | Bahamas |\n| 21 | BH | Bahrain |\n| 22 | BD | Bangladesh |\n| 23 | BB | Barbados |\n| 24 | BY | Belarus |\n| 25 | BE | Belgium |\n| 26 | BZ | Belize |\n| 27 | BJ | Benin |\n| 28 | BM | Bermuda |\n| 29 | BT | Bhutan |\n| 30 | BO | Bolivia (Plurinational State of) |\n| 31 | BQ | Bonaire, Sint Eustatius and Saba |\n| 32 | BA | Bosnia and Herzegovina |\n| 33 | BW | Botswana |\n| 34 | BV | Bouvet Island |\n| 35 | BR | Brazil |\n| 36 | IO | British Indian Ocean Territory |\n| 37 | UM | United States Minor Outlying Islands |\n| 38 | VG | Virgin Islands (British) |\n| 39 | VI | Virgin Islands (U.S.) |\n| 40 | BN | Brunei Darussalam |\n| 41 | BG | Bulgaria |\n| 42 | BF | Burkina Faso |\n| 43 | BI | Burundi |\n| 44 | KH | Cambodia |\n| 45 | CM | Cameroon |\n| 46 | CV | Cabo Verde |\n| 47 | KY | Cayman Islands |\n| 48 | CF | Central African Republic |\n| 49 | TD | Chad |\n| 50 | CL | Chile |\n| 51 | CN | China |\n| 52 | CX | Christmas Island |\n| 53 | CC | Cocos (Keeling) Islands |\n| 54 | CO | Colombia |\n| 55 | KM | Comoros |\n| 56 | CG | Congo |\n| 57 | CD | Congo (Democratic Republic of the) |\n| 58 | CK | Cook Islands |\n| 59 | CR | Costa Rica |\n| 60 | HR | Croatia |\n| 61 | CU | Cuba |\n| 62 | CW | Curaçao |\n| 63 | CY | Cyprus |\n| 64 | CZ | Czech Republic |\n| 65 | DK | Denmark |\n| 66 | DJ | Djibouti |\n| 67 | DM | Dominica |\n| 68 | DO | Dominican Republic |\n| 69 | EC | Ecuador |\n| 70 | EG | Egypt |\n| 71 | SV | El Salvador |\n| 72 | GQ | Equatorial Guinea |\n| 73 | ER | Eritrea |\n| 74 | EE | Estonia |\n| 75 | ET | Ethiopia |\n| 76 | FK | Falkland Islands (Malvinas) |\n| 77 | FO | Faroe Islands |\n| 78 | FJ | Fiji |\n| 79 | FI | Finland |\n| 80 | FR | France |\n| 81 | GF | French Guiana |\n| 82 | PF | French Polynesia |\n| 83 | TF | French Southern Territories |\n| 84 | GA | Gabon |\n| 85 | GM | Gambia |\n| 86 | GE | Georgia |\n| 87 | DE | Germany |\n| 88 | GH | Ghana |\n| 89 | GI | Gibraltar |\n| 90 | GR | Greece |\n| 91 | GL | Greenland |\n| 92 | GD | Grenada |\n| 93 | GP | Guadeloupe |\n| 94 | GU | Guam |\n| 95 | GT | Guatemala |\n| 96 | GG | Guernsey |\n| 97 | GN | Guinea |\n| 98 | GW | Guinea-Bissau |\n| 99 | GY | Guyana |\n| 100 | HT | Haiti |\n| 101 | HM | Heard Island and McDonald Islands |\n| 102 | VA | Holy See |\n| 103 | HN | Honduras |\n| 104 | HK | Hong Kong |\n| 105 | HU | Hungary |\n| 106 | IS | Iceland |\n| 107 | IN | India |\n| 108 | ID | Indonesia |\n| 109 | CI | Côte d'Ivoire |\n| 110 | IR | Iran (Islamic Republic of) |\n| 111 | IQ | Iraq |\n| 112 | IE | Ireland |\n| 113 | IM | Isle of Man |\n| 114 | IL | Israel |\n| 115 | IT | Italy |\n| 116 | JM | Jamaica |\n| 117 | JP | Japan |\n| 118 | JE | Jersey |\n| 119 | JO | Jordan |\n| 120 | KZ | Kazakhstan |\n| 121 | KE | Kenya |\n| 122 | KI | Kiribati |\n| 123 | KW | Kuwait |\n| 124 | KG | Kyrgyzstan |\n| 125 | LA | Lao People's Democratic Republic |\n| 126 | LV | Latvia |\n| 127 | LB | Lebanon |\n| 128 | LS | Lesotho |\n| 129 | LR | Liberia |\n| 130 | LY | Libya |\n| 131 | LI | Liechtenstein |\n| 132 | LT | Lithuania |\n| 133 | LU | Luxembourg |\n| 134 | MO | Macao |\n| 135 | MK | Macedonia (the former Yugoslav Republic of) |\n| 136 | MG | Madagascar |\n| 137 | MW | Malawi |\n| 138 | MY | Malaysia |\n| 139 | MV | Maldives |\n| 140 | ML | Mali |\n| 141 | MT | Malta |\n| 142 | MH | Marshall Islands |\n| 143 | MQ | Martinique |\n| 144 | MR | Mauritania |\n| 145 | MU | Mauritius |\n| 146 | YT | Mayotte |\n| 147 | MX | Mexico |\n| 148 | FM | Micronesia (Federated States of) |\n| 149 | MD | Moldova (Republic of) |\n| 150 | MC | Monaco |\n| 151 | MN | Mongolia |\n| 152 | ME | Montenegro |\n| 153 | MS | Montserrat |\n| 154 | MA | Morocco |\n| 155 | MZ | Mozambique |\n| 156 | MM | Myanmar |\n| 157 | NA | Namibia |\n| 158 | NR | Nauru |\n| 159 | NP | Nepal |\n| 160 | NL | Netherlands |\n| 161 | NC | New Caledonia |\n| 162 | NZ | New Zealand |\n| 163 | NI | Nicaragua |\n| 164 | NE | Niger |\n| 165 | NG | Nigeria |\n| 166 | NU | Niue |\n| 167 | NF | Norfolk Island |\n| 168 | KP | Korea (Democratic People's Republic of) |\n| 169 | MP | Northern Mariana Islands |\n| 170 | NO | Norway |\n| 171 | OM | Oman |\n| 172 | PK | Pakistan |\n| 173 | PW | Palau |\n| 174 | PS | Palestine, State of |\n| 175 | PA | Panama |\n| 176 | PG | Papua New Guinea |\n| 177 | PY | Paraguay |\n| 178 | PE | Peru |\n| 179 | PH | Philippines |\n| 180 | PN | Pitcairn |\n| 181 | PL | Poland |\n| 182 | PT | Portugal |\n| 183 | QA | Qatar |\n| 184 | XK | Republic of Kosovo |\n| 185 | RE | Réunion |\n| 186 | RO | Romania |\n| 187 | RU | Russian Federation |\n| 188 | RW | Rwanda |\n| 189 | BL | Saint Barthélemy |\n| 190 | SH | Saint Helena, Ascension and Tristan da Cunha |\n| 191 | KN | Saint Kitts and Nevis |\n| 192 | LC | Saint Lucia |\n| 193 | MF | Saint Martin (French part) |\n| 194 | PM | Saint Pierre and Miquelon |\n| 195 | VC | Saint Vincent and the Grenadines |\n| 196 | WS | Samoa |\n| 197 | SM | San Marino |\n| 198 | ST | Sao Tome and Principe |\n| 199 | SA | Saudi Arabia |\n| 200 | SN | Senegal |\n| 201 | RS | Serbia |\n| 202 | SC | Seychelles |\n| 203 | SL | Sierra Leone |\n| 204 | SG | Singapore |\n| 205 | SX | Sint Maarten (Dutch part) |\n| 206 | SK | Slovakia |\n| 207 | SI | Slovenia |\n| 208 | SB | Solomon Islands |\n| 209 | SO | Somalia |\n| 210 | ZA | South Africa |\n| 211 | GS | South Georgia and the South Sandwich Islands |\n| 212 | KR | Korea (Republic of) |\n| 213 | SS | South Sudan |\n| 214 | ES | Spain |\n| 215 | LK | Sri Lanka |\n| 216 | SD | Sudan |\n| 217 | SR | Suriname |\n| 218 | SJ | Svalbard and Jan Mayen |\n| 219 | SZ | Swaziland |\n| 220 | SE | Sweden |\n| 221 | CH | Switzerland |\n| 222 | SY | Syrian Arab Republic |\n| 223 | TW | Taiwan |\n| 224 | TJ | Tajikistan |\n| 225 | TZ | Tanzania, United Republic of |\n| 226 | TH | Thailand |\n| 227 | TL | Timor-Leste |\n| 228 | TG | Togo |\n| 229 | TK | Tokelau |\n| 230 | TO | Tonga |\n| 231 | TT | Trinidad and Tobago |\n| 232 | TN | Tunisia |\n| 233 | TR | Turkey |\n| 234 | TM | Turkmenistan |\n| 235 | TC | Turks and Caicos Islands |\n| 236 | TV | Tuvalu |\n| 237 | UG | Uganda |\n| 238 | UA | Ukraine |\n| 239 | AE | United Arab Emirates |\n| 240 | GB | United Kingdom of Great Britain and Northern Ireland |\n| 241 | UY | Uruguay |\n| 242 | UZ | Uzbekistan |\n| 243 | VU | Vanuatu |\n| 244 | VE | Venezuela (Bolivarian Republic of) |\n| 245 | VN | Viet Nam |\n| 246 | WF | Wallis and Futuna |\n| 247 | EH | Western Sahara |\n| 248 | YE | Yemen |\n| 249 | ZM | Zambia |\n| 250 | ZW | Zimbabwe |\n
\n\n
\nTransaction Creator Types\n\n\n| id | name |\n|----|--------------|\n| 1 | Portal |\n| 2 | ApiToken |\n| 3 | Terminal |\n| 4 | Invoice |\n| 5 | QuickPayment |\n| 6 | WebComponent |\n| 7 | Subscription |\n| 8 | MobileApp |\n| 9 | TapToPay |\n
\n\n
\nMCC Codes\n\n\n| id | code | description |\n|-----|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1 | 5561 | Camper, Recreational and Utility Trailer Dealers |\n| 2 | 3658 | New Otani Hotels |\n| 3 | 3669 | Eldorado Hotel and Casino |\n| 4 | 3663 | Hoteles El Presidente |\n| 5 | 3660 | Knights Inn |\n| 6 | 3670 | Arcade Hotels |\n| 7 | 3667 | Luxor Hotel and Casino |\n| 8 | 3655 | Scandic Hotels |\n| 9 | 3657 | Oberoi Hotels |\n| 10 | 3662 | Circus Circus Hotel and Casino |\n| 11 | 3654 | Loews Hotels |\n| 12 | 3652 | Embassy Hotels |\n| 13 | 3664 | Flag Inns |\n| 14 | 3661 | Metropole Hotels |\n| 15 | 3651 | Imperial London Hotel |\n| 16 | 3653 | Penta Hotels |\n| 17 | 3666 | Stakis Hotels |\n| 18 | 3668 | Maritim Hotels |\n| 19 | 3665 | Hampton Inn Hotels |\n| 20 | 3656 | Sara Hotels |\n| 21 | 3659 | Taj Hotels International |\n| 22 | 8050 | Nursing and Personal Care Facilities |\n| 23 | 8031 | Osteopathic Physicians |\n| 24 | 8099 | Medical Services Health Practitioners - No Elsewhere Classified |\n| 25 | 8220 | Colleges, Universities, Professional Schools, and Junior Colleges |\n| 26 | 7999 | Recreation Services - Not Elsewhere Classified |\n| 27 | 8211 | Elementary and Secondary Schools |\n| 28 | 8062 | Hospitals |\n| 29 | 8041 | Chiropractors |\n| 30 | 8241 | Correspondence Schools |\n| 31 | 8049 | Podiatrists and Chiropodists |\n| 32 | 8021 | Dentists and Orthodontists |\n| 33 | 8011 | Doctors and Physicians - Not Elsewhere Classified |\n| 34 | 8043 | Opticians, Optical Goods and Eyeglasses |\n| 35 | 8071 | Medical and Dental Laboratories |\n| 36 | 7998 | Aquarium, Seaquarium, Dolphinariums |\n| 37 | 7997 | Membership Clubs (Sports, Recreation, Athletic), Country Clubs, and Private Golf Courses |\n| 38 | 8042 | Optometrists and Ophthalmologists |\n| 39 | 8111 | Legal Services and Attorneys |\n| 40 | 3161 | All Nippon Airways |\n| 41 | 3164 | Norontair |\n| 42 | 3171 | Canadian Airlines |\n| 43 | 3172 | Nation Air |\n| 44 | 3159 | PBA-Provincetwn-Bstn Air |\n| 45 | 3175 | Middle East Air |\n| 46 | 3174 | JetBlue Airways |\n| 47 | 3167 | Aero Continente - AEROCONTINENTE |\n| 48 | 3432 | Reserve Rent-a-Car |\n| 49 | 5099 | Durable Goods Not Elsewhere Classified (Business to Business MCC) |\n| 50 | 5085 | Industrial Supplies Not Elsewhere Classified (Business to Business MCC) |\n| 51 | 5139 | Commercial Footwear (Business to Business MCC) |\n| 52 | 5137 | Men's, Women's and Children's Uniforms (Business to Business MCC) |\n| 53 | 5193 | Florist Suppliers, Nursery Stock & Flowers (Business to Business MCC) |\n| 54 | 5122 | Drugs, Drug Proprietary's, and Druggists' Sundries |\n| 55 | 5051 | Metal Service Centers and Offices (Business to Business MCC) |\n| 56 | 5211 | Lumber & Building Materials Stores |\n| 57 | 5200 | Home Supply Warehouse |\n| 58 | 5111 | Stationery, Office Supplies, and Printing and Writing Paper |\n| 59 | 5172 | Petroleum and Products (Business to Business MCC) |\n| 60 | 5131 | Piece Goods, Notions and Other Dry Goods (Business to Business MCC) |\n| 61 | 5192 | Books, Periodicals and Newspapers (Business to Business MCC) |\n| 62 | 5271 | Mobile Home Dealer |\n| 63 | 5169 | Chemicals and Allied Products Not Elsewhere Classified (Business to Business MCC) |\n| 64 | 5065 | Electrical Parts and Equipment (Business to Business MCC) |\n| 65 | 5074 | Plumbing and Heating Equipment and Supplies (Business to Business MCC) |\n| 66 | 5261 | Nurseries and Lawn and Garden Supply Stores |\n| 67 | 5251 | Hardware Stores, Equipment Utilities Regulated |\n| 68 | 5094 | Precious Stones, Metals, Watches and Jewelry (Business to Business MCC) |\n| 69 | 5072 | Hardware, Plumbing, Heat Equipment and Supplies (Business to Business MCC) |\n| 70 | 5198 | Paints, Varnishes and Supplies (Business to Business MCC) |\n| 71 | 5199 | Non-durable Goods Not Elsewhere Classified (Business to Business MCC) |\n| 72 | 5231 | Glass, Paint, and Wallpaper Stores |\n| 73 | 3640 | Hyatt Motels |\n| 74 | 3632 | The Phoenician |\n| 75 | 3638 | Howard Johnson |\n| 76 | 3641 | Sofitel Hotels |\n| 77 | 3650 | Red Roof Inns |\n| 78 | 3629 | Dan Hotels |\n| 79 | 3649 | Radisson |\n| 80 | 3645 | Queens Moat Houses |\n| 81 | 3639 | Mount Charlotte Thistle |\n| 82 | 3634 | Swissotel |\n| 83 | 3643 | Steigenberger Hotels |\n| 84 | 3644 | EconoLodges |\n| 85 | 3636 | Sarova Hotels |\n| 86 | 3637 | Ramada Inns |\n| 87 | 3630 | Extended Stay Deluxe |\n| 88 | 3646 | Swallow Hotels |\n| 89 | 3628 | Excalibur Hotel and Casino |\n| 90 | 3627 | Extended Stay America |\n| 91 | 3635 | Reso Hotel |\n| 92 | 3647 | Husa Hotels |\n| 93 | 3633 | Rank Hotels |\n| 94 | 3648 | De Vere Hotels |\n| 95 | 3631 | Sleep Inn |\n| 96 | 3642 | Novotel |\n| 97 | 3626 | Studio Plus |\n| 98 | 7991 | Tourist Attractions and Exhibits |\n| 99 | 7933 | Bowling Alleys |\n| 100 | 7993 | Video Amusement Game Supply |\n| 101 | 7941 | Commercial Sports, Professional Sports Clubs, Athletic Fields, and Sports Promoters |\n| 102 | 7994 | Video Game Arcades and Establishments |\n| 103 | 7992 | Public Golf Courses |\n| 104 | 7995 | Betting, including Lottery Tickets, Casino Gaming Chips, Off- Track Betting, and Wagers at Race Track |\n| 105 | 7996 | Amusement Parks, Circuses, Carnivals, and Fortune Tellers |\n| 106 | 3151 | Air Laire |\n| 107 | 3130 | Sunworld International Airways |\n| 108 | 3148 | Air Littoral SA |\n| 109 | 3146 | Luxair |\n| 110 | 3112 | Windward Island |\n| 111 | 3156 | Go Fly |\n| 112 | 3144 | Virgin Atlantic |\n| 113 | 3129 | Surinam Airways |\n| 114 | 3125 | Tan Airlines |\n| 115 | 3132 | Frontier Airlines |\n| 116 | 3141 | Seair Alaska |\n| 117 | 3106 | Braathens S.A.F.E. (Norway) |\n| 118 | 3117 | Venezolana Int de Aviacion |\n| 119 | 3135 | Sudan Airlines |\n| 120 | 3131 | VLM Air |\n| 121 | 3136 | Qatar Air |\n| 122 | 3111 | British Midland |\n| 123 | 3127 | Taca International |\n| 124 | 4723 | Package Tour Operators (Germany Only) |\n| 125 | 4815 | Monthly Summary Telephone Charges |\n| 126 | 4829 | Quasi Cash - Money Transfer |\n| 127 | 4582 | Airports, Flying Fields, and Airport Terminals |\n| 128 | 4899 | Cable, Satellite, and Other Pay Television and Radio Services |\n| 129 | 4457 | Boat Rentals and Leasing |\n| 130 | 4511 | Airlines and Air Carriers |\n| 131 | 4761 | Telemarketing of Travel Related Services and Vitamins |\n| 132 | 4813 | Special Telecom Merchant |\n| 133 | 5044 | Photographic, Photocopy, Microfilm Equipment and Supplies (Business to Business MCC) |\n| 134 | 4468 | Marinas, Marine Service, and Supplies |\n| 135 | 4789 | Transportation Services-not elsewhere classified |\n| 136 | 5013 | Motor Vehicle Supplies and New Parts (Business to Business MCC) |\n| 137 | 5047 | Dental/Laboratory/Medical/Ophthalmic Hospital Equipment and Supplies |\n| 138 | 5046 | Commercial Equipment Not Elsewhere Classified (Business to Business MCC) |\n| 139 | 5021 | Office Furniture (Business to Business MCC) |\n| 140 | 5039 | Construction Materials Not Elsewhere Classified (Business to Business MCC) |\n| 141 | 4812 | Telecommunication Equipment and Telephone Sales |\n| 142 | 5045 | Computers, Computer Peripheral Equipment, and Software |\n| 143 | 4784 | Bridge and Road Fees, Tolls |\n| 144 | 4900 | Utilities-Electric, Gas, Water, and Sanitary |\n| 145 | 4722 | Travel Agencies |\n| 146 | 4814 | Telecommunication Services, Including Local and Long Distance Calls, Credit Card Calls, Call Through Use of Magnetic-Strip-Reading Telephones, and Fax Services |\n| 147 | 4821 | Telegraph Services |\n| 148 | 4816 | Computer Network/Information Services and other Online Services such as electronic bulletin board, e-mail, web site hosting services, or Internet access |\n| 149 | 3618 | Great Wolf |\n| 150 | 3609 | Gaylord Palms |\n| 151 | 3612 | Movenpick Hotels |\n| 152 | 3611 | C MON INN |\n| 153 | 3624 | Lady Luck Hotel and Casino |\n| 154 | 3608 | Gaylord Opryland |\n| 155 | 3615 | Travelodge Motels |\n| 156 | 3623 | Dorint Hotels |\n| 157 | 3610 | Gaylord Texan |\n| 158 | 3620 | Binion's Horseshoe Club |\n| 159 | 3617 | America's Best Value Inn |\n| 160 | 3621 | Extended Stay |\n| 161 | 3622 | Merlin Hotel |\n| 162 | 3625 | Hotel Universale |\n| 163 | 3619 | Aloft |\n| 164 | 3607 | Fountainebleau Resort |\n| 165 | 3613 | Microtel Inns & Suites |\n| 166 | 3614 | Americinn |\n| 167 | 3087 | Metro Airlines |\n| 168 | 3084 | Eva Airlines |\n| 169 | 3099 | Cathay Pacific |\n| 170 | 3102 | Iberia |\n| 171 | 3103 | Garuda (Indonesia) |\n| 172 | 3094 | Zambia Airways |\n| 173 | 3090 | Uni Airways |\n| 174 | 3085 | Midwest Express Airlines, Inc |\n| 175 | 3089 | Tans Saero |\n| 176 | 3105 | Piedmont |\n| 177 | 3098 | Asiana Airlines |\n| 178 | 3096 | Air Zimbabwe |\n| 179 | 3097 | Spanair (abbreviation: SPANAIR) |\n| 180 | 3100 | Malaysian Airline Sys |\n| 181 | 7629 | Electrical and Small Appliance Repair Shops |\n| 182 | 7692 | Welding Services |\n| 183 | 7549 | Towing Services |\n| 184 | 7922 | Theatrical Producers (except Motion Pictures) and Ticket Agencies |\n| 185 | 7778 | Citishare Cash Advance |\n| 186 | 7542 | Car Washes |\n| 187 | 7801 | Government-Licensed Casinos (Online Gambling) |\n| 188 | 7829 | Motion Picture & Video Tape Production and Distribution (Business to Business MCC) |\n| 189 | 7623 | Air Conditioning and Refrigeration Repair Shops |\n| 190 | 7800 | Government-Owned Lotteries |\n| 191 | 7932 | Billiards & Pool Establishments |\n| 192 | 7841 | DVD/Video Tape Rental Stores |\n| 193 | 7929 | Bands, Orchestras & Misc Entertainment |\n| 194 | 7911 | Dance Halls, Studios & Schools |\n| 195 | 7832 | Motion Picture Theater |\n| 196 | 7641 | Furniture - Reupholster, Repair, and Refinishing |\n| 197 | 7802 | Government-Licensed Horse/Dog Racing |\n| 198 | 7622 | Electronic Repair Shops |\n| 199 | 7631 | Watch, Clock, and Jewelry Repair Shops |\n| 200 | 7699 | Miscellaneous Repair Shops and Related Services |\n| 201 | 4215 | Courier Services-Air and Ground, and Freight Forwarders |\n| 202 | 3825 | Vdara |\n| 203 | 4011 | Railroads |\n| 204 | 3829 | Country Inn by Carlson |\n| 205 | 3821 | Caribe Royale |\n| 206 | 4121 | Taxicabs and Limousines |\n| 207 | 3828 | Cosmopolitan of Las Vegas |\n| 208 | 4112 | Passenger Rail (train) |\n| 209 | 4111 | Local and Suburban Commuter Passenger Transportation, including Ferries |\n| 210 | 3820 | Jumeirah Essex House |\n| 211 | 4411 | Steamship and Cruise Lines |\n| 212 | 4119 | Ambulance Services |\n| 213 | 3827 | Galt House |\n| 214 | 3822 | Crossland |\n| 215 | 3823 | Grand Sierra Resort |\n| 216 | 3826 | Autograph |\n| 217 | 3824 | Aria |\n| 218 | 3830 | Park Plaza Hotel |\n| 219 | 4131 | Bus Lines, includes Charters/Tour Buses |\n| 220 | 4225 | Public Warehousing-Farm products, Refrigerated Goods, Household Goods, and Storage |\n| 221 | 4214 | Motor Freight Carriers and Trucking-Local and Long Distance, Moving & Storage Companies, and Local Delivery |\n| 222 | 3819 | Oxford Suites |\n| 223 | 3831 | Waldorf |\n| 224 | 7230 | Salon, Barber, Beauty, and Nail Salon |\n| 225 | 3606 | Jefferson Hotel |\n| 226 | 3601 | Trade Winds Resorts |\n| 227 | 3595 | Hospitality Inns |\n| 228 | 3599 | Pannonia Hotels |\n| 229 | 3597 | Riverside Resort and Casino |\n| 230 | 3596 | Wynn Las Vegas |\n| 231 | 3593 | Cunard Hotels |\n| 232 | 3604 | Hilton Garden Inn |\n| 233 | 3594 | Arizona Biltmore |\n| 234 | 3602 | Hudson Hotel |\n| 235 | 3603 | Noah's Hotel |\n| 236 | 3600 | Saddlebrook Resort - Tampa |\n| 237 | 3598 | Regent International Hotels |\n| 238 | 3605 | Jurys Doyle Hotel Group |\n| 239 | 3083 | Air Afrique |\n| 240 | 3078 | China Airlines |\n| 241 | 3077 | Thai Airways |\n| 242 | 3073 | Air Cal |\n| 243 | 3076 | Aeromexico |\n| 244 | 3075 | Singapore Airlines |\n| 245 | 3070 | Pacific Southwest Airlines (PSA) |\n| 246 | 3069 | Sun Country Air |\n| 247 | 3072 | CEBU PAC |\n| 248 | 3082 | Korean Airlines |\n| 249 | 3071 | Air British Columbia |\n| 250 | 3079 | Jetstar Airways - Jetstar |\n| 251 | 7375 | Information Retrieval Services (Business to Business MCC) |\n| 252 | 7524 | Express Payment Service Mechants - Parking Lots and Garages |\n| 253 | 7361 | Employment Agencies and Temporary Help Services |\n| 254 | 7531 | Automotive Top & Body Shops |\n| 255 | 7392 | Management, Consulting, and Public Relations Services |\n| 256 | 7535 | Automotive Paint Shops |\n| 257 | 7395 | Photofinishing Laboratories and Photo Developing |\n| 258 | 7519 | Motor Home and Recreational Vehicle Rentals |\n| 259 | 7339 | Stenographic Service |\n| 260 | 7372 | Computer Programming, Data Processing, and Integrated Systems Design Services |\n| 261 | 7513 | Truck and Utility Trailer Rentals |\n| 262 | 7511 | Truck Stops |\n| 263 | 7379 | Computer Maintenance, Repair and Services (Business to Business MCC) |\n| 264 | 7534 | Tire Retreading & Repair |\n| 265 | 7338 | Quick Copy, Reproduction Service |\n| 266 | 7538 | Automotive Service Shops (Non-Dealer) |\n| 267 | 7349 | Cleaning, Maintenance & Janitorial Services |\n| 268 | 7523 | Parking Lots and Garages |\n| 269 | 7399 | Business Services |\n| 270 | 7512 | Automobile Rental Agency |\n| 271 | 7393 | Detective Agencies, Protective Agencies, and Security Services, including Armored Cars and Guard Dogs |\n| 272 | 7342 | Exterminating and Disinfecting Services |\n| 273 | 7394 | Equipment, Tool, Furniture, and Appliance Rental and Leasing |\n| 274 | 3429 | Insurance Rent-a-Car |\n| 275 | 3431 | Replacement Rent-a-Car |\n| 276 | 3427 | Avon Rent-a-Car |\n| 277 | 3425 | Automate Rent-a-Car |\n| 278 | 3430 | Major Rent-a-Car |\n| 279 | 3412 | A-1 R-A-C |\n| 280 | 3420 | ANSA International |\n| 281 | 3409 | General Rent-a-Car |\n| 282 | 3421 | Allstate Rent-a-Car |\n| 283 | 3423 | Avcar Rent-a-Car |\n| 284 | 3428 | Carey Rent-a-Car |\n| 285 | 3405 | Enterprise R-A-C |\n| 286 | 3797 | Atlantic City Hilton |\n| 287 | 3788 | Ala Moana Hotel / Ala Moana Hotels |\n| 288 | 3814 | The Roosevelt Hotel NY |\n| 289 | 3813 | Hotel Indigo |\n| 290 | 3802 | The Palace Hotel |\n| 291 | 3818 | Mainstay Suites |\n| 292 | 3791 | Staybridge Suites |\n| 293 | 3796 | Peppermill Hotel Casino |\n| 294 | 3789 | Smugglers' Notch Resort |\n| 295 | 3810 | La Costa Resort |\n| 296 | 3801 | Wilderness Hotel and Golf Resort |\n| 297 | 3793 | The Flamingo Hotels |\n| 298 | 3807 | Element |\n| 299 | 3799 | Hale Koa Hotel |\n| 300 | 3790 | Raffles Hotels |\n| 301 | 3812 | Hyatt Place |\n| 302 | 3817 | Affinia |\n| 303 | 3794 | Grand Casino Hotels |\n| 304 | 3795 | Paris Las Vegas Hotel |\n| 305 | 3811 | Premier Travel Inn |\n| 306 | 3800 | Homestead |\n| 307 | 3815 | Holiday Inn Nickelodeon |\n| 308 | 3808 | LXR |\n| 309 | 3792 | Claridge Casino Hotel |\n| 310 | 3798 | Embassy Vacation Resort |\n| 311 | 3816 | Home2 Suites |\n| 312 | 3588 | Helmsley Hotels |\n| 313 | 3584 | Princess Hotels International |\n| 314 | 3589 | Doral Golf Resort |\n| 315 | 3586 | Sokos Hotels |\n| 316 | 3587 | Doral Hotels |\n| 317 | 3590 | Fairmont Hotel |\n| 318 | 3585 | Hungar Hotels |\n| 319 | 3591 | Sonesta Hotels |\n| 320 | 3592 | Omni Hotels |\n| 321 | 3068 | AIR STANA |\n| 322 | 3064 | Adria Airways |\n| 323 | 3058 | Delta |\n| 324 | 3054 | Ladeco (Chile) |\n| 325 | 3055 | LAB (Bolivia) |\n| 326 | 3057 | Virgin America – VIR AMER |\n| 327 | 3063 | US Airways |\n| 328 | 3062 | Hapag-Lloyd Express - HLX |\n| 329 | 3060 | NWA Air |\n| 330 | 3052 | LANAIR |\n| 331 | 3053 | AVIACO (Spain) |\n| 332 | 3066 | Southwest |\n| 333 | 3056 | JetAir |\n| 334 | 3059 | DBA Airlines-DBA AIR |\n| 335 | 3065 | Airinter (AirInternational) |\n| 336 | 3061 | Continental |\n| 337 | 7299 | Miscellaneous Personal Services - Not Elsewhere Classified |\n| 338 | 7332 | Blueprinting and Photocopying Services |\n| 339 | 7333 | Commercial Photography, Art, and Graphics |\n| 340 | 7311 | Advertising Services |\n| 341 | 7298 | Health and Beauty Spas |\n| 342 | 7276 | Tax Preparation Services |\n| 343 | 7297 | Massage Parlors |\n| 344 | 7321 | Consumer Credit Reporting Agencies |\n| 345 | 7277 | Counseling Services - Debt, Marriage, and Personal |\n| 346 | 7296 | Clothing Rental - Costumes, Uniforms and Formal Wear |\n| 347 | 7278 | Buying and Shopping Services and Clubs |\n| 348 | 3395 | Thrify Car Rental |\n| 349 | 3398 | Econo Car R-A-C |\n| 350 | 3389 | Avis R-A-C |\n| 351 | 3391 | Europe by Car |\n| 352 | 3386 | Showcase Rental Cars |\n| 353 | 3396 | Tilden R-A-C |\n| 354 | 3394 | Kemwell Group R-A-C |\n| 355 | 3400 | Auto Host Car Rentals |\n| 356 | 3387 | Alamo Rent a Car |\n| 357 | 3385 | Tropical R-A-C |\n| 358 | 3388 | Merchants Rent-A-Car, Inc |\n| 359 | 3381 | Europ Car |\n| 360 | 3390 | Dollar R-A-C |\n| 361 | 3393 | National Car Rental |\n| 362 | 3772 | Nemacolin Woodlands |\n| 363 | 3781 | Patricia Grand Resort Hotels |\n| 364 | 3786 | Ohana Hotel of Hawaii |\n| 365 | 3775 | Sands Resort |\n| 366 | 3778 | Four Points Hotels |\n| 367 | 3776 | Nevele Grande Resort and Country Club |\n| 368 | 3782 | Rosen Hotels & Resort |\n| 369 | 3774 | New York-New York Hotel and Casino |\n| 370 | 3767 | Main Street Hotel and Casino |\n| 371 | 3777 | Mandalay Bay Resort |\n| 372 | 3770 | SpringHill Suites |\n| 373 | 3783 | Town and Country Resort and Convention Center |\n| 374 | 3784 | First Hospitality Hotel |\n| 375 | 3773 | The Venetian Resort Hotel and Casino |\n| 376 | 3787 | Caribe Royale Resort Suites & Villas |\n| 377 | 3785 | Outrigger Hotels and Resorts |\n| 378 | 3780 | Disney Resorts |\n| 379 | 3779 | W Hotels |\n| 380 | 3765 | Bellagio |\n| 381 | 3769 | Stratosphere Hotel and Casino |\n| 382 | 3766 | Fremont Hotel and Casino |\n| 383 | 3768 | Silver Star Hotel and Casino |\n| 384 | 3771 | Caesar's Resort |\n| 385 | 3583 | Radisson BLU |\n| 386 | 3578 | Frankenmuth Bavarian |\n| 387 | 3580 | Hotel Del Coronado |\n| 388 | 3575 | Vagabond Hotels |\n| 389 | 3576 | La Quinta Resort |\n| 390 | 3573 | Sandman Hotels |\n| 391 | 3582 | California Hotel and Casino |\n| 392 | 3574 | Venture Inn |\n| 393 | 3577 | Mandarin Oriental Hotel |\n| 394 | 3581 | Delta Hotels |\n| 395 | 3579 | Hotel Mercure |\n| 396 | 3044 | Air Lanka |\n| 397 | 3042 | FinnAir |\n| 398 | 3049 | Tunis Air |\n| 399 | 3046 | Cruzeiro do Sul (Bra) |\n| 400 | 3039 | Avianca |\n| 401 | 3037 | EgyptAir |\n| 402 | 3041 | Balkan-Bulgarian |\n| 403 | 3043 | Aer Lingus |\n| 404 | 3051 | Austrian Airlines |\n| 405 | 3035 | TAP (Portugal) |\n| 406 | 3033 | Ansett Airlines |\n| 407 | 3045 | Nigeria Airways |\n| 408 | 3048 | Royal Air Maroc |\n| 409 | 3034 | ETIHADAIR |\n| 410 | 3040 | GulfAir (Bahrain) |\n| 411 | 3050 | Icelandair |\n| 412 | 3038 | Kuwait Airways |\n| 413 | 3047 | THY (Turkey) |\n| 414 | 3036 | VASP (Brazil) |\n| 415 | 7210 | Laundry, Cleaning, and Garment Services |\n| 416 | 7261 | Funeral Services and Crematories |\n| 417 | 7251 | Shoe Repair Shops, Shoe Shine Parlors, and Hat Cleaning Shops |\n| 418 | 6535 | Value Purchase - Member Financial Institution |\n| 419 | 7012 | Timeshares |\n| 420 | 6533 | Payment Transaction - Merchant |\n| 421 | 6537 | MoneySend Intercountry |\n| 422 | 6540 | POI Funding Transactions (Excluding MoneySend) |\n| 423 | 7032 | Sporting and Recreational Camps |\n| 424 | 7211 | Laundry Services - Family and Commercial |\n| 425 | 6534 | Money Transfer - Member Financial Institution |\n| 426 | 7273 | Dating Services |\n| 427 | 6531 | Payment Service Provider |\n| 428 | 7011 | Lodging - Hotels, Motels, and Resorts |\n| 429 | 7217 | Carpet and Upholstery Cleaning |\n| 430 | 7033 | Trailer Parks and Campgrounds |\n| 431 | 7216 | Dry Cleaners |\n| 432 | 7221 | Photographic Studios |\n| 433 | 6538 | MoneySend Funding |\n| 434 | 6536 | MoneySend Intracountry |\n| 435 | 6532 | Payment Transaction - Member |\n| 436 | 3353 | Brooks Rent a Car |\n| 437 | 3368 | Holiday R-A-C |\n| 438 | 3380 | Triangle Rent a Car |\n| 439 | 3364 | Agency Rent a Car |\n| 440 | 3376 | Ajax R-A-C |\n| 441 | 3361 | Airways Rent a Car |\n| 442 | 3354 | Action Auto Rental |\n| 443 | 3352 | American International |\n| 444 | 3355 | SIXT Car Rental |\n| 445 | 3359 | Payless Car Rental |\n| 446 | 3362 | Altra Auto Rental |\n| 447 | 3374 | Accent Rent-A-Car |\n| 448 | 3370 | Rent-a-Wreck |\n| 449 | 3366 | Budget Rent a Car |\n| 450 | 3360 | Snappy Car Rental |\n| 451 | 3357 | Hertz |\n| 452 | 3351 | Affiliated Auto Rental |\n| 453 | 3758 | Kahala Mandarion Oriental Hotel |\n| 454 | 3751 | Homewood Suites |\n| 455 | 3760 | Halekulani Hotel/Waikiki Parc |\n| 456 | 3738 | Tropicana Resort & Casino |\n| 457 | 3753 | Greenbriar Resorts |\n| 458 | 3741 | Millennium Hotel |\n| 459 | 3737 | Riviera Hotel and Casino |\n| 460 | 3748 | Wellesley Inns |\n| 461 | 3740 | Towneplace Suites |\n| 462 | 3749 | The Beverly Hills Hotel |\n| 463 | 3762 | Whisky Pete's Hotel and Casino |\n| 464 | 3746 | The Eliot Hotel |\n| 465 | 3761 | Primadonna Hotel and Casino |\n| 466 | 3759 | The Orchid at Mauna Lani |\n| 467 | 3739 | Woodside Hotels & Resorts |\n| 468 | 3750 | Crown Plaza Hotels |\n| 469 | 3752 | Peabody Hotels |\n| 470 | 3764 | Beau Rivage Hotel and Casino |\n| 471 | 3755 | The Homestead |\n| 472 | 3747 | ClubCorp/ClubResorts |\n| 473 | 3754 | Amelia Island Plantation |\n| 474 | 3736 | Colorado Belle/Edgewater Resort |\n| 475 | 3763 | Chateau Elan Winery and Resort |\n| 476 | 3745 | St. Regis Hotel |\n| 477 | 3757 | Canyon Ranch |\n| 478 | 3744 | Carefree Resorts |\n| 479 | 3560 | Aladdin Resort and Casino |\n| 480 | 3568 | Ladbroke Hotels |\n| 481 | 3567 | Soho Grand Hotel |\n| 482 | 3572 | Miyako Hotel |\n| 483 | 3562 | Comfort Inns |\n| 484 | 3564 | Sam's Town Hotel and Casino |\n| 485 | 3561 | Golden Nugget |\n| 486 | 3570 | Forum Hotels |\n| 487 | 3566 | Garden Place Hotel |\n| 488 | 3571 | Grand Wailea Resort |\n| 489 | 3563 | Journey's End Motels |\n| 490 | 3565 | Relax Inns |\n| 491 | 3569 | Tribeca Grand Hotel |\n| 492 | 3031 | Olympic Airways |\n| 493 | 3018 | Varig (Brazil) |\n| 494 | 3029 | SN Brussels Airlines - SN BRUSSELS |\n| 495 | 3025 | Air New Zealand Ltd. |\n| 496 | 3015 | SWISS |\n| 497 | 3016 | SAS |\n| 498 | 3021 | Air Algerie |\n| 499 | 3022 | PAL AIR |\n| 500 | 3028 | Air Malta |\n| 501 | 3024 | Pakistan International |\n| 502 | 3032 | El Al |\n| 503 | 3026 | Emirates Airlines |\n| 504 | 3017 | South African Airway |\n| 505 | 3030 | Aerolineas Argentinas |\n| 506 | 3027 | UTA/InterAir |\n| 507 | 3020 | Air India |\n| 508 | 3023 | Mexicana |\n| 509 | 6300 | Insurance Sales and Underwriting |\n| 510 | 5992 | Florists |\n| 511 | 6051 | Visa - Non-Financial Institutions - Foreign Currency, Money Orders(not wire Transfer), & Travelers Cheques |\n| 512 | 5993 | Cigar Stores & Stands |\n| 513 | 5983 | Fuel Dealers--Fuel Oil, Wood, Coal, and Liquefied Petroleum |\n| 514 | 6381 | Insurance - Premiums |\n| 515 | 5977 | Cosmetic Stores |\n| 516 | 6530 | Remote Stored Value Load - Merchant |\n| 517 | 5998 | Tent and Awning Stores |\n| 518 | 5999 | Miscellaneous & Specialty Retail Stores |\n| 519 | 6529 | Remote Stored Value Load - Member Financial Institution |\n| 520 | 6010 | Financial Institutions--Manual Cash Disbursements |\n| 521 | 6513 | Real Estate Agents and Managers - Rentals; Property Management |\n| 522 | 5978 | Typewriter Stores--Sales, Service, and Rentals |\n| 523 | 6211 | Securities - Brokers and Dealers |\n| 524 | 6050 | Quasi Cash - Member Financial Institution |\n| 525 | 5996 | Swimming Pools--Sales, Supplies, and Services |\n| 526 | 6012 | Quasi Cash - Financial Institution - Merchandise and Services |\n| 527 | 6011 | Financial Institutions--Automated Cash Disbursements |\n| 528 | 5994 | News Dealers & Newsstands |\n| 529 | 5995 | Pet Shops, Pet Food, and Supplies |\n| 530 | 5997 | Electric Razor Stores Sales & Services |\n| 531 | 3277 | Air Madagascar |\n| 532 | 3298 | Air Mauritius |\n| 533 | 3286 | Aero Nicaraguensis |\n| 534 | 3296 | Air Berlin-AIRBERLIN |\n| 535 | 3287 | Aero Coach Aviation |\n| 536 | 3282 | Air Djibouti |\n| 537 | 3279 | Air LA |\n| 538 | 3276 | Air Midwest |\n| 539 | 3295 | Kenya Airways |\n| 540 | 3293 | Ecuatoriana |\n| 541 | 3292 | Cyprus Airways |\n| 542 | 3285 | AeroPeru |\n| 543 | 3275 | Air Nevada |\n| 544 | 3294 | Ethiopian Airlines |\n| 545 | 3280 | Air Jamaica |\n| 546 | 3291 | Ariana Afghan |\n| 547 | 3299 | Wideroe's Flyveselskap |\n| 548 | 3297 | Tarom Romanian Air Transport |\n| 549 | 3729 | John Ascuaga's Nugget |\n| 550 | 3734 | Harvey/Bristol Hotels |\n| 551 | 3730 | MGM Grand Hotel |\n| 552 | 3723 | Rica Hotels |\n| 553 | 3728 | Bally's Hotel and Casino |\n| 554 | 3725 | SeaPines Plantation |\n| 555 | 3735 | Master Economy Inns |\n| 556 | 3732 | Opryland Hotel |\n| 557 | 3731 | Harrah's Hotels and Casinos |\n| 558 | 3721 | Hilton Conrad Hotels |\n| 559 | 3722 | Wyndham Hotels |\n| 560 | 3726 | Rio Suites |\n| 561 | 3724 | Inter Nor Hotels |\n| 562 | 3727 | Broadmoor Hotel |\n| 563 | 3556 | Barton Creek Resort |\n| 564 | 3555 | Treasure Island Hotel and Casino |\n| 565 | 3552 | Coast Hotel |\n| 566 | 3553 | Park Inn by Radisson |\n| 567 | 3546 | Hotel Sierra |\n| 568 | 3551 | Mirage Hotel and Casino |\n| 569 | 3542 | Royal Hotels |\n| 570 | 3545 | Shangri-La International |\n| 571 | 3549 | Auberge des Governeurs |\n| 572 | 3558 | Jolly Hotels |\n| 573 | 3543 | Four Seasons |\n| 574 | 3559 | Candlewood Suites |\n| 575 | 3544 | Cigna Hotels |\n| 576 | 3554 | Pinehurst Resort |\n| 577 | 3557 | Manhattan East Suite Hotels |\n| 578 | 3548 | Hotels Melia |\n| 579 | 3550 | Regal 8 Inns |\n| 580 | 3000 | United Airlines |\n| 581 | 3012 | Qantas |\n| 582 | 3008 | Lufthansa |\n| 583 | 3006 | Japan Air Lines |\n| 584 | 3007 | Air France |\n| 585 | 3002 | Pan American |\n| 586 | 3001 | American Airlines |\n| 587 | 3009 | Air Canada |\n| 588 | 3004 | Dragon Airlines |\n| 589 | 3011 | AeroFlot |\n| 590 | 3010 | KLM |\n| 591 | 3014 | Saudi Arabian Airlines |\n| 592 | 2842 | Specialty Cleaning, Polishing and Sanitation Preparations (Business to Business MCC) |\n| 593 | 3013 | Alitalia |\n| 594 | 3005 | British Airways |\n| 595 | 3003 | Eurofly Airlines |\n| 596 | 5946 | Camera and Photographic Supply Stores |\n| 597 | 5963 | Direct Selling Establishments/Door to Door Sales |\n| 598 | 5965 | Combined Catalog and Retail Merchant |\n| 599 | 5975 | Hearing Aids--Sales, Service, and Supplies |\n| 600 | 5932 | Antique Shop |\n| 601 | 5949 | Sewing, Needlework, Fabric, and Piece Good Stores |\n| 602 | 5968 | Continuity/Subscription Merchants |\n| 603 | 5961 | Mail Order |\n| 604 | 5942 | Book Stores |\n| 605 | 5967 | Direct Marketing -- Inbound Telemarketing Merchants |\n| 606 | 5940 | Bicycle Shop-Sales and Services |\n| 607 | 5944 | Jewelry, Watch, Clock, and Silverware Stores |\n| 608 | 5973 | Religious Goods Stores |\n| 609 | 5976 | Orthopedic Goods and Prosthetic Devices |\n| 610 | 5962 | Direct Marketing -- Travel Related Arrangement Services |\n| 611 | 5972 | Stamp and Coin Stores |\n| 612 | 5941 | Sporting Goods Stores |\n| 613 | 5947 | Gift, Card, Novelty, and Souvenir Stores |\n| 614 | 5960 | Direct Marketing Insurance Services |\n| 615 | 5935 | Wrecking and Salvage Yards |\n| 616 | 5937 | Antique Reproduction Stores |\n| 617 | 5950 | Glassware and Crystal Stores |\n| 618 | 5966 | Outbound Telemarketing Merchant |\n| 619 | 5969 | Direct Marketing/Direct Marketers--Not Elsewhere Classified |\n| 620 | 5933 | Pawn Shop |\n| 621 | 5945 | Hobby, Toy and Game Stores |\n| 622 | 5970 | Artist Supply and Craft Stores |\n| 623 | 5943 | Stationery, Office and School Supply Stores |\n| 624 | 5948 | Luggage and Leather Goods Stores |\n| 625 | 5971 | Art Dealers and Galleries |\n| 626 | 5964 | Catalog Merchant |\n| 627 | 3247 | Gol Airlines - GOL |\n| 628 | 3241 | Aviateca (Guatemala) |\n| 629 | 3267 | Air Panama International |\n| 630 | 3260 | Spirit Airlines - SPIRIT |\n| 631 | 3245 | Easy Jet - EASYJET |\n| 632 | 3243 | Austrian Air Service |\n| 633 | 3246 | Ryan Air - RYANAIR |\n| 634 | 3240 | Bahamasair |\n| 635 | 3268 | Air Pacific |\n| 636 | 3261 | Air China |\n| 637 | 3256 | Alaska Airlines Inc. |\n| 638 | 3252 | ALM-Antilean Airlines |\n| 639 | 3248 | Tam Airlines - TAM |\n| 640 | 3263 | Aero Servicio Carabobo |\n| 641 | 3266 | Air Seychelles |\n| 642 | 3242 | Avensa |\n| 643 | 3239 | Bar Harbor Airlines |\n| 644 | 3709 | Super 8 Motels |\n| 645 | 3707 | Shoney's Inn |\n| 646 | 3714 | Four Seasons Hotels-Austr |\n| 647 | 3708 | Virgin River Hotel and Casino |\n| 648 | 3717 | City Lodge Hotels |\n| 649 | 3716 | Carlton Hotels |\n| 650 | 3706 | Shilo Inn |\n| 651 | 3712 | Buffalo Bill's Hotel and Casino |\n| 652 | 3720 | Southern Sun Hotels |\n| 653 | 3704 | Royce Hotels |\n| 654 | 3713 | Quality Pacific Hotel |\n| 655 | 3705 | Sandman Inn |\n| 656 | 3711 | Flag Inns (Australia) |\n| 657 | 3719 | Protea Hotels |\n| 658 | 3710 | The Ritz Carlton Hotels |\n| 659 | 3718 | Karos Hotels |\n| 660 | 3715 | Fairfield Inn |\n| 661 | 3530 | Renaissance Hotels |\n| 662 | 3540 | Iberotel Hotels |\n| 663 | 3527 | Downtowner Passport |\n| 664 | 3534 | Southern Pacific |\n| 665 | 3524 | WelcomGroup Hotels |\n| 666 | 3537 | ANA Hotels |\n| 667 | 3533 | Hotel Ibis |\n| 668 | 3531 | Kauai Coconut Beach Resort |\n| 669 | 3538 | Concorde Hotels |\n| 670 | 3541 | Hotel Okura |\n| 671 | 3536 | AMFAC Hotels |\n| 672 | 3529 | CP (Canadian Pacific) |\n| 673 | 3526 | Prince Hotels |\n| 674 | 3532 | Royal Kona Resort |\n| 675 | 3535 | Hilton International |\n| 676 | 3539 | Summerfield Suites Hotel |\n| 677 | 3528 | Red Lion Inns |\n| 678 | 3525 | Dunfey Hotels |\n| 679 | 0763 | Agricultural Cooperatives |\n| 680 | 1740 | Masonry, Stonework, Tile Setting, Plastering, Insulation Contractors |\n| 681 | 0780 | Landscaping and Horticultural Services |\n| 682 | 1750 | Carpentry |\n| 683 | 1711 | Heating, Plumbing, Air Conditioning Contractors |\n| 684 | 2791 | Typesetting, Plate Making and Related Services (Business to Business MCC) |\n| 685 | 1731 | Electrical Contractors |\n| 686 | 1761 | Roof, Siding, and Sheet Metal Work Contractors |\n| 687 | 2741 | Miscellaneous Publishing and Printing Services |\n| 688 | 1799 | Special Trade Contractor - Not Elsewhere Classified |\n| 689 | 1771 | Contractors, Concrete |\n| 690 | 0742 | Veterinary Services |\n| 691 | 1520 | General Contractor/Residential Building |\n| 692 | 5722 | Household Appliance Stores |\n| 693 | 5718 | Fireplaces, Fireplace Screens and Accessories Stores |\n| 694 | 5719 | Miscellaneous Home Furnishing Specialty Stores |\n| 695 | 5921 | Package Stores--Beer, Wine, and Liquor |\n| 696 | 5817 | Digital Goods – Applications (Excludes Games) |\n| 697 | 5816 | Digital Goods – Games |\n| 698 | 5812 | Eating Places and Restaurants |\n| 699 | 5912 | Drug Stores and Pharmacies |\n| 700 | 5732 | Electronics Stores |\n| 701 | 5813 | Drinking Places (Alcoholic Beverages) - Bars, Taverns, Nightclubs, Cocktail Lounges, and Discotheques |\n| 702 | 5735 | Record Stores |\n| 703 | 5734 | Computer Software Stores |\n| 704 | 5713 | Floor coverings, Rugs |\n| 705 | 5814 | Quick Payment Service-Fast Food Restaurants |\n| 706 | 5733 | Music Stores-Musical Instruments, Pianos, and Sheet Music |\n| 707 | 5931 | Used Merchandise and Secondhand Stores |\n| 708 | 5811 | Caterers - Prepare & Delivery |\n| 709 | 5818 | Large Digital Goods Merchant |\n| 710 | 5714 | Drapery, Window Covering, and Upholstery Stores |\n| 711 | 5815 | Digital Goods – Media, Books, Movies, Music |\n| 712 | 3229 | SAETA |\n| 713 | 3217 | CSA-Ceskoslovenske Aeroln |\n| 714 | 3231 | SAHSA |\n| 715 | 3228 | Cayman Airways |\n| 716 | 3226 | Skyways\\_ Air- SKYWAYS |\n| 717 | 3222 | Command Airways |\n| 718 | 3220 | Compania Faucett |\n| 719 | 3213 | Malmo Aviation - MALMO AV |\n| 720 | 3211 | Norwegian Air Shuttle - NORWEGIANAIR |\n| 721 | 3219 | Copa |\n| 722 | 3212 | Dominicana de Aviacion |\n| 723 | 3206 | China Eastern Airlines (Abbr: China East Air) |\n| 724 | 3223 | Comair |\n| 725 | 3236 | Air Arabia Airlines - Air Arab |\n| 726 | 3204 | Freedom Airlines |\n| 727 | 3200 | Guyana Airways |\n| 728 | 3221 | Transportes Aeros Mil |\n| 729 | 3234 | CARIBAIR |\n| 730 | 3207 | Empresa Ecuatoriana |\n| 731 | 3691 | Dillon Inn |\n| 732 | 3700 | Motel 6 |\n| 733 | 3703 | Residence Inn |\n| 734 | 3689 | Consort Hotels |\n| 735 | 3694 | Economy Inns of America |\n| 736 | 3693 | Drury Inn |\n| 737 | 3699 | Midway Motor Lodge |\n| 738 | 3698 | Harley Hotels |\n| 739 | 3702 | The Registry Hotels |\n| 740 | 3697 | Fairfield Hotels |\n| 741 | 3701 | La Mansion Del Rio |\n| 742 | 3695 | Embassy Suites |\n| 743 | 3690 | Courtyard Inns |\n| 744 | 3692 | Doubletree |\n| 745 | 3696 | Excel Inn |\n| 746 | 6399 | Insurance - Not Elsewhere Classified |\n| 747 | 9222 | Fines |\n| 748 | 9753 | Consumer Electronics/Furniture Store |\n| 749 | 9752 | U.K. Petrol Stations, Electronic Hot File |\n| 750 | 9311 | Tax Payments |\n| 751 | 9399 | Government Services - Not Elsewhere Classified |\n| 752 | 9751 | U.K. Supermarkets, Electronic Hot File |\n| 753 | 5262 | Marketplaces |\n| 754 | 8931 | Accounting, Auditing, and Bookkeeping Services |\n| 755 | 8999 | Professional Services - Not Elsewhere Classified |\n| 756 | 2047 | Dog and Cat Food Mfg |\n| 757 | 9754 | Quasi Cash - Gambling-Horse Racing, Dog Racing, State Lotteries |\n| 758 | 9701 | Visa Credential Server |\n| 759 | 9401 | i-Purchasing |\n| 760 | 9950 | Intra-Company Purchases |\n| 761 | 9700 | Automated Referral Service |\n| 762 | 9223 | Bail & Bond Payments |\n| 763 | 9211 | Court Costs, including Alimony and Child Support |\n| 764 | 9702 | GCAS Emergency Services |\n| 765 | 9402 | Postal Services |\n| 766 | 9405 | U.S. Fed Government Agencies |\n| 767 | 3516 | LaQuinta Motor Inns |\n| 768 | 3511 | Arabella Hotels |\n| 769 | 3519 | Pullman International Hotels |\n| 770 | 3518 | Sol Hotels |\n| 771 | 3510 | Days Inn Colonial Resort |\n| 772 | 3522 | Tokyo Group |\n| 773 | 3508 | Quality Inns |\n| 774 | 3509 | Marriott |\n| 775 | 3520 | Meridien Hotels |\n| 776 | 3523 | Peninsula Hotels |\n| 777 | 3512 | Intercontinental Hotels |\n| 778 | 3521 | Royal Lahaina Resort |\n| 779 | 3506 | Golden Tulip Hotels |\n| 780 | 3517 | Americana Hotels |\n| 781 | 3514 | Amerisuites |\n| 782 | 3513 | Westin |\n| 783 | 3515 | Rodeway Inn |\n| 784 | 3507 | Friendship Inns |\n| 785 | 5592 | Motor Home Dealers |\n| 786 | 5681 | Furriers & Fur Shops |\n| 787 | 5598 | Snowmobile Dealers |\n| 788 | 5611 | Men's & Boys' Clothing and Accessory Stores |\n| 789 | 5651 | Family Clothing Stores |\n| 790 | 5699 | Miscellaneous Apparel and Accessory Stores |\n| 791 | 5697 | Tailors, Seamstresses, Mending, Alterations |\n| 792 | 5599 | Miscellaneous Automotive, Aircraft, and Farm Equipment Dealers --Not Elsewhere Classified |\n| 793 | 5712 | Furniture, Home Furnishings, and Equipment Stores, except Appliances |\n| 794 | 5641 | Children's and Infants' Wear Stores |\n| 795 | 5655 | Sports and Riding Apparel Stores |\n| 796 | 5631 | Women's Accessory and Specialty Stores |\n| 797 | 5698 | Wig & Toupee Shops |\n| 798 | 5661 | Shoe Stores |\n| 799 | 5621 | Women's Ready-to-Wear Stores |\n| 800 | 5691 | Men's and Women's Clothing Stores |\n| 801 | 3198 | Harbor Airlines |\n| 802 | 3180 | Westjet Airlines-WESTJET |\n| 803 | 3178 | Mesa Air |\n| 804 | 3196 | Hawaiian Air |\n| 805 | 3185 | LAV (Venezuela) |\n| 806 | 3177 | AirTran Airways |\n| 807 | 3190 | Jugoslav Air |\n| 808 | 3181 | Malev Hungarian Airlines |\n| 809 | 3183 | Oman Aviation - OMAN AIR |\n| 810 | 3186 | LAP (Paraguay) |\n| 811 | 3187 | LACSA (Costa Rica) |\n| 812 | 3191 | Island Airlines |\n| 813 | 3193 | Indian Airlines |\n| 814 | 3188 | Virgin Express - VIR EXP |\n| 815 | 3199 | Servicios Aereos Militares |\n| 816 | 3195 | Holiday Airlines |\n| 817 | 3182 | LOT (Poland) |\n| 818 | 3184 | LIAT |\n| 819 | 3197 | Havasu Airlines |\n| 820 | 3685 | Budgetel Hotels |\n| 821 | 3682 | Sahara Hotel and Casino |\n| 822 | 3671 | Arctia Hotels |\n| 823 | 3676 | Monte Carlo Hotel and Casino |\n| 824 | 3675 | Interhotel CEDOK |\n| 825 | 3678 | Cumulus Hotels |\n| 826 | 3673 | IBUSZ Hotels |\n| 827 | 3680 | Hoteis Othan |\n| 828 | 3688 | Compri Hotels |\n| 829 | 3681 | Adams Mark Hotels |\n| 830 | 3674 | Rantasipi Hotels |\n| 831 | 3684 | Budget Hosts Inns |\n| 832 | 3679 | Silver Legacy Hotel and Casino |\n| 833 | 3683 | Bradbury Suites |\n| 834 | 3686 | Suisse Chalet |\n| 835 | 3677 | Climat de France Hotels |\n| 836 | 3672 | Campanile Hotels |\n| 837 | 3687 | Clarion Hotels |\n| 838 | 8299 | Schools and Educational Services - Not Elsewhere Classified |\n| 839 | 8641 | Civic, Social, and Fraternal Associations |\n| 840 | 8398 | Charitable and Social Service Organizations |\n| 841 | 8699 | Membership Organizations - Not Elsewhere Classified |\n| 842 | 8675 | Automobile Associations |\n| 843 | 8651 | Political Organizations |\n| 844 | 8734 | Testing Laboratories (Not Medical) - (Business to Business MCC) |\n| 845 | 8661 | Religious Organizations |\n| 846 | 8249 | Trade and Vocational Schools |\n| 847 | 8244 | Business and Secretarial Schools |\n| 848 | 8351 | Child Care Services |\n| 849 | 8911 | Architectural, Engineering, and Surveying Services |\n| 850 | 3439 | Millville Rent-a-Car |\n| 851 | 3441 | Advantage Rent A Car |\n| 852 | 3505 | Forte Hotels |\n| 853 | 3433 | Ugly Duckling R-A-C |\n| 854 | 3435 | Value Rent-a-Car |\n| 855 | 3504 | Hilton |\n| 856 | 3502 | Best Western Hotels |\n| 857 | 3501 | Holiday Inns |\n| 858 | 3503 | Sheraton |\n| 859 | 3438 | Interenet Rent-a-Car |\n| 860 | 3434 | USA Rent-a-Car |\n| 861 | 3436 | Autohansa Rent-a-Car |\n| 862 | 5310 | Discount Store |\n| 863 | 5551 | Boat Dealers |\n| 864 | 5531 | Auto and Home Supply Stores |\n| 865 | 5541 | Service Stations (with or without Ancillary Services) |\n| 866 | 5311 | Department Stores |\n| 867 | 5331 | Variety Stores |\n| 868 | 5533 | Automotive Parts and Accessories Stores |\n| 869 | 5411 | Grocery Stores and Supermarkets |\n| 870 | 5571 | Motorcycle Dealers |\n| 871 | 5441 | Candy, Nut, and Confectionary Stores |\n| 872 | 5462 | Bakeries |\n| 873 | 5309 | Duty Free Stores |\n| 874 | 5511 | Car and Truck Dealers (New and Used)- Sales, Service, Repairs, Parts, and Leasing |\n| 875 | 5300 | Wholesale Club with or without membership fee |\n| 876 | 5521 | Car and Truck Dealers (Used)- Sales, Service, Repairs, Parts, and Leasing |\n| 877 | 5399 | Miscellaneous General Merchandise |\n| 878 | 5422 | Freezer & Locker Meat Provisions |\n| 879 | 5532 | Automotive Tire Stores |\n| 880 | 5542 | Automated Fuel Dispensers |\n| 881 | 5451 | Dairy Product Stores |\n| 882 | 5499 | Miscellaneous Food Stores-Convenience Stores and Specialty Markets |\n| 883 | 7322 | Collection Agency |\n
\n\n\n
\nPayment Method Types\n\n| id | name |\n|----|-----------------|\n| 1 | Card |\n| 2 | ElectronicCheck |\n
\n\n
\nPayment Processor Statuses\n\n| id | name |\n|----|----------|\n| 1 | Active |\n| 2 | Inactive |\n
\n\n
\nPayment Processor Types\n\n| id | name |\n|----|------|\n| 1 | TSYS |\n| 2 | EFT |\n
\n\n
\nStates\n\n\n| id | countryId | code | name |\n|:--:|:---------:|:----:|----------------|\n| 1 | 1 | AL | Alabama |\n| 2 | 1 | AK | Alaska |\n| 3 | 1 | AR | Arkansas |\n| 4 | 1 | AZ | Arizona |\n| 5 | 1 | CA | California |\n| 6 | 1 | CO | Colorado |\n| 7 | 1 | CT | Connecticut |\n| 8 | 1 | DC | D.C. |\n| 9 | 1 | DE | Delaware |\n| 10 | 1 | FL | Florida |\n| 11 | 1 | GA | Georgia |\n| 12 | 1 | HI | Hawaii |\n| 13 | 1 | IA | Iowa |\n| 14 | 1 | ID | Idaho |\n| 15 | 1 | IL | Illinois |\n| 16 | 1 | IN | Indiana |\n| 17 | 1 | KS | Kansas |\n| 18 | 1 | KY | Kentucky |\n| 19 | 1 | LA | Louisiana |\n| 20 | 1 | MA | Massachusetts |\n| 21 | 1 | MD | Maryland |\n| 22 | 1 | ME | Maine |\n| 23 | 1 | MI | Michigan |\n| 24 | 1 | MN | Minnesota |\n| 25 | 1 | MO | Missouri |\n| 26 | 1 | MS | Mississippi |\n| 27 | 1 | MT | Montana |\n| 28 | 1 | NC | North Carolina |\n| 29 | 1 | ND | North Dakota |\n| 30 | 1 | NE | Nebraska |\n| 31 | 1 | NH | New Hampshire |\n| 32 | 1 | NJ | New Jersey |\n| 33 | 1 | NM | New Mexico |\n| 34 | 1 | NV | Nevada |\n| 35 | 1 | NY | New York |\n| 36 | 1 | OK | Oklahoma |\n| 37 | 1 | OH | Ohio |\n| 38 | 1 | OR | Oregon |\n| 39 | 1 | PA | Pennsylvania |\n| 40 | 1 | RI | Rhode Island |\n| 41 | 1 | SC | South Carolina |\n| 42 | 1 | SD | South Dakota |\n| 43 | 1 | TN | Tennessee |\n| 44 | 1 | TX | Texas |\n| 45 | 1 | UT | Utah |\n| 46 | 1 | VA | Virginia |\n| 47 | 1 | VT | Vermont |\n| 48 | 1 | WA | Washington |\n| 49 | 1 | WI | Wisconsin |\n| 50 | 1 | WV | West Virginia |\n| 51 | 1 | WY | Wyoming |\n
\n\n
\nPayment Session Statuses\n\n| id | name |\n|------|-----------|\n| 1 | Created |\n| 2 | Cancelled |\n| 3 | Completed |\n| 4 | Failed |\n
\n\n
\nTransaction Statuses\n\n\n| Status Code | Status | Description | Available actions |\n|-------------|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|\n| 1 | Authorized | Transaction status after an approved `pre-authorization` request | Capture, Void |\n| 2 | Captured | Transaction status after aproved `sale` or `capture` request | Void |\n| 3 | Voided | Transaction status after merchant voids an `authorized` request or refunds a `captured` (not settled) request | N/A |\n| 4 | Refunded | Transaction status after merchant refunds a `settled` request | N/A |\n| 5 | Verified | NA | N/A |\n| 6 | Settled | Transaction status after successful settlement request. All `captured` transactions should have status changed to `settled` | Refund |\n| 7 | Partially Authorized | Transaction status after an approved `pre-authorization` request with the approved amount less than initially requested. Indicates that the issuer bank has approved only a portion of the requested payment amount. The exact authorized amount should be checked in the corresponding field. | Capture, Void |\n| 8 | Informational | NA | N/A |\n| 21 | Scheduled | NA | N/A |\n| 24 | Pending | Transaction status while changing status. This is a temporary status | N/A |\n| 91 | Declined | Transaction status after a denied `pre-authorization`, `sale` or `capture` request | N/A |\n| 92 | Failed | Transaction status after a failure at any type of request | N/A |\n| 92 | Expired | Transaction status after 7 days in `authorized` status (merchant has not captured within this time) | N/A |\n
\n\n
\nTransaction Types\n\n\n| id | name |\n|:--:|--------------------|\n| 1 | Authorization | \n| 2 | Sale | \n| 3 | Capture | \n| 4 | Void | \n| 5 | Refund | \n| 6 | CardAuthentication |\n| 7 | RefundWORef | \n| 8 | TipAdjustment | \n| 11 | AchDebit | \n| 12 | AchRefund | \n| 13 | AchHold | \n| 14 | AchUnHold | \n| 15 | AchCancel | \n| 16 | AchCredit | \n
" }, { "name": "ACH Transactions", "description": "\nThe ACH (automated clearing house) transactions endpoints allow creating and managing ACH payments.\n\nThese operations support initiating ACH debit and credit transactions, retrieving transaction details, and monitoring transaction status throughout processing.\nThey also provide controls for managing transactions before settlement, such as placing transactions on hold, releasing holds, voiding pending transactions, or issuing refunds as needed.\n\nThe following is a typical Aurora ACH workflow.\n\n**Authorizing the Payment**
\nThe customer authorizes the ACH payment.\nThis includes obtaining obtain NACHA-compliant authorization.\nNACHA (National Automated Clearing House Association) is the organization that governs the ACH payment network in the United States.\nIt sets the rules and standards for ACH payments.\n\nThe customer provides the SEC (standard entry class) code for the payment method.\nThis establishes the form of payment.\nIt can be one of the following:\n* Online form (SEC code WEB)\n* Signed authorization (SEC code PPD)\n* Phone authorization (SEC code TEL)\n* Business payment (SEC code CCD)\n\nAnd their personal information:\n* Name\n* Their bank's routing number\n* Their bank's account number and account type\n* Authorization confirmation\n\n**Creating the Payment**
\nThe method can include either a credit or debit transaction:
\n`POST /pay-api/v1/transactions/ach/payment/credit`
\n`POST /pay-api/v1/transactions/ach/payment`\n\n**Submitting the Payment**
\nCreating the ACH (automated clearing house) transaction also submits the request for processing.\n\nAurora aggregates transactions and sends them to the ODFI (originating bank) in an ACH (automated clearing house) transaction batch.\nACH (automated clearing house) transactions are typically not processed individually but rather in as a batch of transactions.\nThat processing is done by the ACH network and batches may take up to two days to clear.\nTherefore, there may be a delay in processing ACH (automated clearing house) transaction requests.\nAn individual ACH (automated clearing house) transaction may be requested for same day processing.\nSettlement in those cases may occur within hours.\nCheck with the originating bank for specific policies and fees.\n\n**Statusing the Payment**
\nIndividual requests will always have an available status that can be checked.\nThese will be noted with the Aurora transaction creator type identifier.\n\nA status check may be submitted at any time.\nCheck the response field `status` or `statusId`.
\n`POST {{baseURL}}/pay-api/v1/transactions/{{transactionId}}`\n\nA webhook can also be used. \nA webhook allows one system to automatically send real-time data to another system when a specific event happens.\nThis is an alternative to manually polling the request.\nInstead, the webhook can be set to check the status of an ACH (automated clearing house) transaction.\nWhen the status changes, or reaches a specified status, such as `settled`, a notification can be sent to the customer.\n\n**Holding or Cancelling the Payment**
\nAfter the ACH (automated clearing house) transaction request has been successfully submitted, the transaction by the put on hold or cancelled.\nA transaction on hold means the request will not be processed.\nThat transaction must either be released to continue processing or cancelled.
\n`POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/hold`
\n`POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/unhold`\n\nA transaction that is cancelled will be withdrawn from further processing.\nAn ACH (automated clearing house) transaction request cannot be cancelled after it has been submitted to the ACH network.\nThis is indicated by it's `pending` status.
\n`POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/void`\n\n**Settling the Payment**
\nIf the ACH (automated clearing house) transaction request is successful, it returns with a status of `settled`.\nThe merchant receives funds in their settlement account.\nThe ACH (automated clearing house) transaction is completed.\n\n**Unsuccessfully Completing the Payment**
\nBanks can reject the payment with ACH return codes.\nCheck the ACH return code for the specific reason.\n\n**Refunding the Payment**
\nRefunds may be issued.\nThe ACH (automated clearing house) transaction request must have successfully been resolved and settled.
\n`POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/refund`\n" }, { "name": "Configurations" }, { "name": "Customers" }, { "name": "Devices" }, { "name": "MerchantApiTokens" }, { "name": "SettlementBatches" }, { "name": "Transactions", "description": "The Transactions endpoint group is the fundamental means of managing purchases and refunds.\nTransactions in general are separated into two divisions: **ACH transactions** and **cards transactions**.\n\n**ACH transactions** are payments processed through the ACH (automated clearing house) network.\nThese are direct bank-to-bank transfers such as debits and credits.\nThese transactions are typically processed in batches and settle or close within one to two business days.\n\nTo complete an ACH (automated clearing house) transaction, see ACH Transactions.\n\n**Card transactions** are payments processed using a credit or debit card.\nThese are processed through a card network such as Visa or Mastercard, among others.\nCard transaction operations support initiating the transaction, retrieving transaction details,\nand monitoring transaction status throughout processing.\nThis processing has additional steps, such as verifying available funds,\npossibly declining the transaction request, holding the funds, and finally settling the request.\n\nCard transactions are separated into two operations: **One-step operations** and **two-step operations**.\n\n**One-step operations** are transactions that authorizes and captures the transaction in a single request.\nThis allows processing a payment in one step or action by both approving the card and immediately completing the transaction.\nThis is a common retail situation when the purchase price is finalized and known at the moment of the sale.\n\n**Two-step operations** are transactions that authorize and capture the transaction in separate requests.\nCommon situations for this are:\n* A restaurant or hospitality situation.\nThe initial bill is known and a tip is added later.\nThe initial bill authorized and the funds held for a short while.\nAfter the tip is added, the transaction is completed.\n* An e-commerce or delayed fulfillment situation.\nThe purchase price is known but the customer order has a delay for fulfilment\nThe purchase price is authorized but the funds are put on hold.\nThe transaction is completed when the item is shipped.\n\n### One-Step Operations Workflow\nThe following procedure is for completing a one-step operation.\n\nAuthenticate
\nEnsure a valid and current API token is available.\nThis is generated from the partner or merchant API key.\nThe API token is short-lived.\nThe API token may be generated anew for the endpoint call, can use an previously generated API token that is still valid, or is using the refresh token.\n\nSubmit a Payment Transaction
\nUse the following endpoint to initiate or submit the payment transaction.\nThis endpoint combines authorization and capturing of a card transaction into one step.
\n`POST {{baseURL}}/pay-api/v1/transactions/sale`
\nThis is an example of the minimal request body:
\n```json{\n \"currencyId\": 1,\n \"expirationMonth\": 12,\n \"amount\": 642.99,\n \"accountNumber\": \"4000007640000003\",\n \"expirationYear\": 2028\n}\n```\n\nThis is an example of the return body, with the field `transactionId` noted.\nThis field references the transaction for subsequent endpoints, if needed.
\n```json{\n ...\n \"transactionId\": \"69c71dd2-36c7-4b57-9467-3a03b171f741\",\n ...\n}\n```\nAutomatic Processing
\nAurora receives the payment data from the endpoint.\nIt routes the transaction to the processing center.\nThe processor communicates with the customer’s bank for approval or denial. \nIt then relays the response back to the merchant site.\n\nThe client's app gets back the transaction result.\nThis includes whether it was approved or declined.\nThe app handles either case directly.\n\n### Two-Step Operations Workflow\nThe following procedure is for completing a two-step operation.\n\nAuthenticate
\nEnsure a valid and current API token is available.\nThis is generated from the partner or merchant API key.\nThe API token is short-lived.\nThe API token may be generated anew for the endpoint call, can use an previously generated API token that is still valid, or is using the refresh token.\n\nAuthorize
\nUse the following endpoint to authorize for the payment transaction.\nAuthorizing a payment transaction, or request, confirms that the payment method is valid.\nIf payment method is valid, it reserves, or puts a hold on, the funds.\nIt does not actually move funds yet.\nThe transaction can be rejected if the payment method is invalid and/or the requested funds are not available.\n\nThis endpoint attempts to authorize the transaction:
\n`POST /pay-api/v1/transactions/auth`
\nThis is an example of the minimal request body:
\n```json\n{\n \"accountNumber\": \"4111111111111111\",\n \"amount\": 129.95,\n \"currencyId\": 1,\n \"expirationMonth\": 12,\n \"expirationYear\": 2028\n}\n```\nThis is an example of the return body, with the field `transactionId` noted.\nThis field references the transaction for subsequent endpoints, if needed.
\n```json{\n ...\n \"transactionId\": \"2f41c881-7337-45b9-8dba-fa5d9711e2b1\",\n ...\n}\n```\n\nAdd Optional Tip Amount
\nAn optional tip amount may be added.\nThis amount is not necessarily included on the original base amount from the initial authorization.\nThe tip amount is updated on the authorized transaction before the final capture.\nThis endpoint adds a tip:
\n`POST {{baseURL}}/pay-api/v1/transactions/tip-adjustment`
\nThis is an example of the request body.\nThe `transactionId` is the `transactionId` from the Authorization endpoint above:
\n```json\n{\n \"transactionId\": \"2f41c881-7337-45b9-8dba-fa5d9711e2b1\",\n \"tipAmount\": 10\n}\n```\n\nCapture
\nCapture completes a previously authorized transaction and initiates the transfer of funds.\nThis endpoint captures the authorized funds and completes the transaction:
\n`POST {{baseURL}}/pay-api/v1/transactions/capture`\n\nThis is an example of the minimal request body.\nFor example, if the original authorization amount was $200 and a\ntip-adjustment of $10 was later added with `POST /pay-api/v1/transactions/tip-adjustment`,\nthe `amount` here must be 210.\nAny other value will fail the call.\nThe `transactionId` is the `transactionId` from the Authorization endpoint above.
\n```json\n{\n \"amount\": \"210\",\n \"transactionId\": \"2f41c881-7337-45b9-8dba-fa5d9711e2b1\"\n}\n```\n" }, { "name": "TransactionSettings" }, { "name": "Subscription", "description": "A subscription is a recurring payment.\nThe client authorizes a transaction at regular intervals, such as weekly, monthly, or annually.\n\nExamples include mortgages, leases, streaming media payments, and Insurance premiums.\nPayments represent:\n* **Recurring billing**. The transaction happens automatically on a set schedule without the client having to re-enter payment details.\n* **Pre-authorization**. The customer approves transactions for future charges.\n* **Fixed or variable amounts**. The transaction can be the same every cycle, such as for a streaming service or vary based on usage, such as a utility bill.\n* **Stored payment**. The transaction uses a vault or stored payment method.\nPayment methods include a credit or debit card (only sale transactions) and ACH electronic check.\n\nInstallments may be specified as a combination of:\n* Days of the month, such as the 1st, 15th, or 30th.\n* Weeks of the month, such as the first week or the third week.\n* Months, such as 1 (January), 3 (March), or 12 (December)\n\nInstallments may either specify:\n* A set number of payments, such as 36, 60, 360.\nFor example, this may be for a mortgage or car payment.\n* Be indefinite and not specify an end date or a number of payments.\nFor example, this may be for a streaming media subscription.\n\nThe following endpoints are available:\n\n`GET /sub-api/v1/subscriptions`
\nLists subscriptions associated with the merchant.\n\n`GET /sub-api/v1/subscriptions/{{subscriptionId}}`
\nLists subscriptions associated with a specified subscription identifier.\n\n`POST /sub-api/v1/subscriptions`
\nCreates a subscription.\n\n`GET /sub-api/v1/subscriptions/{{subscriptionId}}/payments`
\nLists the payment history from a specified subscription identifier.\n\n`PUT /sub-api/v1/subscriptions/{{subscriptionId}}/terminate`
\nTerminate or cancels the specified subscription identifier.\n" }, { "name": "PosTransactions" }, { "name": "Terminals", "description": "List of endpoints to interact with terminals from the POS integration perspective.\n" }, { "name": "Categories" }, { "name": "Invoices" }, { "name": "Invoices Settings" }, { "name": "LineItems" }, { "name": "PaymentSessions" }, { "name": "Ping", "description": "Controller for handling ping requests." }, { "name": "QuickPayments", "description": "A quick payment, also called a one-time payment, refers to a fast, simplified payment method.\nIt is designed to complete a transaction with minimal user input and minimal processing time.\n\nThe payments may be one of two types:\n* **One-time payment**.
\nA one-time payment can be used only once and then it expires.\nThis can be used for cases like purchases or fee payments.\nIt is limited to only one person.\n* **Reusable payment**.
\nA reusable payment can be used multiple times and remains active after each use.\nThis can be used for cases like donations or event registration fees.\nIt is not limited to the same person each time.\n\nThe following is an example workflow for a one-time payment.
\nCreate the payment link:
\n`POST /pay-int-api/quick-payments/one-time`\n\nActivate the payment link:
\n`POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate`\n\nSend link to customer:
\n`POST /pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification`\n\nThe link remains valid until one of the following occurs:\n* The customer completes the payment.\n* The link is manually deactivated.\n* The link's time limit expires.\n\nThe link can be manually deactivated any time after it is created but before the customer completes payment:
\n`POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`\n" } ], "paths": { "/pay-api/v1/transactions/ach/payment/credit": { "post": { "tags": [ "ACH Transactions" ], "summary": "Creates an ACH Credit Payment", "description": "POST {{baseURL}}/pay-api/v1/transactions/ach/payment/credit\n\nThis endpoint creates a credit ACH (automated clearing house) transaction to transfer funds from the merchant to the customer. \n\nIt specifically transfers money from the sender’s bank account to the recipient’s account.\nThis is used in credit operations, such as payouts or refunds without reference.\nA refund without reference (also called unreferenced refunds) are refunds issued without linking it back to original receipt.\n\n
\nThe following is an example of the minimum call.\n\nThe endpoint call:\n```html\nPOST {{baseURL}}/pay-api/v1/transactions/ach/payment/credit\n```\nThe endpoint request body:\n```json\n{\n \"paymentProcessorId\": \"4acafddf-68a7-4aeb-9778-87582d121307\",\n \"paymentMethodId\": \"55419052-670c-497b-a53d-43d21ef45e14\",\n \"amount\": 123.45,\n \"secCode\": 3,\n \"RequesterIpAddress\": \"2001:0db8:85a3:0000:0000:8a2e:0370:7334\"\n}\n```\n
\n\nSee Also:
\nTo create an ACH debit transaction, see `POST /pay-api/v1/transactions/ach/payment`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.CreateAchRefundRequest" }, "examples": { "Credit (Refund / Payout)": { "value": { "paymentProcessorId": "7a913ba9-724b-4020-8ef1-d3375291f59e", "paymentMethodId": null, "customerId": null, "requesterIPaddress": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "amount": 123.45, "isFasterProcessing": true, "routingNumber": "026009593", "accountNumber": "9876543210", "taxId": null, "accountHolderType": 1, "accountType": 1, "billingAddress": { "city": "Phoenix", "countryId": 1, "line1": "7429 Desert Mirage Lane", "line2": null, "postalCode": "85099", "stateName": "AZ", "stateId": 4 }, "shippingAddress": { "city": "Phoenix", "countryId": 1, "line1": "7429 Desert Mirage Lane", "line2": "Office 7", "postalCode": "85099", "stateName": "AZ", "stateId": 4 }, "contactInfo": { "firstName": "John", "lastName": "Smith", "companyName": "Aurora", "email": "j.smith29f@example.com", "mobilePhoneNumber": null, "smsNotification": null }, "secCode": 3 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchPaymentResponse" }, "examples": { "Refund ACH Payment": { "description": "Valid parameters. Approved", "value": { "processedAmount": 0, "transactionId": "5758166f-3608-4625-8dd6-04124a633581", "typeId": 12, "type": "AchRefund", "statusId": 23, "status": "ChargedBack", "responseDescription": "Command Successful. Approved.", "responseCode": "000" } }, "Create ACH Payment": { "description": "Invalid parameters. Error.", "value": { "processedAmount": 0, "transactionId": "0713a65a-6bab-4ae2-b687-5487f7749def", "typeId": 11, "type": "AchDebit", "statusId": 21, "status": "Scheduled", "responseDescription": "Invalid Gateway Credentials", "responseCode": "100" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/pay-api/v1/transactions/ach/payment": { "post": { "tags": [ "ACH Transactions" ], "summary": "Creates an ACH Debit Payment", "description": "POST {{baseURL}}/pay-api/v1/transactions/ach/payment\n\nThis endpoint creates an ACH (automated clearing house) transaction to transfer funds from the customer to the merchant.\n\nIt specifically transfers money from the customer’s bank account to the merchant’s account.\n\n
\nThe following is an example of the minimum call.\n\nThe endpoint call:\n```html\nPOST {{baseURL}}/pay-api/v1/transactions/ach/payment\n```\nThe endpoint request body:\n```json\n{\n \"paymentProcessorId\": \"7a913ba9-724b-4020-8ef1-d3375291f59e\",\n \"RequesterIpAddress\": \"2001:0db8:85a3:0000:0000:8a2e:0370:7334\",\n \"amount\": 54.87,\n \"secCode\": 1,\n \"accountHolderType\": 1,\n \"accountNumber\": \"123456789\",\n \"routingNumber\": \"123123123\",\n \"accountType\": 1,\n \"billingAddress\": \n {\n \"city\": \"New York\",\n \"countryId\": 1,\n \"line1\": \"1234 Hudson Avenue\",\n \"postalCode\": \"10001\",\n \"stateName\": NY,\n \"stateId\": 25\n },\n \"contactInfo\": \n {\n \"firstName\": \"Alex\",\n \"lastName\": \"Morgan\",\n \"companyName\": \"Positive\",\n \"email\": \"a.morgan@example.com\",\n \"mobilePhoneNumber\": '+14155554618'\n }\n}\n```\n
\n\nSee Also:
\nTo create an ACH credit transaction, see `GET /pay-api/v1/transactions/ach/payment/credit`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.CreateAchPaymentRequest" }, "examples": { "Debit (Sale)": { "value": { "paymentProcessorId": "b1390f80-724d-40e6-8790-80c5c7634ee0", "paymentMethodId": null, "customerId": null, "requesterIPaddress": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "amount": 123.45, "isFasterProcessing": true, "routingNumber": "123123123", "accountNumber": "222222222", "taxId": null, "accountHolderType": 1, "accountType": 1, "billingAddress": { "city": "Phoenix", "countryId": 1, "line1": "7429 Desert Mirage Lane", "line2": null, "postalCode": "85099", "stateName": "AZ", "stateId": 4 }, "shippingAddress": { "city": "Phoenix", "countryId": 1, "line1": "7429 Desert Mirage Lane", "line2": "Office 7", "postalCode": "85099", "stateName": "AZ", "stateId": 4 }, "contactInfo": { "firstName": "John", "lastName": "Smith", "companyName": "Aurora", "email": "j.smith29f@example.com", "mobilePhoneNumber": null, "smsNotification": null }, "secCode": 1 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchPaymentResponse" }, "examples": { "Create ACH Payment": { "description": "Valid parameters. Approved", "value": { "processedAmount": 0, "transactionId": "b3edb5a8-e235-4ef7-9003-2343b43c5c41", "typeId": 11, "type": "AchDebit", "statusId": 21, "status": "Scheduled", "responseDescription": "Command Successful. Approved.", "responseCode": "000" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/ach/{transactionId}/void": { "post": { "tags": [ "ACH Transactions" ], "summary": "Voids an ACH Transaction", "description": "POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/void\n\nThis endpoint voids or cancels an ACH (automated clearing house) transaction payment before it is processed or submitted to the ACH network.\n\nAfter the transaction payment is submitted to the ACH network, it cannot be voided.\n\nSee Also:
\nTo refund a settled ACH transaction, see `POST /pay-api/v1/transactions/ach/{{transactionId}}/refund`
\nTo place a hold on an ACH transaction, see `POST /pay-api/v1/transactions/ach/{{transactionId}}/hold`\n", "parameters": [ { "$ref": "#/components/parameters/transaction_id" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchPaymentResponse" }, "examples": { "Refund ACH Payment": { "description": "Valid parameters. Approved", "value": { "processedAmount": 0, "transactionId": "4300da2c-8a00-48c2-bb9b-d84cf6313b7c", "typeId": 15, "type": "AchDebit", "statusId": 22, "status": "Cancelled", "responseDescription": "Command Successful. Approved.", "responseCode": "000" } }, "Create ACH Payment": { "description": "Invalid parameters. Error.", "value": { "processedAmount": 0, "transactionId": "f3a3f17c-40cc-4979-a539-c208332a2579", "typeId": 11, "type": "AchDebit", "statusId": 21, "status": "Scheduled", "responseDescription": "Invalid Gateway Credentials", "responseCode": "100" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/ach/{transactionId}/refund": { "post": { "tags": [ "v" ], "summary": "Refunds an ACH Transaction", "description": "POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/refund\n\nThis endpoint refunds an ACH (automated clearing house) transaction payment that has already been settled.\n\nIt sends money back to the original payer after the ACH payment has completed.\n\nSee Also:
\nTo void or cancel an ACH transaction that has not been settled, see `POST /pay-api/v1/transactions/ach/{{transactionId}}/void`
\nTo place a hold on an ACH transaction, see `POST /pay-api/v1/transactions/ach/{{transactionId}}/hold`\n", "parameters": [ { "$ref": "#/components/parameters/transaction_id" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchPaymentResponse" }, "examples": { "Refund ACH Payment": { "description": "Valid parameters. Approved", "value": { "processedAmount": 0, "transactionId": "b4453ccb-be79-4a7c-b50d-96c52c1bfadf", "typeId": 12, "type": "AchRefund", "statusId": 23, "status": "ChargedBack", "responseDescription": "Command Successful. Approved.", "responseCode": "000" } }, "Create ACH Payment": { "description": "Invalid parameters. Error.", "value": { "processedAmount": 0, "transactionId": "4d33e47b-176e-475f-bf10-9f14e3668a48", "typeId": 11, "type": "AchDebit", "statusId": 21, "status": "Scheduled", "responseDescription": "Invalid Gateway Credentials", "responseCode": "100" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/ach/{transactionId}/hold": { "post": { "tags": [ "ACH Transactions" ], "summary": "Places a Hold on an ACH Transaction", "description": "POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/hold\n\nThis endpoint places an ACH (automated clearing house) transaction payment on hold.\n\nThis is temporarily paused in processing.\nIt is prevented from being processed or submitted to the ACH network until it is released.\n\nSee Also:
\nTo release an ACH transaction payment hold, see `POST /pay-api/v1/transactions/ach/{{transactionId}}/unhold`.
\nTo void or cancel an ACH transaction that has not been settled, see `POST /pay-api/v1/transactions/ach/{{transactionId}}/void`\n", "parameters": [ { "$ref": "#/components/parameters/transaction_id" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchResponse" }, "example": { "transactionId": "857757f3-9d2b-4204-abe6-c9d95bd41ec0", "typeId": 13, "type": "AchHold", "statusId": 26, "status": "Held", "responseDescription": null, "responseCode": null } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/ach/{transactionId}/unhold": { "post": { "tags": [ "ACH Transactions" ], "summary": "Removes a Hold from an ACH Transaction", "operationId": "payapi_v1_transactions_ach_id_unhold", "description": "POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/unhold\n\nThis endpoint removes an ACH (automated clearing house) transaction payment that is on hold.\n\nThe ACH transaction resumes being processed and is submitted to the ACH network.\n\nSee Also:
\nTo place an ACH transaction payment on hold, see `POST //pay-api/v1/transactions/ach/{{transactionId}}/hold`\n", "parameters": [ { "$ref": "#/components/parameters/transaction_id" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchResponse" }, "example": { "transactionId": "65ab0547-8891-4719-956b-39fecaf41037", "typeId": 14, "type": "AchUnHold", "statusId": 21, "status": "Scheduled", "responseDescription": null, "responseCode": null } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/configurations/payments": { "get": { "tags": [ "Configurations" ], "summary": "Gets payment configurations", "description": "GET {{baseURL}}/pay-api/v1/configurations/payments\n\nThis endpoint returns a list of payment configurations.\n", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto" }, "example": { "zeroCostProcessingOptionId": 1, "zeroCostProcessingOption": null, "defaultTipsOptions": null, "defaultSurchargeRate": null, "defaultCashDiscountRate": null, "defaultDualPricingRate": null, "availableCurrencies": [ { "id": 1, "name": "USD" } ], "availableCardTypes": [ { "id": 0, "name": "Unknown" }, { "id": 1, "name": "Visa" }, { "id": 2, "name": "MasterCard" }, { "id": 3, "name": "AmericanExpress" }, { "id": 4, "name": "DinersClub" }, { "id": 5, "name": "Discover" }, { "id": 6, "name": "JCB" } ], "availableTransactionTypes": [ { "id": 2, "name": "Sale" }, { "id": 3, "name": "Capture" }, { "id": 5, "name": "Refund" }, { "id": 4, "name": "Void" }, { "id": 6, "name": "CardAuthentication" }, { "id": 7, "name": "RefundWORef" }, { "id": 8, "name": "TipAdjustment" } ], "isTipsEnabled": true, "availablePaymentProcessors": [ { "id": "9e8d7c6b-5a4f-4e3d-b2c1-0a9b8c7d6e14", "name": "TSYS", "isDefault": true, "typeId": 0, "type": null, "settlementBatchTimeSlots": [ { "hours": 2, "minutes": 10, "timezoneName": "America/New_York" } ] } ], "avs": { "isEnabled": true, "profileId": 1, "profile": "Strict" }, "isCustomerCardSavingByTerminalEnabled": false, "companyName": null, "mccCode": null, "mccCodeDescription": null, "currencyId": 1, "currencyIsoCode": null, "maxTransactionAmount": null } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/pay-api/v1/configurations/contact-infos": { "get": { "tags": [ "Configurations" ], "summary": "Gets contact information", "description": "GET {{baseURL}}/pay-api/v1/configurations/contact-infos\n\nThis endpoint returns the merchant's detailed information.\n\nThe list includes contact information records for the merchant, such as address, phone number, and credit cards.\nThis information can be integrated with other endpoints of the application, such as the invoice creation functionality.\n", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Configurations.MerchantContactInfos.GetMerchantContactInfosResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/pay-api/v1/customers": { "post": { "tags": [ "Customers" ], "summary": "Creates customer", "operationId": "pay_api_v1_customers", "description": "POST {{baseURL}}/pay-api/v1/customers\n\nThis endpoint creates a customer.\n\nThe return field `id` is the customerId, also referred to as the *customer identifier*.\nUse this value to specify this customer in other endpoints.\n\nSee Also:
\nTo search for a customer, see `GET /pay-api/v1/customers`
\nTo find a customer by identifier, see `GET /pay-api/v1/customers/{{customerId}}`
\nTo update a customer's information, see `PUT /pay-api/v1/customers/{{customerId}}`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.Create.CreateCustomerRequest" }, "example": { "firstName": "George", "lastName": "Black", "companyName": "Company Name", "email": "company@example.com", "mobilePhoneNumber": "+14155554618", "isMobileNumberSmsNotificationsEnabled": true, "useBillingAsShippingAddress": false, "billingAddress": { "addressLine1": "7429 Desert Mirage Lane", "addressLine2": "Office 7", "city": "Phoenix", "zip": "60612-0001", "stateName": null, "stateId": 1, "countryId": 1 }, "shippingAddress": { "addressLine1": "7429 Desert Mirage Lane", "addressLine2": "Office 7", "city": "Phoenix", "zip": "60612-0001", "stateName": null, "stateId": 1, "countryId": 1 }, "paymentMethodsCards": [ { "name": "Payment_method1", "pan": "444466666655555", "expirationMonth": 1, "expirationYear": 24, "securityCode": "345" }, { "name": "Payment_method2", "pan": "1234567890123", "expirationMonth": 4, "expirationYear": 25, "securityCode": null } ], "paymentMethodsAchAccounts": null } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.Create.CreateCustomerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } }, "get": { "tags": [ "Customers" ], "summary": "Searches customers", "operationId": "pay_api_v1_search_customers", "description": "GET {{baseURL}}/pay-api/v1/customers\n\nThis endpoint searches the partner's customers.\n\nThe search can specify filters to better target intended customers.\n\nSee Also:
\nTo find a customer by identifier, see `GET /pay-api/v1/customers/{{customerId}}`
\nTo create a customer, see `POST /pay-api/v1/customers`
\nTo delete a customer, see `DELETE /pay-api/v1/customers/{{customerId}}`
\nTo update a customer's information, see `PUT /pay-api/v1/customers/{{customerId}}`\n\n\n Navigation: \n [ Headers ]\n [ Query ]\n [ Request body ]\n [ Response body ]\n [ Response codes ]\n\n\n", "parameters": [ { "name": "search", "in": "query", "description": "Specifies the search string.\n\nThe following are fields commonly searched on, but not limited to this list.\nThe search string may appear in any of these fields.\nThe field does not have to be specified.\nHowever, if the results are to be sorted, that sort field must be specified. \nUse the field `orderby` to specify the sort field.
\n\nfirstName
\nlastName
\ncompanyName
\nemail
\nmobilePhoneNumber
\nid
\ncreatedOn
\nlastTransactionDate
\ncontactName\n\nExample: Conners Electric\n", "schema": { "type": "string" } }, { "name": "customerIds", "in": "query", "description": "Specifies a single customer's identifier.\n", "schema": { "type": "string", "format": "uuid", "example": "c4b210e9-be39-4ebc-8195-0c422de87f90" } }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "dateFrom", "in": "query", "description": "Specifies returning items on or after this date (in an ISO 8601 date-time format).\n\nIf `dateFrom` only is specified, the search returns all available items from the `dateFrom` value to the present.\nThe fields `dateFrom` and `dateTo` may be used together to create an exclusive range.\nWe recommend creating an exclusive range to avoid a potentially excessive number of returns.\n\nExamples:
\n2025-01-27
\n2025-01-27T12:05:54.322587Z
\n2025-01-27T12:05:54.322587+05:30
\n2025-01-27T12:05:54.322587-06:00\n", "schema": { "type": "string", "format": "date-time", "example": "2025-01-27T12:05:54.322587+05:30" } }, { "name": "dateTo", "in": "query", "description": "Specifies returning items on or to this date (in an ISO 8601 date-time format).\n\nIf `dateTo` only is specified, the search returns all available items up to the `dateTo` value.\nThe fields `dateFrom` and `dateTo` may be used together to create an exclusive range.\nWe recommend creating an exclusive range to avoid a potentially excessive number of returns.\n\nExamples:
\n2026-01-27
\n2026-01-27T12:05:54.322587Z
\n2026-01-27T12:05:54.322587+05:30
\n2026-01-27T12:05:54.322587-06:00\n", "schema": { "type": "string", "format": "date-time", "example": "2025-01-27T12:05:54.322587+05:30" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" } ], "responses": { "200": { "description": "OK ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.GetPage.GetCustomerPageResponse" } } } }, "400": { "description": "Bad Request ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/customers/{customerId}": { "get": { "tags": [ "Customers" ], "summary": "Gets customer by ID", "operationId": "pay_api_v1_get_customers_{customerId}", "description": "GET {{baseURL}}/pay-api/v1/customers/{{customerId}}\n\nThis endpoint searches for the specified customer.\n\nSee Also:
\nTo search for a customer, see `GET /pay-api/v1/customers`
\nTo update a customer's information, see `PUT /pay-api/v1/customers/{{customerId}}`
\nTo create a customer, see `POST /pay-api/v1/customers`
\nTo delete a customer, see `DELETE /pay-api/v1/customers/{{customerId}}`\n", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "Specifies the customerId, also known as the customer identifier.\n\nExample: c4b210e9-be39-4ebc-8195-0c422de87f90\n", "schema": { "type": "string", "format": "uuid", "example": "c4b210e9-be39-4ebc-8195-0c422de87f90" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.Get.GetCustomerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } }, "put": { "tags": [ "Customers" ], "summary": "Updates customer", "operationId": "pay_api_v1_update_customers_{customerId}", "description": "PUT {{baseURL}}/pay-api/v1/customers/{{customerId}}\n\nThis endpoint updates the specified customer's information.\n\nCare must be taken to complete all the fields with the existing information.\n\nSee Also:
\nTo search for a customer, see `GET /pay-api/v1/customers`
\nTo find a customer by identifier, see `GET /pay-api/v1/customers/{{customerId}}`
\nTo create a customer, see `POST /pay-api/v1/customers`
\nTo delete a customer, see `DELETE /pay-api/v1/customers/{{customerId}}`\n", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "Specifies the customerId, also known as the customer identifier.\n\nExample: c4b210e9-be39-4ebc-8195-0c422de87f90\n", "schema": { "type": "string", "format": "uuid", "example": "c4b210e9-be39-4ebc-8195-0c422de87f90" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.Update.UpdateCustomerRequest" }, "example": { "firstName": "Alexandro", "lastName": "Peppared", "companyName": "Company Name", "email": "Company@mail.com", "mobilePhoneNumber": "+14155554618", "isMobileNumberSmsNotificationsEnabled": true, "useBillingAsShippingAddress": false, "billingAddress": { "addressLine1": "7429 Desert Mirage Lane", "addressLine2": "Office 7", "city": "Phoenix", "zip": "60612-0001", "stateName": null, "stateId": 1, "countryId": 1 }, "shippingAddress": { "addressLine1": "7429 Desert Mirage Lane", "addressLine2": "Office 7", "city": "Phoenix", "zip": "60612-0001", "stateName": null, "stateId": 1, "countryId": 1 } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } }, "delete": { "tags": [ "Customers" ], "summary": "Deletes customer", "operationId": "pay_api_v1_delete_customers_{customerId}", "description": "DELETE {{baseURL}}/pay-api/v1/customers/{{customerId}}\n\nThis endpoint deletes the specified customer.\n\n\nSee Also:
\nTo search for a customer, see `GET /pay-api/v1/customers`
\nTo update a customer's information, see `PUT /pay-api/v1/customers/{{customerId}}`
\nTo create a customer, see `POST /pay-api/v1/customers`
\nTo delete a customer, see `DELETE /pay-api/v1/customers/{{customerId}}`\n", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "Specifies the customerId, also known as the customer identifier.\n\nExample: c4b210e9-be39-4ebc-8195-0c422de87f90\n", "schema": { "type": "string", "format": "uuid", "example": "c4b210e9-be39-4ebc-8195-0c422de87f90" } } ], "responses": { "200": { "description": "OK. The customer was successfully deleted." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/customers/{customerId}/payment-methods/cards": { "post": { "tags": [ "Customers" ], "summary": "Adds payment method for cards", "operationId": "pay_api_v1_customers_{customerId}_payment_methods_cards", "description": "POST {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods/cards\n", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "Specifies the customerId, also known as the customer identifier.\n\nExample: c4b210e9-be39-4ebc-8195-0c422de87f90\n", "schema": { "type": "string", "format": "uuid", "example": "c4b210e9-be39-4ebc-8195-0c422de87f90" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Create.CreatePaymentMethodRequest" }, "example": { "name": "Payment_method", "pan": "444466666655555", "expirationMonth": 1, "expirationYear": 24, "securityCode": "345" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Create.CreatePaymentMethodResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/customers/{customerId}/payment-methods/ach": { "post": { "tags": [ "Customers" ], "summary": "Adds payment method for EFT/ACH", "operationId": "pay_api_v1_customers_{customerId}_payment_methods_ach", "description": "POST {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods/ach\n\nThis endpoint adds a payment method for EFT or ACH (automated clearing house) transactions.\n\n
\nThe following is an example of the minimum call.\n\nThe endpoint call, with a fictitious customerId:\n```html\nPOST {{baseURL}}/pay-api/v1/customers/019d2135-be3f-7310-8e03-0bece14c231b/payment-methods/ach\n```\nThe endpoint request body:\n```json\n{\n \"accountNumber\": \"123456789\",\n \"routingNumber\": \"123123123\",\n \"accountType\": 1,\n \"accountHolderType\": 1\n}\n```\nThe return value is the paymentMethodId (payment method identifier).\n```json\n{\n \"id\": \"ecb05a38-990a-46fb-9a37-b0359164d918\"\n}\n```\n
\n\nSee Also:
\nTo add a payment method for other transaction types, see `GET /pay-api/v1/customers/{{customerId}}/payment-methods`
\nTo update a payment method, see `PUT /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}`
\nTo delete a payment method, see `DELETE /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}`
\nTo set a default payment method, see `PUT /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}/make-default`
\n", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "Specifies a single customer's identifier.\n", "schema": { "type": "string", "format": "uuid", "example": "c4b210e9-be39-4ebc-8195-0c422de87f90" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Ach.Create.CreateAchAccountPaymentMethodRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Create.CreatePaymentMethodResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with\ntype='.DataAccess.Entities.Entity'\n", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/customers/{customerId}/payment-methods": { "get": { "tags": [ "Customers" ], "summary": "Gets customer's payment methods", "operationId": "pay_api_v1_customers_{customerId}_payment_methods", "description": "GET {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods\n\nThis endpoint searches the partner's customer's payment methods.\n", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "Specifies a customer's identifier.\n", "schema": { "type": "string", "format": "uuid", "example": "c4b210e9-be39-4ebc-8195-0c422de87f90" } }, { "name": "search", "in": "query", "description": "Specifies the search string.\n\nThe following are fields commonly searched on, but not limited to this list.\nThe search string may appear in any of these fields.\nThe field does not have to be specified.\nHowever, if the results are to be sorted, that sort field must be specified. \nUse the field `orderby` to specify the sort field.
\n\nfirstName
\nlastName
\ncompanyName
\nemail
\nmobilePhoneNumber
\nid
\ncreatedOn
\nlastTransactionDate
\ncontactName\n\nExample: Conners Electric\n", "schema": { "type": "string", "example": "Conners Electric" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "dateFrom", "in": "query", "description": "Specifies returning items on or after this date (in an ISO 8601 date-time UTC or time zone offset format).\n\nIf `dateFrom` only is specified, the search returns all available items from the `dateFrom` value to the present.\nThe fields `dateFrom` and `dateTo` may be used together to create an exclusive range.\nWe recommend creating an exclusive range to avoid a potentially excessive number of returns.\n\nExamples:
\n2025-01-27
\n2025-01-27T12:05:54.322587Z
\n2025-01-27T12:05:54.322587+05:30
\n2026-01-27T12:05:54.322587-06:00\n", "schema": { "type": "string", "format": "date-time", "example": "2025-01-27T12:05:54.322587+05:30" } }, { "name": "dateTo", "in": "query", "description": "Specifies returning items on or to this date (in an ISO 8601 date-time UTC or time zone offset format).\n\nIf `dateTo` only is specified, the search returns all available items up to the `dateTo` value.\nThe fields `dateFrom` and `dateTo` may be used together to create an exclusive range.\nWe recommend creating an exclusive range to avoid a potentially excessive number of returns.\n\nExamples:
\n2026-01-27
\n2026-01-27T12:05:54.322587Z
\n2026-01-27T12:05:54.322587+05:30
\n2026-01-27T12:05:54.322587-06:00\n", "schema": { "type": "string", "format": "date-time", "example": "2025-01-27T12:05:54.322587+05:30" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts.Page.Contracts.PublicApi.Isv.Customers.PaymentMethods.GetCustomerPaymentMethods.GetCustomerPaymentMethodsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/customers/{customerId}/payment-methods/{paymentMethodId}": { "put": { "tags": [ "Customers" ], "summary": "Updates payment method", "operationId": "pay_api_v1_put_customers_{customerId}_payment_methods_{paymentMethodId}", "description": "PUT {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}\n\nThis endpoint updates the specified customer's payment method.\n\nOnly the payment method name may be changed with this endpoint.\nIf a different payment method type is required, a new payment method identifier must be created.\n\n\nCare must be taken to complete all the fields with the existing information.\n\n\nSee Also:
\nTo add a EFT or ACH payment method for EFT or ACH transactions, see `POST /pay-api/v1/customers/{{customerId}}/payment-methods/ach`
\nTo list a customer payment methods, see `GET /pay-api/v1/customers/{{customerId}}/payment-methods`
\nTo delete a payment method, see `DELETE /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}`
\nTo set a default payment method, see `PUT /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}/make-default`\n", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "Specifies the customerId, also known as the customer identifier.\n\nExample: c4b210e9-be39-4ebc-8195-0c422de87f90\n", "schema": { "type": "string", "format": "uuid", "example": "c4b210e9-be39-4ebc-8195-0c422de87f90" } }, { "name": "paymentMethodId", "in": "path", "required": true, "description": "Specifies the payment method identifier.\n", "schema": { "type": "string", "format": "uuid", "example": "46e5de89-a9f0-4d79-9350-b612bfa3c5ee" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Update.UpdatePaymentMethodRequest" }, "example": { "name": "Payment_Method" } } } }, "responses": { "200": { "description": "OK. The payment method was successfully updated." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with\ntype='.DataAccess.Entities.Entity'\n", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } }, "delete": { "tags": [ "Customers" ], "summary": "Deletes payment method", "operationId": "pay_api_v1_delete_customers_{customerId}_payment_methods_{paymentMethodId}", "description": "DELETE {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}\n\nThis endpoint deletes the specified payment method.\n\nSee Also:
\nTo add a EFT or ACH payment method for EFT or ACH transactions, see `POST /pay-api/v1/customers/{{customerId}}/payment-methods/ach`
\nTo add a payment method for other transaction types, see `GET /pay-api/v1/customers/{{customerId}}/payment-methods`
\nTo update a payment method, see `PUT /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}`\n", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "Specifies the customerId, also known as the customer identifier.\n\nExample: c4b210e9-be39-4ebc-8195-0c422de87f90\n", "schema": { "type": "string", "format": "uuid", "example": "c4b210e9-be39-4ebc-8195-0c422de87f90" } }, { "name": "paymentMethodId", "in": "path", "required": true, "description": "Specifies the payment method identifier.\n", "schema": { "type": "string", "format": "uuid", "example": "46e5de89-a9f0-4d79-9350-b612bfa3c5ee" } } ], "responses": { "200": { "description": "OK. The payment method was successfully deleted." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with\ntype='.DataAccess.Entities.Entity'\n", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/customers/{customerId}/payment-methods/{paymentMethodId}/make-default": { "put": { "tags": [ "Customers" ], "summary": "Make payment method default", "operationId": "pay_api_v1_customers_{customerId}_payment_methods_{paymentMethodId}_make_default", "description": "PUT {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}/make-default\n\nThis endpoint sets the specified payment method as the default.\n\nSee Also:
\nTo add a EFT or ACH payment method for EFT or ACH transactions, see `POST /pay-api/v1/customers/{{customerId}}/payment-methods/ach`
\nTo add a payment method for other transaction types, see `GET /pay-api/v1/customers/{{customerId}}/payment-methods`
\nTo update a payment method, see `PUT /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}`\n", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "Specifies the customerId, also known as the customer identifier.\n\nExample: c4b210e9-be39-4ebc-8195-0c422de87f90\n", "schema": { "type": "string", "format": "uuid", "example": "c4b210e9-be39-4ebc-8195-0c422de87f90" } }, { "name": "paymentMethodId", "in": "path", "required": true, "description": "Specifies the payment method identifier.\n", "schema": { "type": "string", "format": "uuid", "example": "46e5de89-a9f0-4d79-9350-b612bfa3c5ee" } } ], "responses": { "200": { "description": "OK. The payment method was successfully added as the default." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/devices": { "get": { "tags": [ "Devices" ], "summary": "Gets devices for the current merchant", "operationId": "pay_api_v1_get_devices", "description": "GET {{baseURL}}/pay-api/v1/devices\n", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.GetDevicesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } }, "post": { "tags": [ "Devices" ], "summary": "Creates or updates a device by ID for the current merchant.", "operationId": "pay_api_v1_create_devices", "description": "POST {{baseURL}}/pay-api/v1/devices\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.CreateOrUpdate.CreateOrUpdateDeviceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.CreateOrUpdate.CreateOrUpdateDeviceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/devices/{deviceId}": { "get": { "tags": [ "Devices" ], "summary": "Gets device by ID for the current merchant.", "operationId": "pay_api_v1_devices_{deviceId}", "description": "GET {{baseURL}}/pay-api/v1/devices/{{deviceId}}\n", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/devices/tap-to-pay/jwt": { "post": { "tags": [ "Devices" ], "summary": "Generates a Tap To Pay Jwt token by device id for the current merchant", "operationId": "pay_api_v1_devices_tap_to_pay_jwt", "description": "POST {{baseURL}}/pay-api/v1/devices/tap-to-pay/jwt\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.TapToPay.GenerateTapToPayJwtRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.TapToPay.GenerateTapToPayJwtResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/devices/{deviceId}/tap-to-pay/activate": { "post": { "tags": [ "Devices" ], "summary": "Activates Tap To Pay functionality for the specified device for the current merchant.", "operationId": "pay_api_v1_devices_{deviceId}_tap_to_pay_activate", "description": "POST {{baseURL}}/pay-api/v1/devices/{{deviceId}}/tap-to-pay/activate\n", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/merchants/tokens": { "get": { "tags": [ "Merchant API Keys" ], "summary": "Lists API Keys", "description": "GET {{baseURL}}/pay-api/v1/merchants/tokens\n\nThis endpoint lists API keys created for merchants under an affiliate account.\n\nThe query parameter filter may be used to further specify API keys to return.\n\nThis endpoint requires the Bearer token to be from the affiliates (ISV) API key.\nMerchant tokens are not accepted.\n", "parameters": [ { "name": "merchantId", "in": "query", "description": "Specifies the identifier of the merchant.\n", "schema": { "type": "string", "format": "uuid", "example": "46063d32-10fa-44cb-b118-20ddd085ce3f" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.GetMerchantApiTokensResponseDto" } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "tags": [ "Merchant API Keys" ], "summary": "Creates an API key for a merchant", "description": "POST {{baseURL}}/pay-api/v1/merchants/tokens\n\nThis endpoint creates an API key for a merchant managed by your affiliate account.\n\nProvide the Merchant ID and a API key name to generate a unique client Id and client secret for the merchant.\n\nUse the returned credentials to authenticate as the merchant for API operations.\n\nThis endpoint requires the Bearer token to be an Affiliate (ISV) token.\nMerchant tokens are not accepted.\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.CreateMerchantApiTokenRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.CreateMerchantApiTokenResponseDto" } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/pay-api/v1/merchants/tokens/{clientId}": { "delete": { "tags": [ "Merchant API Keys" ], "summary": "Deletes an API token for a merchant", "description": "DELETE {{baseURL}}/pay-api/v1/merchants/tokens/{{clientId}}\n\nThis endpoint removes an API token associated with a merchant under your affiliate account.\n\nProvide the Merchant ID and the client Id of the token to be deleted.\n\nThis action revokes the token and prevents further API access using those credentials.\n\nThis endpoint requires the Bearer token to be an Affiliate (ISV) token.\nMerchant tokens are not accepted.\n", "parameters": [ { "name": "clientId", "in": "path", "description": "The client ID of the token to be removed.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "merchantId", "in": "query", "description": "Specifies the identifier of the merchant.\n", "schema": { "type": "string", "format": "uuid", "example": "46063d32-10fa-44cb-b118-20ddd085ce3f" } } ], "responses": { "200": { "description": "OK. The API key was successfully deleted." }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/pay-api/v1/merchants": { "get": { "tags": [ "Merchant API Keys" ], "summary": "Returns a list of merchants", "description": "GET {{baseURL}}/pay-api/v1/merchants\n\nThis endpoint returns a list of merchants associated with the authenticated affiliate (ISV).\n\nThe following query parameters are search filters used to specify the retuurned results.\n", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "search", "in": "query", "required": false, "description": "Specifies the search string.\n\nThe following are fields commonly searched on, but not limited to this list. The search string may appear in any of these fields. The field does not have to be specified. However, if the results are to be sorted, that sort field must be specified. Use the field orderby to specify the sort field.\n\nfirstName\nlastName\ncompanyName\nemail\nmobilePhoneNumber\nid\ncreatedOn\nlastTransactionDate\ncontactName\n\nExample: Conners Electric\n", "schema": { "type": "string", "example": "Conners Electric" } }, { "name": "mccCodeId", "in": "query", "required": false, "description": "MCC code filter", "schema": { "type": "integer", "format": "int32", "example": "MCC code filter" } }, { "name": "statusId", "in": "query", "required": false, "description": "Merchant status filter.", "schema": { "type": "integer", "format": "int32" } }, { "name": "createdFrom", "in": "query", "required": false, "description": "Specifies the earliest inclusive created date (in an ISO 8601 date-time UTC or time zone offset format).\n\nThis value may be paired with the field `createdTo` to form an inclusive range.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "schema": { "type": "string", "format": "date-time", "example": "2026-02-19T20:24:52.934Z" } }, { "name": "createdTo", "in": "query", "required": false, "description": "Specifies the latest inclusive created date (in an ISO 8601 date-time UTC or time zone offset format).\n\nThis value may be paired with the field `createdFrom` to form an inclusive range.\n\nExamples:
\n2026-03-06T30:24:52.934Z
\n2026-03-06T30:24:52.934+05:30
\n2026-03-06T30:24:52.934-06:00\n", "schema": { "type": "string", "format": "date-time", "example": "2026-02-19T20:24:52.934Z" } }, { "name": "modifiedFrom", "in": "query", "required": false, "description": "Specifies the earliest inclusive modified date (in an ISO 8601 date-time UTC or time zone offset format).\n\nThis value may be paired with the field `modifiedTo` to form an inclusive range.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "schema": { "type": "string", "format": "date-time", "example": "2025-03-21T20:24:52.934Z" } }, { "name": "modifiedTo", "in": "query", "required": false, "description": "Specifies the latest inclusive modified date (in an ISO 8601 date-time UTC or time zone offset format).\n\nThis value may be paired with the field `modifiedFrom` to form an inclusive range.\n\nExamples:
\n2026-03-06T30:24:52.934Z
\n2026-03-06T30:24:52.934+05:30
\n2026-03-06T30:24:52.934-06:00\n", "schema": { "type": "string", "format": "date-time", "example": "2026-02-19T20:24:52.934Z" } }, { "name": "lastTransactionDateFrom", "in": "query", "required": false, "description": "Specifies the earliest inclusive transaction date (in an ISO 8601 date-time UTC or time zone offset format).\n\nThis value may be paired with the field `lastTransactionDateTo` to form an inclusive range.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "schema": { "type": "string", "format": "date-time", "example": "2025-03-21T20:24:52.934Z" } }, { "name": "lastTransactionDateTo", "in": "query", "required": false, "description": "Specifies the latest inclusive transaction date (in an ISO 8601 date-time UTC or time zone offset format).\n\nThis value may be paired with the field `lastTransactionDateFrom` to form an inclusive range.\n\nExamples:
\n2026-03-06T30:24:52.934Z
\n2026-03-06T30:24:52.934+05:30
\n2026-03-06T30:24:52.934-06:00\n", "schema": { "type": "string", "format": "date-time", "example": "2026-02-19T20:24:52.934Z" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "total" ], "properties": { "items": { "type": "array", "description": "Indicates an object array for the returned merchant list.\n", "items": { "type": "object", "properties": { "companyName": { "type": "string", "description": "Indicates the company name.\n\nExample: Peppared Street Cafe\n" }, "merchantId": { "type": "string", "description": "Indicates the merchant indentifier.\n\nExample: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid" } }, "required": [ "merchantId", "companyName" ] } }, "total": { "type": "integer", "format": "int32", "description": "Indicates the total number of merchants found.\n\nExample: 4\n", "example": 4 } } }, "example": { "items": [ { "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "companyName": "Acme Corp" } ], "total": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/settlements/batches": { "get": { "tags": [ "Settlement Batches" ], "summary": "Gets settlement batches", "description": "GET {{baseURL}}/pay-api/v1/settlements/batches\n", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "batchIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "paymentProcessorIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "statusId", "in": "query", "description": "Possible values:\n
    \n
  • 1 - Open:
    • \n
  • 2 - Settled:
    • \n
\n", "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.SettlementBatchStatus" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts.Page.Contracts.PublicApi.Isv.SettlementBatches.GetPage.GetIsvSettlementBatchesResponse" } } } } } } }, "/pay-api/v1/transactions": { "get": { "tags": [ "Transactions" ], "summary": "Gets transactions list", "description": "GET {{baseURL}}/pay-api/v1/transactions\n\nThis endpoint returns a list of transactions details.\n", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "createMethodId", "in": "query", "description": "Specifies the Aurora ACH transaction creator type identifier.\n\nExample: 3\n", "schema": { "type": "integer", "format": "int32", "example": 3 } }, { "name": "createdById", "in": "query", "description": "Specifies the transaction creator's identifier.\n\nExample: 109fb6fb-91bf-442a-a9cb-051255ff72b0\n", "schema": { "type": "string", "format": "uuid", "example": "109fb6fb-91bf-442a-a9cb-051255ff72b0" } }, { "name": "batchId", "in": "query", "description": "Specifies the identifier assigned to the batch that contains one or more ACH (automated clearing house) transactions.\n\nExample: 44a56eab-82c8-46de-bc07-021371be4721\n", "schema": { "type": "string", "format": "uuid", "example": "44a56eab-82c8-46de-bc07-021371be4721" } }, { "name": "noBatch", "in": "query", "description": "Specifies the transaction should bypass normal ACH (automated clearing house) batching.\n\nThe transaction will be processed individually instead of being grouped with other ACH transactions.\n\nIf `true`, the transaction will be processed individually instead of being grouped with other ACH transactions.
\nIf `false`, the transaction will be not processed individually but will be grouped with other ACH transactions.\n\nExample: false\n", "schema": { "type": "boolean", "example": false, "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts.Page.PublicApi.Isv.Transactions.GetPage.GetIsvTransactionsResponse" }, "examples": { "Get transactions for terminal": { "description": "Total = amount of items, Items = transactions list value", "value": { "total": 16, "items": [ { "id": "29de5986-c7f6-4100-a06b-3f686912d1f7", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.333986Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e25", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "john@example.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "afbf5d22-2415-4092-8329-b06073c71b24", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "552cb98d-0290-44e6-8c7c-a72120254b6d", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340022Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "5d6e7f8a-9b0c-4d1e-a2b3-4c5d6e7f8a3", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "john@example.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "2f844bdd-9909-4032-84a8-86f7ef552104", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "58a51103-66a0-45e2-90b7-73be91099acf", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340065Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "7a8b9c0d-1e2f-4a3b-b4c5-6d7e8f9a0b47", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "john@example.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "65244302-eb98-4b6e-988f-683cf982eef2", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "1278544f-1de7-450a-9e01-7813109ed384", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340106Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "0f1e2d3c-4b5a-4c6d-a7b8-9c0d1e2f3a58", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "john@example.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "c68f7446-e98e-402f-a51b-7b13a7fadd4f", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "77a1802c-9142-4e9f-882e-bbb30775f450", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340153Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "4c5d6e7f-8a9b-4c0d-b1e2-3f4a5b6c7d69", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "john@example.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "b1060c57-cffa-45ff-8cc0-881b7faea27d", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "a3ee8fde-3760-4083-967c-6422197873bf", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340195Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f03", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "b0ae7792-7c10-43e2-9390-04bd7c546289", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "e8558f26-9242-438f-86cc-54e9a36deff5", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340239Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "cd97928e-7f02-47fa-88df-6d652b57f416", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "8c526ade-3fc4-40d0-a168-458ef1d513cc", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340281Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "f5cef7ba-76b5-47af-8732-9eeefd0c5515", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "0d8abb05-1684-46ec-a8ef-a86f1f868630", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340322Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "8eb5f348-caf6-4f73-bb31-c7b2962595bd", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "242f3908-6588-4351-bb92-5e91df319e06", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340358Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "03d9f39b-3fa4-4adb-a5d5-d079079c33b3", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "635e5351-09a9-4cb0-8a77-172456ebe823", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340397Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "552d6292-af5d-44fa-a173-563e08814e37", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "ed36b508-b702-4425-8b0f-dc71c6e840a2", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340437Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "3c5294d1-ef42-4b1b-bfcc-25e22b5d11ef", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "8e159fea-aff2-4124-9da8-d4941f0b1824", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340506Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "ceb7d3ba-c74e-460c-a279-5884df767316", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "51fbfefb-3ace-493f-93c3-1bef1cf65692", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340663Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "0094b6c4-4224-4427-b43e-94e6bb18033b", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "809d0d5a-199a-4dcf-bb08-a90cbaee7bd1", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.334097Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "75e63e0a-6171-44f1-b553-280dadc575de", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "a4a491e8-8091-458e-be19-f1239e21405f", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3341016Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": null, "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "d2e1e4af-a8fe-4bf2-8ec3-6d3c24e30add", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/{id}": { "get": { "tags": [ "Transactions" ], "summary": "Gets transaction by ID", "description": "GET {{baseURL}}/pay-api/v1/transactions/{{transactionId}}\n\nThis endpoint returns a transaction details by transaction identifier.\n\nSee Also:
\nTo return a list of transactions, see `POST /pay-api/v1/transactions`\n", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "description": "Specifies the transaction identifier.\n\nExample: c7c15dd0-03e7-4e55-917c-54bedafba5e7\n", "schema": { "type": "string", "format": "uuid", "example": "c7c15dd0-03e7-4e55-917c-54bedafba5e7" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse" }, "example": { "baseAmount": 100, "totalAmount": 100, "tsysCardDetails": { "authCode": "A0000", "mid": "222222222", "tid": "1000001" }, "achDetails": { "customerAccountNumber": null, "customerRoutingNumber": null, "accountHolderType": null, "accountHolderTypeId": 0, "accountType": null, "accountTypeId": 0, "taxId": null }, "transactionId": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d81", "transactionDateTime": "2025-12-15T10:35:52.5407322Z", "amount": { "baseAmount": 100, "percentageOffAmount": 0, "percentageOffRate": 0, "cashDiscountAmount": 0, "cashDiscountRate": 0, "surchargeAmount": 0, "surchargeRate": 0, "tipAmount": 0, "tipRate": 0, "totalAmount": 100 }, "currencyId": 1, "currency": "USD", "processorId": "c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e92", "processor": "TSYS Sample", "operationTypeId": 1, "operationType": "PayNow", "paymentMethodTypeId": 1, "paymentMethodType": "Card", "transactionTypeId": 1, "transactionType": "Authorization", "customerId": null, "customerPan": "************4512", "cardTokenType": 1, "statusId": 1, "status": "Authorized", "merchantName": "Your Company", "merchantAddress": "WallStreet 1, New York", "merchantPhoneNumber": "1555123123", "merchantEmailAddress": "support@company.com", "merchantWebsite": "", "authCode": "A0000", "source": { "typeId": 1, "type": "Portal", "id": "7b592aea-b3bd-4ac1-a1e6-c63c5080554e", "name": "SourceName" }, "cardholderAuthenticationMethodId": null, "cardholderAuthenticationMethod": null, "cvmResultMsg": null, "cardDataSourceId": null, "cardDataSource": null, "responseCode": null, "responseDescription": null, "cardProcessingDetails": { "authCode": "A0000", "mid": "222222222", "tid": "1000001", "cardCreditDebitTypeId": 1, "cardCreditDebitType": "Credit", "processCreditDebitTypeId": 1, "processCreditDebitType": "Credit", "rrn": "10628361287F", "cardTypeId": 0, "cardType": null }, "achProcessingDetails": { "customerAccountNumber": null, "customerRoutingNumber": null, "accountHolderType": null, "accountHolderTypeId": 0, "accountType": null, "accountTypeId": 0, "taxId": null }, "availableOperations": [ { "typeId": 3, "type": "Capture", "availableAmount": 97.85, "suggestedTips": null }, { "typeId": 4, "type": "Void", "availableAmount": null, "suggestedTips": null } ], "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": "0", "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": "The The street address and ZIP Code match the information on file." }, "emvTags": { "ac": "533C2902770EA987", "tvr": "0040040000", "tsi": null, "aid": "A0000000031010", "applicationLabel": "MasterCard", "rawTags": [ { "key": "5F34", "value": "SOMETHING" }, { "key": "5F35", "value": "SOMETHING" } ] }, "orderNumber": "752314" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/auth": { "post": { "tags": [ "Transactions" ], "summary": "Authorizes a Transaction", "operationId": "pay_api_v1_transactions_auth", "description": "POST {{baseURL}}/pay-api/v1/transactions/auth\n\nThis endpoint authorizes a payment transaction.\n\nThis verifies that the customer's payment method is valid and that sufficient funds or credit are available.\n\nSee Also:
\nTo capture or complete a transaction, see `POST {/pay-api/v1/transactions/capture`
\nTo settle a transaction, see `POST /pay-api/v1/transactions/settle`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationRequest" }, "examples": { "Card not present Auth": { "value": { "cardDataSource": 1, "deviceid": "a30f9b66-b2f0-4b18-a03a-b861b00afa8b", "paymentProcessorId": "37bd9ccb-2c9d-45cf-a65f-c9a224bdeaeb", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": 3, "surchargeRate": 4, "useCardPrice": null, "appVersion": "10.413.01", "sdkVersion": "8.61.01", "billingAddress": { "city": "Phoenix", "countryId": 1, "line1": "21 E. Main Street", "line2": "Office 7", "postalCode": "85099", "stateName": null, "stateId": 1 }, "shippingAddress": { "city": "Phoenix", "countryId": 1, "line1": "21 E. Main Street", "line2": null, "postalCode": "85099", "stateName": null, "stateId": 1 }, "contactInfo": { "firstName": "John", "lastName": "Smith", "companyName": "Aurora", "email": "j.smith29f@example.com", "mobileNumber": null, "smsNotification": null }, "accountNumber": "4111111111111111", "securityCode": "123", "expirationMonth": 12, "expirationYear": 24, "track1": null, "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "pin": null, "pinKsn": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "Swipe Auth": { "value": { "cardDataSource": 2, "deviceid": "a30f9b66-b2f0-4b18-a03a-b861b00afa8b", "paymentProcessorId": "bb412700-f699-4e9d-922a-80c53a6c5c09", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": null, "tipRate": null, "currencyId": 1, "percentageOffRate": null, "surchargeRate": null, "useCardPrice": null, "appVersion": "10.413.01", "sdkVersion": "8.61.01", "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "accountNumber": null, "securityCode": null, "expirationMonth": null, "expirationYear": null, "track1": "%B4111111111111111^Smith/John^12121010000000000000?", "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "pin": null, "pinKsn": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "NFC Auth": { "value": { "cardDataSource": 3, "deviceid": "a30f9b66-b2f0-4b18-a03a-b861b00afa8b", "paymentProcessorId": "cf394859-95b3-4a89-a416-41e92bf6c1a7", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": null, "surchargeRate": null, "useCardPrice": null, "appVersion": "10.413.01", "sdkVersion": "8.61.01", "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "accountNumber": null, "securityCode": null, "expirationMonth": null, "expirationYear": null, "track1": null, "track2": "371449635392376=200257999", "emvTags": null, "emvPaymentAppVersion": null, "pin": null, "pinKsn": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "EMV auth": { "value": { "cardDataSource": 4, "deviceid": "a30f9b66-b2f0-4b18-a03a-b861b00afa8b", "paymentProcessorId": "f48dc06f-0a76-4eb6-b7d8-16c051a26f81", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": null, "surchargeRate": null, "useCardPrice": null, "appVersion": "10.413.01", "sdkVersion": "8.61.01", "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "accountNumber": null, "securityCode": null, "expirationMonth": null, "expirationYear": null, "track1": null, "track2": null, "emvTags": [ "57114111111111111111D20122011334573581", "DF7809323832363938383433", "DF790C303030303030303030363230", "9F2608533C2902770EA987", "9F0206000000000100", "95050040040000", "9F270180", "9C0100", "9A03150716", "5F2A020840", "9F3602001D", "82020040", "9F37046C2F556A", "5F340101", "9F100706FF0A03A40000", "9F3303E008C8", "9F400101", "4F07A0000000031010", "9F0607A0000000041010", "9F3403280000", "9F120A4D617374657243617264", "9F110101", "500A56697361" ], "emvPaymentAppVersion": null, "pin": null, "pinKsn": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "EMV contactless auth": { "value": { "cardDataSource": 5, "deviceid": "a30f9b66-b2f0-4b18-a03a-b861b00afa8b", "paymentProcessorId": "078923fa-3019-412a-860c-bad612444003", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": null, "surchargeRate": null, "useCardPrice": null, "appVersion": "10.413.01", "sdkVersion": "8.61.01", "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "accountNumber": null, "securityCode": null, "expirationMonth": null, "expirationYear": null, "track1": null, "track2": null, "emvTags": [ "57114111111111111111D20122011334573581", "DF7809323832363938383433", "DF790C303030303030303030363230", "9F2608533C2902770EA987", "9F0206000000000100", "95050040040000", "9F270180", "9C0100", "9A03150716", "5F2A020840", "9F3602001D", "82020040", "9F37046C2F556A", "5F340101", "9F100706FF0A03A40000", "9F3303E008C8", "9F400101", "4F07A0000000031010", "9F0607A0000000041010", "9F3403280000", "9F120A4D617374657243617264", "9F110101", "500A56697361" ], "emvPaymentAppVersion": null, "pin": null, "pinKsn": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "Fallback swipe Auth": { "value": { "cardDataSource": 1, "deviceid": "a30f9b66-b2f0-4b18-a03a-b861b00afa8b", "paymentProcessorId": "45840b46-44a6-444f-a43e-6f3e62a29d21", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": null, "tipRate": null, "currencyId": 1, "percentageOffRate": null, "surchargeRate": null, "useCardPrice": null, "appVersion": "10.413.01", "sdkVersion": "8.61.01", "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "accountNumber": null, "securityCode": null, "expirationMonth": null, "expirationYear": null, "track1": null, "track2": "4111111111111111=200257999", "emvTags": null, "emvPaymentAppVersion": null, "pin": null, "pinKsn": null, "emvFallbackCondition": 0, "emvFallbackLastChipRead": 2, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "Level 2-3 data": { "value": { "cardDataSource": 1, "deviceid": "a30f9b66-b2f0-4b18-a03a-b861b00afa8b", "paymentProcessorId": "e47c8e39-99ee-452e-baaf-f2d158d3fc54", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": 3, "surchargeRate": 4, "useCardPrice": null, "appVersion": "10.413.01", "sdkVersion": "8.61.01", "billingAddress": { "city": "Phoenix", "countryId": 1, "line1": "21 E. Main Street", "line2": null, "postalCode": "85099", "stateName": null, "stateId": 1 }, "shippingAddress": { "city": "Phoenix", "countryId": 1, "line1": "21 E. Main Street", "line2": "Office 7", "postalCode": "85099", "stateName": null, "stateId": 1 }, "contactInfo": { "firstName": "John", "lastName": "Smith", "companyName": "Aurora", "email": "j.smith29f@example.com", "mobileNumber": null, "smsNotification": null }, "accountNumber": "4111111111111111", "securityCode": "123", "expirationMonth": 12, "expirationYear": 24, "track1": null, "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "pin": null, "pinKsn": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": { "salesTaxRate": 20 }, "l3": { "invoiceNumber": "invoice number", "purchaseOrder": "order", "shippingCharges": 6, "dutyCharges": 5, "products": [ { "name": "proguct-name", "code": "product-code", "unitPrice": 3, "measurementUnit": "kg", "quantity": 2, "taxAmount": null, "discountRate": 2, "description": null, "measurementUnitId": null } ] }, "customerInitiatedTransaction": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationResponse" }, "examples": { "Authorization response": { "description": "Transaction, type Authorization, status = Authorized. Transaction status after an approved pre-authorization request", "value": { "processedAmount": 10, "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": "0", "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": "Street Address and ZIP Code Match the information on file." }, "transactionReceipt": null, "transactionId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "transactionDateTime": "2025-12-16T10:35:52.4081694Z", "typeId": 1, "type": "Authorization", "statusId": 1, "status": "Authorized", "details": { "hostResponseCode": "00", "hostResponseMessage": "APPROVAL", "hostResponseDefinition": "Approved and completed", "code": "Approve", "message": "Success", "processorResponseCode": null, "authCode": "VTLMC1", "maskedPan": null } } }, "Partial authorization response": { "description": "Transaction, type Authorization, status = PartiallyAuthorized. Indicates that the issuer bank has approved only a portion of the requested payment amount.", "value": { "processedAmount": 10, "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": "0", "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": "Street Address and ZIP Code Match the information on file." }, "transactionReceipt": null, "transactionId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "transactionDateTime": "2025-12-16T10:35:52.4081817Z", "typeId": 1, "type": "Authorization", "statusId": 7, "status": "PartiallyAuthorized", "details": { "hostResponseCode": "00", "hostResponseMessage": "APPROVAL", "hostResponseDefinition": "Approved and completed", "code": "Approve", "message": "Success", "processorResponseCode": null, "authCode": "VTLMC1", "maskedPan": null } } }, "Sale response": { "description": "Transaction, type Sale, status = Captured. Transaction status after approved sale or capture request", "value": { "processedAmount": 10, "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": "0", "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": "Street Address and ZIP Code Match the information on file." }, "transactionReceipt": null, "transactionId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "transactionDateTime": "2025-12-16T10:35:52.4081829Z", "typeId": 2, "type": "Sale", "statusId": 2, "status": "Captured", "details": { "hostResponseCode": "00", "hostResponseMessage": "APPROVAL", "hostResponseDefinition": "Approved and completed", "code": "Approve", "message": "Success", "processorResponseCode": null, "authCode": "VTLMC1", "maskedPan": null } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/sale": { "post": { "tags": [ "Transactions" ], "summary": "Sales Transaction", "operationId": "pay_api_v1_transactions_sale", "description": "POST {{baseURL}}/pay-api/v1/transactions/sale\n\nThis endpoint completes a transaction in a single step.\n\nIt combines the two actions of authorizing and capturing a transaction into a single endpoint.\nUse this endpoint when the final amount is known and will not change.\nThe transaction can be made immediately.\n\nSee Also:
\nTo authorize a transaction, see `POST /pay-api/v1/transactions/auth`
\nTo capture or complete a transaction, see `POST {/pay-api/v1/transactions/capture`
\nTo settle a transaction, see `POST /pay-api/v1/transactions/settle`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Sale.IsvSaleRequest" }, "examples": { "Card not present Sale": { "value": { "cardDataSource": 1, "deviceId": "a30f9b66-b2f0-4b18-a03a-b861b00afa8b", "paymentProcessorId": "8d72c23b-5d52-42df-beee-1a96655e2be6", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": 3, "surchargeRate": 4, "useCardPrice": null, "billingAddress": { "city": "Phoenix", "countryId": 1, "line1": "7429 Desert Mirage Lane", "line2": null, "postalCode": "85099", "stateName": "AZ", "stateId": 4 }, "shippingAddress": { "city": "Phoenix", "countryId": 1, "line1": "7429 Desert Mirage Lane", "line2": "Office 7", "postalCode": "85099", "stateName": "AZ", "stateId": 4 }, "contactInfo": { "firstName": "John", "lastName": "Smith", "companyName": "Aurora", "email": "j.smith29f@example.com", "mobileNumber": null, "smsNotification": null }, "accountNumber": "4111111111111111", "securityCode": "123", "expirationMonth": 12, "expirationYear": 24, "track1": null, "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "pin": null, "pinKsn": null, "debit": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "Swipe Sale": { "value": { "paymentProcessorId": "d2ae10f5-5085-4ae2-896f-590daf0392e8", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": null, "surchargeRate": null, "useCardPrice": null, "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "accountNumber": "4111111111111112", "securityCode": null, "expirationMonth": 12, "expirationYear": 24, "track1": "%B4111111111111111^Smith/John^12121010000000000000?", "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "cardDataSource": 2, "pin": null, "pinKsn": null, "debit": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "Nfc Sale": { "value": { "paymentProcessorId": "426a0631-aa0c-400f-9204-4efb5e3c4691", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": null, "surchargeRate": null, "useCardPrice": null, "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "accountNumber": "4111111111111112", "securityCode": null, "expirationMonth": 12, "expirationYear": 24, "track1": null, "track2": "371449635392376=200257999", "emvTags": null, "emvPaymentAppVersion": null, "cardDataSource": 3, "pin": null, "pinKsn": null, "debit": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "Emv Sale": { "value": { "paymentProcessorId": "f77dd5f0-f1b7-481b-b404-354eed3dd8bf", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": null, "surchargeRate": null, "useCardPrice": null, "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "accountNumber": "4111111111111112", "securityCode": null, "expirationMonth": 12, "expirationYear": 24, "track1": null, "track2": null, "emvTags": [ "57114111111111111111D20122011334573581", "DF7809323832363938383433", "DF790C303030303030303030363230", "9F2608533C2902770EA987", "9F0206000000000100", "95050040040000", "9F270180", "9C0100", "9A03150716", "5F2A020840", "9F3602001D", "82020040", "9F37046C2F556A", "5F340101", "9F100706FF0A03A40000", "9F3303E008C8", "9F400101", "4F07A0000000031010", "9F0607A0000000041010", "9F3403280000", "9F120A4D617374657243617264", "9F110101", "500A56697361" ], "emvPaymentAppVersion": null, "cardDataSource": 4, "pin": null, "pinKsn": null, "debit": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "Emv contactless Sale": { "value": { "paymentProcessorId": "625466b6-8c9e-463d-bd82-d0f333fdaa9a", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": null, "surchargeRate": null, "useCardPrice": null, "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "accountNumber": "4111111111111112", "securityCode": null, "expirationMonth": 12, "expirationYear": 24, "track1": null, "track2": null, "emvTags": [ "57114111111111111111D20122011334573581", "DF7809323832363938383433", "DF790C303030303030303030363230", "9F2608533C2902770EA987", "9F0206000000000100", "95050040040000", "9F270180", "9C0100", "9A03150716", "5F2A020840", "9F3602001D", "82020040", "9F37046C2F556A", "5F340101", "9F100706FF0A03A40000", "9F3303E008C8", "9F400101", "4F07A0000000031010", "9F0607A0000000041010", "9F3403280000", "9F120A4D617374657243617264", "9F110101", "500A56697361" ], "emvPaymentAppVersion": null, "cardDataSource": 5, "pin": null, "pinKsn": null, "debit": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "Fallback swipe Sale": { "value": { "paymentProcessorId": "066cd5c7-7c16-4d58-ade5-371bd46f0a31", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": null, "tipRate": null, "currencyId": 1, "percentageOffRate": null, "surchargeRate": null, "useCardPrice": null, "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "accountNumber": "4111111111111112", "securityCode": null, "expirationMonth": 12, "expirationYear": 24, "track1": null, "track2": "4111111111111111=200257999", "emvTags": null, "emvPaymentAppVersion": null, "cardDataSource": 6, "pin": null, "pinKsn": null, "debit": null, "emvFallbackCondition": 0, "emvFallbackLastChipRead": 2, "referenceId": null, "l2": null, "l3": null, "customerInitiatedTransaction": false } }, "Level 2-3 data": { "value": { "paymentProcessorId": "ac972198-567c-4003-9f7a-32f66cefb7f4", "customerId": null, "paymentMethodId": null, "amount": 123.45, "tipAmount": 1, "tipRate": null, "currencyId": 1, "percentageOffRate": 3, "surchargeRate": 4, "useCardPrice": null, "billingAddress": { "city": "Phoenix", "countryId": 1, "line1": "7429 Desert Mirage Lane", "line2": null, "postalCode": "85099", "stateName": "AZ", "stateId": 4 }, "shippingAddress": { "city": "Phoenix", "countryId": 1, "line1": "7429 Desert Mirage Lane", "line2": "Office 7", "postalCode": "85099", "stateName": "AZ", "stateId": 4 }, "contactInfo": { "firstName": "John", "lastName": "Smith", "companyName": "Aurora", "email": "j.smith29f@example.com", "mobileNumber": null, "smsNotification": null }, "accountNumber": "4111111111111111", "securityCode": "123", "expirationMonth": 12, "expirationYear": 24, "track1": null, "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "cardDataSource": 1, "pin": null, "pinKsn": null, "debit": null, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": null, "l2": { "salesTaxRate": 20 }, "l3": { "invoiceNumber": "invoice number", "purchaseOrder": "order", "shippingCharges": 6, "dutyCharges": 5, "products": [ { "name": "proguct-name", "code": "product-code", "unitPrice": 3, "measurementUnit": "kg", "quantity": 2, "taxAmount": null, "discountRate": 2, "description": null, "measurementUnitId": null } ] }, "customerInitiatedTransaction": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationResponse" }, "examples": { "Authorization response": { "description": "Transaction, type Authorization, status = Authorized. Transaction status after an approved pre-authorization request", "value": { "processedAmount": 10, "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": "0", "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": "The street address and ZIP Code match the information on file." }, "transactionReceipt": { "transactionId": "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36", "transactionDateTime": "2026-12-16T10:35:52.000000Z", "amount": { "baseAmount": 0, "percentageOffAmount": 0, "percentageOffRate": 0, "cashDiscountAmount": 0, "cashDiscountRate": 0, "surchargeAmount": 0, "surchargeRate": 0, "tipAmount": 0, "tipRate": 0, "totalAmount": 0 }, "currencyId": 0, "currency": null, "processorId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "processor": null, "operationTypeId": 0, "operationType": null, "paymentMethodTypeId": 0, "paymentMethodType": null, "transactionTypeId": 0, "transactionType": null, "customerId": null, "customerPan": null, "cardTokenType": 1, "statusId": 0, "status": null, "merchantName": null, "merchantAddress": null, "merchantPhoneNumber": null, "merchantEmailAddress": null, "merchantWebsite": null, "authCode": null, "source": null, "cardholderAuthenticationMethodId": null, "cardholderAuthenticationMethod": null, "cvmResultMsg": null, "cardDataSourceId": null, "cardDataSource": null, "responseCode": null, "responseDescription": null, "cardProcessingDetails": { "authCode": "A0000", "mid": null, "tid": null, "cardCreditDebitTypeId": 2, "cardCreditDebitType": "Debit", "processCreditDebitTypeId": 1, "processCreditDebitType": "Credit", "rrn": "10628361287F", "cardTypeId": 0, "cardType": null }, "achProcessingDetails": { "customerAccountNumber": null, "customerRoutingNumber": null, "accountHolderType": null, "accountHolderTypeId": 0, "accountType": null, "accountTypeId": 0, "taxId": null }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": null, "suggestedTips": null }, { "typeId": 8, "type": "TipAdjustment", "availableAmount": null, "suggestedTips": [ { "tipPercent": 5, "tipAmount": 10 }, { "tipPercent": 10, "tipAmount": 20 }, { "tipPercent": 15, "tipAmount": 30 } ] } ], "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": null, "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": null }, "emvTags": { "ac": "533C2902770EA987", "tvr": "0040040000", "tsi": null, "aid": "A0000000031010", "applicationLabel": "MasterCard", "rawTags": [ { "key": "5F34", "value": "SOMETHING" }, { "key": "5F35", "value": "SOMETHING" } ] }, "orderNumber": "752314" }, "transactionId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "transactionDateTime": "2025-12-16T10:35:52.4155781Z", "typeId": 1, "type": "Authorization", "statusId": 1, "status": "Authorized", "details": { "hostResponseCode": "00", "hostResponseMessage": "APPROVAL", "hostResponseDefinition": "Approved and completed", "code": "Approve", "message": "Success", "processorResponseCode": null, "authCode": "VTLMC1", "maskedPan": null } } }, "Partial authorization response": { "description": "Transaction, type Authorization, status = PartiallyAuthorized. Indicates that the issuer bank has approved only a portion of the requested payment amount.", "value": { "processedAmount": 10, "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": "0", "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": "The street address and ZIP Code match the information on file." }, "transactionReceipt": { "transactionId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "transactionDateTime": "2026-12-16T10:35:52.000000Z", "amount": { "baseAmount": 0, "percentageOffAmount": 0, "percentageOffRate": 0, "cashDiscountAmount": 0, "cashDiscountRate": 0, "surchargeAmount": 0, "surchargeRate": 0, "tipAmount": 0, "tipRate": 0, "totalAmount": 0 }, "currencyId": 0, "currency": null, "processorId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "processor": null, "operationTypeId": 0, "operationType": null, "paymentMethodTypeId": 0, "paymentMethodType": null, "transactionTypeId": 0, "transactionType": null, "customerId": null, "customerPan": null, "cardTokenType": 1, "statusId": 0, "status": null, "merchantName": null, "merchantAddress": null, "merchantPhoneNumber": null, "merchantEmailAddress": null, "merchantWebsite": null, "authCode": null, "source": null, "cardholderAuthenticationMethodId": null, "cardholderAuthenticationMethod": null, "cvmResultMsg": null, "cardDataSourceId": null, "cardDataSource": null, "responseCode": null, "responseDescription": null, "cardProcessingDetails": { "authCode": "A0000", "mid": null, "tid": null, "cardCreditDebitTypeId": 2, "cardCreditDebitType": "Debit", "processCreditDebitTypeId": 1, "processCreditDebitType": "Credit", "rrn": "10628361287F", "cardTypeId": 0, "cardType": null }, "achProcessingDetails": { "customerAccountNumber": null, "customerRoutingNumber": null, "accountHolderType": null, "accountHolderTypeId": 0, "accountType": null, "accountTypeId": 0, "taxId": null }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": null, "suggestedTips": null }, { "typeId": 8, "type": "TipAdjustment", "availableAmount": null, "suggestedTips": [ { "tipPercent": 5, "tipAmount": 10 }, { "tipPercent": 10, "tipAmount": 20 }, { "tipPercent": 15, "tipAmount": 30 } ] } ], "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": null, "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": null }, "emvTags": { "ac": "533C2902770EA987", "tvr": "0040040000", "tsi": null, "aid": "A0000000031010", "applicationLabel": "MasterCard", "rawTags": [ { "key": "5F34", "value": "SOMETHING" }, { "key": "5F35", "value": "SOMETHING" } ] }, "orderNumber": "752314" }, "transactionId": "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36", "transactionDateTime": "2025-12-16T10:35:52.4155813Z", "typeId": 1, "type": "Authorization", "statusId": 7, "status": "PartiallyAuthorized", "details": { "hostResponseCode": "00", "hostResponseMessage": "APPROVAL", "hostResponseDefinition": "Approved and completed", "code": "Approve", "message": "Success", "processorResponseCode": null, "authCode": "VTLMC1", "maskedPan": null } } }, "Sale response": { "description": "Transaction, type Sale, status = Captured. Transaction status after approved sale or capture request", "value": { "processedAmount": 10, "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": "0", "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": "The street address and ZIP Code match the information on file." }, "transactionReceipt": { "transactionId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "transactionDateTime": "2026-12-16T10:35:52.000000Z", "amount": { "baseAmount": 0, "percentageOffAmount": 0, "percentageOffRate": 0, "cashDiscountAmount": 0, "cashDiscountRate": 0, "surchargeAmount": 0, "surchargeRate": 0, "tipAmount": 0, "tipRate": 0, "totalAmount": 0 }, "currencyId": 0, "currency": null, "processorId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "processor": null, "operationTypeId": 0, "operationType": null, "paymentMethodTypeId": 0, "paymentMethodType": null, "transactionTypeId": 0, "transactionType": null, "customerId": null, "customerPan": null, "cardTokenType": 1, "statusId": 0, "status": null, "merchantName": null, "merchantAddress": null, "merchantPhoneNumber": null, "merchantEmailAddress": null, "merchantWebsite": null, "authCode": null, "source": null, "cardholderAuthenticationMethodId": null, "cardholderAuthenticationMethod": null, "cvmResultMsg": null, "cardDataSourceId": null, "cardDataSource": null, "responseCode": null, "responseDescription": null, "cardProcessingDetails": { "authCode": "A0000", "mid": null, "tid": null, "cardCreditDebitTypeId": 2, "cardCreditDebitType": "Debit", "processCreditDebitTypeId": 1, "processCreditDebitType": "Credit", "rrn": "10628361287F", "cardTypeId": 0, "cardType": null }, "achProcessingDetails": { "customerAccountNumber": null, "customerRoutingNumber": null, "accountHolderType": null, "accountHolderTypeId": 0, "accountType": null, "accountTypeId": 0, "taxId": null }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": null, "suggestedTips": null }, { "typeId": 8, "type": "TipAdjustment", "availableAmount": null, "suggestedTips": [ { "tipPercent": 5, "tipAmount": 10 }, { "tipPercent": 10, "tipAmount": 20 }, { "tipPercent": 15, "tipAmount": 30 } ] } ], "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": null, "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": null }, "emvTags": { "ac": "533C2902770EA987", "tvr": "0040040000", "tsi": null, "aid": "A0000000031010", "applicationLabel": "MasterCard", "rawTags": [ { "key": "5F34", "value": "SOMETHING" }, { "key": "5F35", "value": "SOMETHING" } ] }, "orderNumber": "752314" }, "transactionId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "transactionDateTime": "2025-12-16T10:35:52.4185469Z", "typeId": 2, "type": "Sale", "statusId": 2, "status": "Captured", "details": { "hostResponseCode": "00", "hostResponseMessage": "APPROVAL", "hostResponseDefinition": "Approved and completed", "code": "Approve", "message": "Success", "processorResponseCode": null, "authCode": "VTLMC1", "maskedPan": null } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/capture": { "post": { "tags": [ "Transactions" ], "summary": "Captures a Transaction", "operationId": "pay_api_v1_transactions_capture", "description": "POST {{baseURL}}/pay-api/v1/transactions/capture\n\nThis endpoint captures a previously authorized transaction.\n\nThe capture must reference an existing authorized transaction.\nIt intends to convert the authorization hold into a completed charge that will be submitted for settlement.\nWhen a transaction is first authorized, the customer’s bank places a temporary hold on the funds.\nThose funds are not transfer the money yet.\nA capture confirms that the merchant intends to collect those funds and finalizes the transaction.\nOnce captured, the transaction cannot be voided.\n\nFor example, a customer orders $100 at a restaurant.\nThe charge is authorized but the funds are not paid yet.\nThe customer is waiting to add a tip amount.\nAfter the tip is included and a new amount is agreed on, the transaction is captured.\nNow, the funds are released for payment.\n\nSee Also:
\nTo authorize a transaction, see `POST /pay-api/v1/transactions/auth`
\nTo refund a settled transaction, see `POST /pay-api/v1/transactions/return`
\nTo capture an amount for funds transfer, see `POST /pay-api/v1/transactions/capture`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Capture.IsvCaptureRequest" }, "example": { "amount": 123.45, "transactionId": "4b25e010-5a4a-4bd0-9961-0cff14bdb41b" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvTransactionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/return": { "post": { "tags": [ "Transactions" ], "summary": "Refunds or Returns a Transaction", "operationId": "pay_api_v1_transactions_return", "description": "POST {{baseURL}}/pay-api/v1/transactions/return\n\nThis endpoint refunds or returns funds from an original transaction identifier. \n\nThis creates a refund transaction that is linked to a specific previous transaction.\n\nSee Also:
\nTo refund without a transaction identifier, see `POST /pay-api/v1/transactions/return/no-reference`
\nTo settle a transaction, see `POST /pay-api/v1/transactions/settle`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Return.IsvReturnRequest" }, "examples": { "Credit return with reference": { "description": "Transaction Id is required", "value": { "track1": null, "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "cardDataSource": 1, "pin": null, "pinKsn": null, "transactionId": "debb3098-3ca0-4b8b-b28d-d3a1c3e50e66", "amount": null } }, "Debit return with reference": { "description": "Debit transaction Id and track 1, track 2 or EMV tags are required", "value": { "track1": "B5413330056003511^CUST IMP MC 351/^2512101000000000", "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "cardDataSource": 2, "pin": null, "pinKsn": null, "transactionId": "6ffca2bb-a462-4bdd-96ab-65a1baff9492", "amount": null } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvTransactionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/return/no-reference": { "post": { "tags": [ "Transactions" ], "summary": "Refunds or Returns a transaction Without Reference", "operationId": "pay_api_v1_transactions_return_without_reference", "description": "POST {{baseURL}}/pay-api/v1/transactions/return/no-reference\n\nThis endpoint refunds or returns funds without a reference.\n\nWithout a reference means the customer does not have the link to the original transaction identifier.\nThis creates a refund transaction that is not linked to a specific previous transaction.\nInstead of refunding a known transaction identifier, the system processes a standalone credit back to the cardholder’s payment method.\n\nThe endpoint requires the administrative API permission: Ecommerce Refund Without Reference.\n\nSee Also:
\nTo refund using a transaction identifier, see `POST /pay-api/v1/transactions/return`
\nTo settle a transaction, see `POST /pay-api/v1/transactions/settle`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Return.ReturnWORefRequest" }, "examples": { "Card present credit return without reference": { "value": { "paymentProcessorId": "64aa4643-2c62-45fa-9554-3a69833114e9", "customerId": null, "amount": 10.1, "currencyId": 1, "accountNumber": null, "securityCode": null, "expirationMonth": 12, "expirationYear": 24, "track1": "B5413330056003511^CUST IMP MC 351/^2512101000000000", "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "cardDataSource": 2, "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "pin": "1111", "pinKsn": "2222222222", "debit": false, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": "123456" } }, "Card not present credit return without reference": { "value": { "paymentProcessorId": "b0f1f89f-4e73-4fa9-87fb-fad260b038d0", "customerId": null, "amount": 10.1, "currencyId": 1, "accountNumber": "5413591081013511", "securityCode": "123", "expirationMonth": 11, "expirationYear": 2026, "track1": null, "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "cardDataSource": 1, "billingAddress": { "city": "Phoenix", "countryId": 1, "line1": "7429 Desert Mirage Lane", "line2": "Office 7", "postalCode": "85099", "stateName": "AZ", "stateId": 4 }, "shippingAddress": { "city": "Phoenix", "countryId": 1, "line1": "7429 Desert Mirage Lane", "line2": null, "postalCode": "85099", "stateName": "AZ", "stateId": 4 }, "contactInfo": { "firstName": "Greg", "lastName": "Black", "companyName": "CompanyName", "email": "mail@box.com", "mobileNumber": "415558787", "smsNotification": true }, "pin": null, "pinKsn": null, "debit": false, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": "123456" } }, "Card present debit return without reference": { "value": { "paymentProcessorId": "8fd4c360-70ae-41f5-b11a-497fe66b41de", "customerId": null, "amount": 10.1, "currencyId": 1, "accountNumber": null, "securityCode": null, "expirationMonth": 12, "expirationYear": 24, "track1": "B5413330056003511^CUST IMP MC 351/^2512101000000000", "track2": null, "emvTags": null, "emvPaymentAppVersion": null, "cardDataSource": 2, "billingAddress": {}, "shippingAddress": {}, "contactInfo": null, "pin": "1111", "pinKsn": "2222222222", "debit": true, "emvFallbackCondition": null, "emvFallbackLastChipRead": null, "referenceId": "123456" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationResponse" }, "examples": { "Authorization response": { "description": "Transaction, type Authorization, status = Authorized. Transaction status after an approved pre-authorization request", "value": { "processedAmount": 10, "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": "0", "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": "The street address and ZIP Code match the information on file." }, "transactionReceipt": { "transactionId": "b8c9d0e1-f2a3-4b4c-5d6e-7f8a9b0c1d47", "transactionDateTime": "2026-12-16T10:35:52.000000Z", "amount": { "baseAmount": 0, "percentageOffAmount": 0, "percentageOffRate": 0, "cashDiscountAmount": 0, "cashDiscountRate": 0, "surchargeAmount": 0, "surchargeRate": 0, "tipAmount": 0, "tipRate": 0, "totalAmount": 0 }, "currencyId": 0, "currency": null, "processorId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "processor": null, "operationTypeId": 0, "operationType": null, "paymentMethodTypeId": 0, "paymentMethodType": null, "transactionTypeId": 0, "transactionType": null, "customerId": null, "customerPan": null, "cardTokenType": 1, "statusId": 0, "status": null, "merchantName": null, "merchantAddress": null, "merchantPhoneNumber": null, "merchantEmailAddress": null, "merchantWebsite": null, "authCode": null, "source": null, "cardholderAuthenticationMethodId": null, "cardholderAuthenticationMethod": null, "cvmResultMsg": null, "cardDataSourceId": null, "cardDataSource": null, "responseCode": null, "responseDescription": null, "cardProcessingDetails": { "authCode": "A0000", "mid": null, "tid": null, "cardCreditDebitTypeId": 2, "cardCreditDebitType": "Debit", "processCreditDebitTypeId": 1, "processCreditDebitType": "Credit", "rrn": "10628361287F", "cardTypeId": 0, "cardType": null }, "achProcessingDetails": { "customerAccountNumber": null, "customerRoutingNumber": null, "accountHolderType": null, "accountHolderTypeId": 0, "accountType": null, "accountTypeId": 0, "taxId": null }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": null, "suggestedTips": null }, { "typeId": 8, "type": "TipAdjustment", "availableAmount": null, "suggestedTips": [ { "tipPercent": 5, "tipAmount": 10 }, { "tipPercent": 10, "tipAmount": 20 }, { "tipPercent": 15, "tipAmount": 30 } ] } ], "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": null, "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": null }, "emvTags": { "ac": "533C2902770EA987", "tvr": "0040040000", "tsi": null, "aid": "A0000000031010", "applicationLabel": "MasterCard", "rawTags": [ { "key": "5F34", "value": "SOMETHING" }, { "key": "5F35", "value": "SOMETHING" } ] }, "orderNumber": "752314" }, "transactionId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "transactionDateTime": "2025-12-16T10:35:52.4617311Z", "typeId": 1, "type": "Authorization", "statusId": 1, "status": "Authorized", "details": { "hostResponseCode": "00", "hostResponseMessage": "APPROVAL", "hostResponseDefinition": "Approved and completed", "code": "Approve", "message": "Success", "processorResponseCode": null, "authCode": "VTLMC1", "maskedPan": null } } }, "Partial authorization response": { "description": "Transaction, type Authorization, status = PartiallyAuthorized. Indicates that the issuer bank has approved only a portion of the requested payment amount.", "value": { "processedAmount": 10, "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": "0", "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": "The street address and ZIP Code match the information on file." }, "transactionReceipt": { "transactionId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "transactionDateTime": "2026-12-16T10:35:52.000000Z", "amount": { "baseAmount": 0, "percentageOffAmount": 0, "percentageOffRate": 0, "cashDiscountAmount": 0, "cashDiscountRate": 0, "surchargeAmount": 0, "surchargeRate": 0, "tipAmount": 0, "tipRate": 0, "totalAmount": 0 }, "currencyId": 0, "currency": null, "processorId": "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36", "processor": null, "operationTypeId": 0, "operationType": null, "paymentMethodTypeId": 0, "paymentMethodType": null, "transactionTypeId": 0, "transactionType": null, "customerId": null, "customerPan": null, "cardTokenType": 1, "statusId": 0, "status": null, "merchantName": null, "merchantAddress": null, "merchantPhoneNumber": null, "merchantEmailAddress": null, "merchantWebsite": null, "authCode": null, "source": null, "cardholderAuthenticationMethodId": null, "cardholderAuthenticationMethod": null, "cvmResultMsg": null, "cardDataSourceId": null, "cardDataSource": null, "responseCode": null, "responseDescription": null, "cardProcessingDetails": { "authCode": "A0000", "mid": null, "tid": null, "cardCreditDebitTypeId": 2, "cardCreditDebitType": "Debit", "processCreditDebitTypeId": 1, "processCreditDebitType": "Credit", "rrn": "10628361287F", "cardTypeId": 0, "cardType": null }, "achProcessingDetails": { "customerAccountNumber": null, "customerRoutingNumber": null, "accountHolderType": null, "accountHolderTypeId": 0, "accountType": null, "accountTypeId": 0, "taxId": null }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": null, "suggestedTips": null }, { "typeId": 8, "type": "TipAdjustment", "availableAmount": null, "suggestedTips": [ { "tipPercent": 5, "tipAmount": 10 }, { "tipPercent": 10, "tipAmount": 20 }, { "tipPercent": 15, "tipAmount": 30 } ] } ], "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": null, "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": null }, "emvTags": { "ac": "533C2902770EA987", "tvr": "0040040000", "tsi": null, "aid": "A0000000031010", "applicationLabel": "MasterCard", "rawTags": [ { "key": "5F34", "value": "SOMETHING" }, { "key": "5F35", "value": "SOMETHING" } ] }, "orderNumber": "752314" }, "transactionId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "transactionDateTime": "2025-12-16T10:35:52.461734Z", "typeId": 1, "type": "Authorization", "statusId": 7, "status": "PartiallyAuthorized", "details": { "hostResponseCode": "00", "hostResponseMessage": "APPROVAL", "hostResponseDefinition": "Approved and completed", "code": "Approve", "message": "Success", "processorResponseCode": null, "authCode": "VTLMC1", "maskedPan": null } } }, "Sale response": { "description": "Transaction, type Sale, status = Captured. Transaction status after approved sale or capture request", "value": { "processedAmount": 10, "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": "0", "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": "The street address and ZIP Code match the information on file." }, "transactionReceipt": { "transactionId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "transactionDateTime": "2026-12-16T10:35:52.000000Z", "amount": { "baseAmount": 0, "percentageOffAmount": 0, "percentageOffRate": 0, "cashDiscountAmount": 0, "cashDiscountRate": 0, "surchargeAmount": 0, "surchargeRate": 0, "tipAmount": 0, "tipRate": 0, "totalAmount": 0 }, "currencyId": 0, "currency": null, "processorId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "processor": null, "operationTypeId": 0, "operationType": null, "paymentMethodTypeId": 0, "paymentMethodType": null, "transactionTypeId": 0, "transactionType": null, "customerId": null, "customerPan": null, "cardTokenType": 1, "statusId": 0, "status": null, "merchantName": null, "merchantAddress": null, "merchantPhoneNumber": null, "merchantEmailAddress": null, "merchantWebsite": null, "authCode": null, "source": null, "cardholderAuthenticationMethodId": null, "cardholderAuthenticationMethod": null, "cvmResultMsg": null, "cardDataSourceId": null, "cardDataSource": null, "responseCode": null, "responseDescription": null, "cardProcessingDetails": { "authCode": "A0000", "mid": null, "tid": null, "cardCreditDebitTypeId": 2, "cardCreditDebitType": "Debit", "processCreditDebitTypeId": 1, "processCreditDebitType": "Credit", "rrn": "10628361287F", "cardTypeId": 0, "cardType": null }, "achProcessingDetails": { "customerAccountNumber": null, "customerRoutingNumber": null, "accountHolderType": null, "accountHolderTypeId": 0, "accountType": null, "accountTypeId": 0, "taxId": null }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": null, "suggestedTips": null }, { "typeId": 8, "type": "TipAdjustment", "availableAmount": null, "suggestedTips": [ { "tipPercent": 5, "tipAmount": 10 }, { "tipPercent": 10, "tipAmount": 20 }, { "tipPercent": 15, "tipAmount": 30 } ] } ], "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": null, "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": null }, "emvTags": { "ac": "533C2902770EA987", "tvr": "0040040000", "tsi": null, "aid": "A0000000031010", "applicationLabel": "MasterCard", "rawTags": [ { "key": "5F34", "value": "SOMETHING" }, { "key": "5F35", "value": "SOMETHING" } ] }, "orderNumber": "752314" }, "transactionId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "transactionDateTime": "2025-12-16T10:35:52.4617457Z", "typeId": 2, "type": "Sale", "statusId": 2, "status": "Captured", "details": { "hostResponseCode": "00", "hostResponseMessage": "APPROVAL", "hostResponseDefinition": "Approved and completed", "code": "Approve", "message": "Success", "processorResponseCode": null, "authCode": "VTLMC1", "maskedPan": null } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/settle": { "post": { "tags": [ "Transactions" ], "summary": "Settles a Transaction", "operationId": "pay_api_v1_transactions_settle", "description": "POST {{baseURL}}/pay-api/v1/transactions/settle\n\nThis endpoint settles, or completes, a transaction.\n\nA settlement transaction is the step in the payment process when an authorized transaction is finalized.\nThe funds are transferred to the merchant's acquiring bank.\n\nSee Also:
\nTo authorize a transaction, see `POST /pay-api/v1/transactions/auth`
\nTo refund a settled transaction, see `POST /pay-api/v1/transactions/return`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Settle.IsvSettleRequest" }, "example": { "paymentProcessorId": "b72b54b3-de02-430c-80c3-2908167d817c" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Settle.IsvSettleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/void": { "post": { "tags": [ "Transactions" ], "summary": "Voids a Transaction", "operationId": "pay_api_v1_transactions_void", "description": "POST {{baseURL}}/pay-api/v1/transactions/void\n\nThis endpoint voids or cancels a transaction payment before it is processed or settled.\n\nThe transaction cannot be voided after it has been captured.\n\nSee Also:
\nTo authorize a transaction, see `POST /pay-api/v1/transactions/auth`
\nTo refund a settled transaction, see `POST /pay-api/v1/transactions/return`
\nTo capture an amount for funds transfer, see `POST /pay-api/v1/transactions/capture`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Void.IsvVoidRequest" }, "example": { "transactionId": "881eabbc-6138-4677-9d37-592e7dca46f3" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvTransactionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/tip-adjustment": { "post": { "tags": [ "Transactions" ], "summary": "Adjusts a Tip", "operationId": "pay_api_v1_transactions_tip_adjustment", "description": "POST {{baseURL}}/pay-api/v1/transactions/tip-adjustment\n\nThis endpoint adjusts the tip amount.\n\nThis must be on a previously authorized transaction before settlement.\nTypically, the transaction is authorized first and for the base amount only.\nThis endpoint adds an additional amount, the tip, above that base amount.\nThe total amount from the original base amount is adjusted with the tip amount for settlement.\n\nSee Also:
\nTo authorize a transaction, see `POST /pay-api/v1/transactions/auth`\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.TipAdjustment.TipAdjustmentRequest" }, "example": { "transactionId": "f7b48aea-0b3a-40a6-b005-c2d840f71ff7", "tipAmount": 10 } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvTransactionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/{id}/send-transaction-receipt-by-sms": { "post": { "tags": [ "Transactions" ], "summary": "Sends Transaction Receipt by SMS", "operationId": "pay_api_v1_transactions_{id}_send_transaction_receipt_by_sms", "description": "POST {{baseURL}}/pay-api/v1/transactions/{{transactionId}}/send-transaction-receipt-by-sms\n\nThis endpoint sends a transaction receipt to the customer by SMS.\n", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "description": "Specifies the transaction identifier.\n\nExample: c7c15dd0-03e7-4e55-917c-54bedafba5e7\n", "schema": { "type": "string", "format": "uuid", "example": "c7c15dd0-03e7-4e55-917c-54bedafba5e7" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.SendReceiptBySms.SendIsvTransactionReceiptBySmsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.SendReceiptBySms.SendIsvTransactionReceiptBySmsRequest" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/calculate-amount": { "get": { "tags": [ "Transactions" ], "summary": "Calculates a Transaction Amount", "operationId": "pay_api_v1_transactions_calculate_amount", "description": "GET {{baseURL}}/pay-api/v1/transactions/calculate-amount\n\nThis endpoint calculates adjusts to the base transaction amount to be charged to the customer.\n\nThe amount considers applicable discounts, surcharges, and tips,\nThis includes any ZCP (zero cost processing) mode enabled for the merchant account, such as dual pricing, cash discounts, or credit card surcharges.\n\nThe calculated amounts are for information only.\nApplications, such as payment terminals or point of service devices, can display the appropriate values.\nFor example, clients could review the suggestions before submitting the payment.\n", "parameters": [ { "name": "amount", "in": "query", "description": "Specifies the base transaction amount before discounts and fees.\n\nExample: 29.49\n", "schema": { "type": "number", "format": "double", "example": 29.49 } }, { "name": "percentageOffRate", "in": "query", "description": "Specifies the percentage off or the discount rate.\n\nExample: 25 (for 25%)\n", "schema": { "type": "number", "format": "double", "example": 25 } }, { "name": "surchargeRate", "in": "query", "description": "Specifies the credit card surcharge rate.\n\nIt may be omitted to use the default credit card surcharge rate setting in the merchant account.\n\nExample: 15 (for 15%)\n", "schema": { "type": "number", "format": "double", "example": 15 } }, { "name": "tipAmount", "in": "query", "description": "Specifies the absolute amount (in USD) of tip to be added.\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.\n\n", "schema": { "type": "number", "format": "double", "example": 62.38 } }, { "name": "tipRate", "in": "query", "description": "Specifies the relative value of tip to be added.\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.\n\n\nExample: 18 (for 18%)\n", "schema": { "type": "number", "format": "double", "example": 18 } }, { "name": "currencyId", "in": "query", "description": "Specifies the the Aurora currency code.\n\nIt must be **1** (for USD).\n\nExample: 1\n", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "useCardPrice", "in": "query", "description": "Specifies to calculate the transaction amount for card payment.\n\nIf `true`, calculate transaction amount for card payment.
\nIf `false`, calculate transaction amount for cash or an ACH payment.\n\nExample: true\n", "schema": { "type": "boolean", "example": true, "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Amounts.IsvAmountsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/pay-api/v1/transactions/settings/autofill": { "get": { "tags": [ "Transaction Settings" ], "summary": "Gets Level 2-Level 3 autofill settings", "description": "GET {{baseURL}}/pay-api/v1/transactions/settings/autofill\n", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.TransactionSettings.GetAutofillSettingsResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } }, "put": { "tags": [ "Transaction Settings" ], "summary": "Updates Level 2-Level 3 autofill settings", "description": "PUT {{baseURL}}/pay-api/v1/transactions/settings/autofill\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.TransactionSettings.CreateAutofillSettingsRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } } }, "/sub-api/v1/subscriptions": { "get": { "tags": [ "Subscription" ], "summary": "Lists merchant's subscriptions", "operationId": "sub_api_v1_list_subscriptions", "description": "GET {{baseURL}}/sub-api/v1/subscriptions\n\nThis endpoint returns a list of the merchant's subscriptions.\n", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "search", "in": "query", "description": "
Specifies the term to search for.\n\nThe allows a partial such on the customer name.\nFor example, *Alexandro*, *Peppared*, *Alexandro Peppared* or *ppa* may be matched.\nSearch strings not found returns successfully but with an empty array.\n\nExample: Peppared\n", "schema": { "type": "string", "example": "Peppared" } }, { "name": "customerIds", "in": "query", "description": "
Specifies a single customer identifier.\n\nMultiple values are not supported.\n\nExample: 019d9cb4-c430-7b49-b232-a6a5d07c8371\n", "schema": { "type": "array", "items": { "type": "string", "format": "uuid", "example": "019d9cb4-c430-7b49-b232-a6a5d07c8371" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.InternalApi.Subscriptions.Get.GetSubscriptionResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "tags": [ "Subscription" ], "summary": "Creates a subscription", "operationId": "sub_api_v1_create_subscriptions", "description": "POST {{baseURL}}/sub-api/v1/subscriptions\n\nThis endpoint creates a subscription.\n\nA subscription is a recurring payment.\nThe client authorizes a transaction at regular intervals, such as weekly, monthly, or annually.\n\nPayments represent:\n* **Recurring billing**. The transaction happens automatically on a set schedule without the client having to re-enter payment details.\n* **Pre-authorization**. The customer approves transactions for future charges.\n* **Fixed or variable amounts**. The transaction can be the same every cycle, such as for a streaming service or vary based on usage, such as a utility bill)\n", "requestBody": { "description": "Request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.Subscriptions.Create.CreateSubscriptionRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.Subscriptions.Create.CreateSubscriptionResponseDto" }, "example": { "id": "5dd66afe-481a-4718-ad82-3d330a9735c6", "payNowSuccess": true, "transactionId": "798c3112-54c3-4ba9-b2aa-832d1f724024", "payNowResponse": null } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/sub-api/v1/subscriptions/{subscriptionId}": { "get": { "tags": [ "Subscription" ], "summary": "Retrieves a subscription by ID", "description": "GET {{baseURL}}/sub-api/v1/subscriptions/{subscriptionId}\n\nThis endpoint retrieves a specified subscription.\n", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "
Specifies the subscription identifier.\n\nExample: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58\n", "required": true, "schema": { "type": "string", "format": "uuid", "example": "79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.InternalApi.Subscriptions.Get.GetSubscriptionResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/sub-api/v1/subscriptions/{subscriptionId}/payments": { "get": { "tags": [ "Subscription" ], "summary": "Retrieves a subscription payment history", "description": "GET {{baseURL}}/sub-api/v1/subscriptions/{{subscriptionId}}/payments\n\nThis endpoint retrieves a history of payments for a specified subscription.\n", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "
Specifies the subscription identifier.\n\nExample: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58\n", "required": true, "schema": { "type": "string", "format": "uuid", "example": "79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "name": "hideCompletedAndPlanned", "in": "query", "description": "Specifies leaving out completed and planned payments from the history list.\n\nThe retrieved payment history list could excluded previously completed and planned payments.\n\nIf `true`, leaves out completed and planned payments.
\nIf `false`, includes completed and planned payments.\nThis includes in-progress, failed, pending, or actionable payments.\n\nExample: true\n", "example": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.Subscriptions.Isv.GetSubscriptionPayments.GetIsvSubscriptionPaymentsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/sub-api/v1/subscriptions/{subscriptionId}/terminate": { "put": { "tags": [ "Subscription" ], "summary": "Terminates a subscription", "description": "PUT {{baseURL}}/sub-api/v1/subscriptions/{{subscriptionId}}/terminate\n\nThis endpoint terminates, or cancels, an active subscription.\n\nThis action occurs immediately and cannot be undone.\n", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "
Specifies the subscription identifier.\n\nExample: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58\n", "required": true, "schema": { "type": "string", "format": "uuid", "example": "79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.InternalApi.Subscriptions.Terminate.TerminateSubscriptionResponse" }, "example": { "id": "055422f6-93a0-4872-9134-76153da2a0b9", "statusId": 5, "status": "Terminated", "message": "Subscription is terminated.\n\nFuture payments will no longer be processed. This action is permanent.\n" } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/pos-api/v1/pos-transactions": { "get": { "tags": [ "POS Transactions" ], "summary": "Gets POS transactions List of current merchant", "description": "GET {{baseURL}}/pos-api/v1/pos-transactions\n", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "terminalId", "in": "query", "description": "Specifies the terminal identifier.\n", "schema": { "type": "string", "format": "uuid", "example": "2428b5e7-6386-42ad-8b1c-d2a9032da4b3" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts.Page.Contracts.PosTransactions.Get.ListPosTransactionsResponseDto" }, "example": { "items": [ { "id": "8b6c7c7e-6c62-4e7a-9e0c-3d3c1c4d9f9d", "createdOn": "2025-12-14T10:35:52.2082639+00:00", "terminalId": "c2a1a3c2-2d9e-4c0e-b0f4-6a7b5f1e2d11", "posTransactionStatusId": 6, "posTransactionStatus": "Completed", "transactionId": "1f7e3d2a-9c4b-4c7d-8b7e-2a3c4d5e6f70", "amount": 10, "currencyId": 1, "targetTransactionId": null, "transactionTypeId": 2, "transactionType": "Sale", "isCompleted": true } ], "total": 100 } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "tags": [ "POS Transactions" ], "summary": "Creates a POS transaction", "description": "POST {{baseURL}}/pos-api/v1/pos-transactions\n\nInitiate a new transaction on the terminal device with predefined information, such as amount and transaction type.\n", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosService.Contracts.PosTransactions.Create.CreatePosTransactionRequestDto" }, "example": { "posDeviceId": "000000001", "referenceId": "10001", "transactionTypeId": 2, "targetTransactionId": null, "amount": 10, "useCardPrice": null, "currencyId": 1, "paymentProcessorId": "d9c3a8b1-6e2d-4f7c-a1b2-3c4d5e6f7a81", "terminalId": "3a7c9d1e-5b2f-4c8a-9d7e-1a2b3c4d5e92", "customerId": null, "waitForAcceptanceByTerminal": false, "readingMethodId": null, "requestPaymentMethodStorageConsent": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosService.Contracts.PosTransactions.PosTransactionResponseDto" }, "examples": { "Create": { "value": { "posTransactionId": "6f1a2b3c-4d5e-4f6a-b7c8-9d0e1f2a3b03", "statusId": 1, "status": "TerminalConnecting" } }, "Cancel": { "value": { "posTransactionId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "statusId": 4, "status": "CancelByPos" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/pos-api/v1/pos-transactions/{id}": { "get": { "tags": [ "POS Transactions" ], "summary": "Gets POS transaction by ID", "description": "GET {{baseURL}}/pos-api/v1/pos-transactions/{{posTransactionsid}}\n\nGets POS transaction by ID\n", "parameters": [ { "name": "posTransactionsid", "in": "path", "description": "ID of POS transaction", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "waitForTransactionProcessing", "in": "query", "description": "
Specifies the transaction to wait for a transition to one of completed statuses or a timeout. \n\nIf `true`, transaction is to wait for a transition.
\nIf `false`, transaction is not to wait for a transition.\n\nExample: true\n", "schema": { "type": "boolean", "default": false, "example": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosService.Contracts.PosTransactions.Get.GetPosTransactionResponseDto" }, "example": { "id": "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36", "createdOn": "2025-12-14T10:35:52.2318791+00:00", "modifiedOn": "2025-12-15T10:35:52.2318812Z", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "customerId": null, "terminalId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "paymentProcessorId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "posDeviceId": "000000001", "referenceId": "10001", "posTransactionStatusId": 6, "posTransactionStatus": "Completed", "transactionId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "amount": 10, "currencyId": 1, "targetTransactionId": null, "transactionTypeId": 2, "transactionType": "Sale", "isCompleted": true, "transaction": { "transactionId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "amount": 10, "currencyId": 1, "transactionStatusId": 2, "transactionStatus": "Captured", "transactionTypeId": 2, "transactionType": "Sale", "authCode": "0000A", "mid": "43252511", "tid": "8820432549239101" }, "transactionReceipt": { "transactionId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "transactionDateTime": "2025-12-16T10:35:52.4081694Z", "amount": { "baseAmount": 0, "percentageOffAmount": 0, "percentageOffRate": 0, "cashDiscountAmount": 0, "cashDiscountRate": 0, "surchargeAmount": 0, "surchargeRate": 0, "tipAmount": 0, "tipRate": 0, "totalAmount": 0 }, "currencyId": 0, "currency": null, "processorId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "processor": null, "operationTypeId": 0, "operationType": null, "paymentMethodTypeId": 0, "paymentMethodType": null, "transactionTypeId": 0, "transactionType": null, "customerId": null, "customerPan": null, "cardTokenType": 1, "statusId": 0, "status": null, "merchantName": null, "merchantAddress": null, "merchantPhoneNumber": null, "merchantEmailAddress": null, "merchantWebsite": null, "authCode": null, "source": null, "cardholderAuthenticationMethodId": null, "cardholderAuthenticationMethod": null, "cvmResultMsg": null, "cardDataSourceId": null, "cardDataSource": null, "responseCode": null, "responseDescription": null, "cardProcessingDetails": { "authCode": "A0000", "mid": null, "tid": null, "cardCreditDebitTypeId": 2, "cardCreditDebitType": "Debit", "processCreditDebitTypeId": 1, "processCreditDebitType": "Credit", "rrn": "10628361287F", "cardTypeId": 0, "cardType": null }, "achProcessingDetails": { "customerAccountNumber": null, "customerRoutingNumber": null, "accountHolderType": null, "accountHolderTypeId": 0, "accountType": null, "accountTypeId": 0, "taxId": null }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": null, "suggestedTips": null }, { "typeId": 8, "type": "TipAdjustment", "availableAmount": null, "suggestedTips": [ { "tipPercent": 5, "tipAmount": 10 }, { "tipPercent": 10, "tipAmount": 20 }, { "tipPercent": 15, "tipAmount": 30 } ] } ], "avsResponse": { "actionId": 1, "action": "Allow", "responseCode": null, "groupId": 5, "group": "ValidGroup", "resultId": 1, "result": "Passed", "codeDescription": null }, "emvTags": { "ac": "533C2902770EA987", "tvr": "0040040000", "tsi": null, "aid": "A0000000031010", "applicationLabel": "MasterCard", "rawTags": [ { "key": "5F34", "value": "SOMETHING" }, { "key": "5F35", "value": "SOMETHING" } ] }, "orderNumber": "752314" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } } } } }, "/pos-api/v1/pos-transactions/{id}/cancel": { "post": { "tags": [ "POS Transactions" ], "summary": "Cancels a POS transaction by ID", "description": "POST {{baseURL}}/pos-api/v1/pos-transactions/{{posTransactionsid}}/cancel\n\nCancels a POS transaction by ID\n", "parameters": [ { "name": "posTransactionsid", "in": "path", "description": "ID of POS transaction", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosService.Contracts.PosTransactions.PosTransactionResponseDto" }, "examples": { "Create": { "value": { "posTransactionId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "statusId": 1, "status": "TerminalConnecting" } }, "Cancel": { "value": { "posTransactionId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "statusId": 4, "status": "CancelByPos" } } } } } } } } }, "/pos-api/v1/pos-transactions/{posTransactionId}/print": { "post": { "tags": [ "POS Transactions" ], "summary": "Prints a POS transaction Receipt", "description": "POST {{baseURL}}/pos-api/v1/pos-transactions/{{posTransactionId}}/print\n\nThis endpoint allows semi-integrated ISVs to trigger a physical reprint of a\ncompleted transaction receipt directly from the POS terminal.\n\nIt supports customer requests for duplicate receipts in-person, enabling a\nseamless merchant experience.\n", "parameters": [ { "name": "posTransactionId", "in": "path", "description": "ID of POS transaction", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Print request payload must include required terminalId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosService.Contracts.PosTransactions.PrintTransactionReceipt.PrintTransactionReceiptRequestDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pos-api/v1/terminals": { "get": { "tags": [ "Terminals" ], "summary": "Lists merchant terminals", "description": "GET {{baseURL}}/pos-api/v1/terminals\n", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "deliveryStatusId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "serialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "manufacturerIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "modelIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contracts.Page.Contracts.Terminals.List.GetTerminalsResponseDto" }, "example": { "items": [ { "id": "b4fd53c7-bcc0-4c5c-aab8-1024983f315b", "merchantId": "8c2a42d1-9875-42e0-84a9-71f2fa5b4b9b", "serialNumber": "SN00000001", "terminalManufacturer": "SUNMI", "terminalModel": "Pro 1", "deliveryStatusId": 3, "deliveryStatusName": "Active", "createdOn": "2025-12-16T10:35:52.2487759Z", "modifiedOn": "2025-12-16T10:35:52.2487761Z", "merchantCompanyName": "Merchant", "terminalModeId": 1, "terminalModeName": "Standalone", "connectionStatusId": 2, "connectionStatus": "Offline", "lastSeenTimestamp": "2025-12-16T09:35:52.2487774Z" } ], "total": 3 } } } } } } }, "/pos-api/v1/terminals/{id}/status": { "get": { "tags": [ "Terminals" ], "summary": "Retrieves a merchant's terminal POS status by ID", "description": "GET {{baseURL}}/pos-api/v1/terminals/{{terminalId}}/status\n\nRetrieves the current status and details of a terminal device. \n\nThis endpoint provides the latest available information about a terminal,\nupdated in near real-time. \n\nDepending on the terminal's internet connectivity and operational status,\nthe response may include limited terminal data.\n", "parameters": [ { "name": "terminalId", "in": "path", "description": "TerminalId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosService.Contracts.Terminals.Status.Retrieve.RetrieveTerminalStatusResponseDto" }, "example": { "terminalPosStatusId": 1, "terminalPosStatus": "Active", "terminalId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "timestamp": "0001-01-01T00:00:00", "connectionStatusId": 1, "connectionStatus": "0", "connectionTypeId": null, "connectionType": null, "wifiConnectionStrength": 0, "mobileConnectionStrength": 0, "lastSeenTimestamp": null, "debitPinKeyId": null, "debitPinKey": null, "availabilityStatusId": null, "availabilityStatus": null, "ariseTerminalVersion": null, "batteryLevel": 0, "printerStatusId": null, "printerStatus": null, "deviceSoftwareDetails": null } } } } } } }, "/pay-int-api/categories": { "post": { "tags": [ "Categories" ], "summary": "Creates a new category", "description": "POST {{baseURL}}/pay-int-api/categories\n\nCategory Name must be unique in the merchant account.\n", "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The category creation request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Create.CreateIsvCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Categories.Create.CreateCategoryResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } }, "get": { "tags": [ "Categories" ], "summary": "Retrieves a list of categories", "description": "GET {{baseURL}}/pay-int-api/categories\n", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "search", "in": "query", "description": "Gets or sets the search query to filter categories.", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Get.GetIsvCategoriesPageResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/categories/{categoryId}": { "delete": { "tags": [ "Categories" ], "summary": "Deletes a category by its ID", "description": "DELETE {{baseURL}}/pay-int-api/categories/{{categoryId}}\n\nThis category will not be available in the catalog.\n\nItems linked to this category will still be in the catalog with empty\ncategory.\n", "parameters": [ { "name": "categoryId", "in": "path", "required": true, "description": "The ID of the category to delete.", "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Category deleted successfully" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } } } }, "put": { "tags": [ "Categories" ], "summary": "Updates a category by its ID", "description": "PUT {{baseURL}}/pay-int-api/categories/{{categoryId}}\n\nThe category name must be unique in the merchant account.\n", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The category update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Update.UpdateCategoryRequest" } } } }, "responses": { "200": { "description": "Category updated successfully" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/invoices": { "post": { "tags": [ "Invoices" ], "summary": "Creates an invoice", "description": "POST {{baseURL}}/pay-int-api/invoices\n", "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The invoice creation request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Create.CreateIsvInvoiceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.Create.CreateInvoiceResponseDto" } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } }, "get": { "tags": [ "Invoices" ], "summary": "Retrieves a list of invoices", "description": "GET {{baseURL}}/pay-int-api/invoices\n", "parameters": [ { "name": "issueDateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "issueDateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dueDateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dueDateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "paymentDateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "paymentDateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "status", "in": "query", "description": "Possible values:\n\n| Value | Name |\n|-------|-------------------|\n| 1 | Draft |\n| 2 | Published |\n| 3 | Paid |\n| 4 | Expired |\n| 5 | Canceled |\n| 6 | ProcessingPayment |\n| 7 | Refunded |\n\nExample: 2\n", "example": 2, "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.InvoiceStatus" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/asc" }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Get.GetIsvInvoicesPageResponse" } } } } } } }, "/pay-int-api/invoices/{invoiceId}": { "get": { "tags": [ "Invoices" ], "summary": "Retrieves an invoice's details", "description": "GET {{baseURL}}/pay-int-api/invoices/{{invoiceId}}\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Get.GetIsvInvoiceResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } }, "put": { "tags": [ "Invoices" ], "summary": "Updates a specific invoice", "description": "PUT {{baseURL}}/pay-int-api/invoices/{{invoiceId}}\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The invoice update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Update.UpdateIsvInvoiceRequest" } } } }, "responses": { "200": { "description": "Invoice updated successfully." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } }, "delete": { "tags": [ "Invoices" ], "summary": "Deletes an invoice", "description": "DELETE {{baseURL}}/pay-int-api/invoices/{{invoiceId}}\n\nYou can't delete published invoices.\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invoice deleted successfully." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/invoices/{id}/submit": { "post": { "tags": [ "Invoices" ], "summary": "Submits an invoice for processing", "description": "POST {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/submit\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice to submit.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details for invoice submission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Submit.SubmitIsvInvoiceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Submit.SubmitIsvInvoiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/invoices/{invoiceId}/ach/submit": { "post": { "tags": [ "Invoices" ], "summary": "Submits an ACH invoice for processing", "description": "POST {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/ach/submit\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice to submit.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details for invoice submission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SubmitAch.SubmitIsvAchInvoiceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Submit.SubmitIsvInvoiceResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/pay-int-api/invoices/{invoiceId}/calculations": { "get": { "tags": [ "Invoices" ], "summary": "Gets the calculations for an invoice", "description": "GET {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/calculations\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Calculations.GetIsvInvoiceCalculationsResponse" } } } } } } }, "/pay-int-api/invoices/publish": { "post": { "tags": [ "Invoices" ], "summary": "Publishes an invoice", "description": "POST {{baseURL}}/pay-int-api/invoices/publish\n", "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details for publishing the invoice.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Publish.PublishIsvInvoiceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Publish.PublishIsvInvoiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/invoices/{invoiceId}/cancel": { "put": { "tags": [ "Invoices" ], "summary": "Cancels an invoice", "description": "PUT {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/cancel\n\nOnly invoices in published(Due, Past Due) status and not paid can be\ncanceled.\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice to cancel.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invoice cancelled successfully." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/invoices/{invoiceId}/mark-as-paid": { "put": { "tags": [ "Invoices" ], "summary": "Marks an invoice as paid", "description": "PUT {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/mark-as-paid\n\nOnly invoices in published(Due, Past Due) status and not paid can be marked\nas paid.\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice to mark as paid.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the payment details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Update.UpdateIsvInvoiceStatusRequest" } } } }, "responses": { "200": { "description": "Invoice marked as paid successfully." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/invoices/{invoiceId}/send-published-sms-notification": { "post": { "tags": [ "Invoices" ], "summary": "Sends an SMS notification for a published invoice", "description": "POST {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/send-email-notification\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice for which to send the notification.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details for the SMS notification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SendInvoicePublishedSmsNotification.SendIsvInvoicePublishedSmsNotificationRequest" } } } }, "responses": { "200": { "description": "SMS notification sent successfully." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/invoices/{invoiceId}/download-pdf": { "get": { "tags": [ "Invoices" ], "summary": "Downloads an invoice as a PDF document", "description": "GET {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/download-pdf\n\nAvailable only for published invoices.\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/invoices/{invoiceId}/send-email-notification": { "post": { "tags": [ "Invoices" ], "summary": "Sends an Email notification for the invoice", "description": "POST {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/send-published-sms-notification\n", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The identifier of the invoice for which to send the notification.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details for the Email notification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SendInvoiceEmailNotification.SendInvoiceEmailNotificationRequest" } } } }, "responses": { "200": { "description": "Email notification sent successfully." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/merchants/{merchantId}/invoices/settings": { "get": { "tags": [ "Invoices Settings" ], "summary": "Retrieves a merchant's invoice settings by ID", "description": "GET {{baseURL}}/pay-int-api/merchants/{{merchantId}}/invoices/settings\n", "parameters": [ { "name": "merchantId", "in": "path", "required": true, "description": "Specifies the identifier of the merchant.\n", "schema": { "type": "string", "format": "uuid", "example": "46063d32-10fa-44cb-b118-20ddd085ce3f" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.InvoiceSettings.Get.GetIsvInvoiceSettingsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ForbiddenExceptionExample" }, "example": { "details": "Forbidden to access Id 'f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25' with type='.DataAccess.Entities.Entity'", "statusCode": 403, "source": "", "exceptionType": "Exceptions.ForbiddenException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } }, "put": { "tags": [ "Invoices Settings" ], "summary": "Updates invoice settings for a specific merchant", "description": "PUT {{baseURL}}/pay-int-api/merchants/{{merchantId}}/invoices/settings\n", "parameters": [ { "name": "merchantId", "in": "path", "required": true, "description": "Specifies the identifier of the merchant.\n", "schema": { "type": "string", "format": "uuid", "example": "46063d32-10fa-44cb-b118-20ddd085ce3f" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The invoice settings update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.InvoiceSettings.Update.UpdateIsvInvoiceSettingsRequest" } } } }, "responses": { "200": { "description": "Invoice settings updated successfully" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ForbiddenExceptionExample" }, "example": { "details": "Forbidden to access Id 'f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25' with type='.DataAccess.Entities.Entity'", "statusCode": 403, "source": "", "exceptionType": "Exceptions.ForbiddenException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/line-items": { "post": { "tags": [ "Line Items" ], "summary": "Creates a line item", "description": "POST {{baseURL}}/pay-int-api/line-items\n", "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The line item creation request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Create.CreateIsvLineItemRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Create.CreateIsvLineItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } } } }, "get": { "tags": [ "Line Items" ], "summary": "Retrieves line items", "description": "GET {{baseURL}}/pay-int-api/line-items\n", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "categoryId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "noCategory", "in": "query", "schema": { "type": "boolean" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Get.GetIsvLineItemsPageResponse" } } } } } } }, "/pay-int-api/line-items/{lineItemId}": { "put": { "tags": [ "Line Items" ], "summary": "Updates a specific line item", "description": "PUT {{baseURL}}/pay-int-api/line-items/{{lineItemId}}\n", "parameters": [ { "name": "lineItemId", "in": "path", "description": "The ID of the line item to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The line item update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Update.UpdateIsvLineItemRequest" } } } }, "responses": { "200": { "description": "Line item updated successfully" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } } } }, "delete": { "tags": [ "Line Items" ], "summary": "Deletes a line item", "description": "DELETE {{baseURL}}/pay-int-api/line-items/{{lineItemId}}\n", "parameters": [ { "name": "lineItemId", "in": "path", "description": "The ID of the line item to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Line item deleted successfully" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/line-items/unit-types": { "get": { "tags": [ "Line Items" ], "summary": "Retrieves the available unit types for line items", "description": "GET {{baseURL}}/pay-int-api/line-items/unit-types\n", "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Get.GetIsvLineItemUnitTypesResponse" } } } } } } } }, "/pay-int-api/payment-sessions": { "post": { "tags": [ "Payment Sessions" ], "summary": "Creates new payment session", "operationId": "pay_int_api_payment_sessions", "description": "POST {{baseURL}}/pay-int-api/payment-sessions\n\nThis endpoint creates a payment session object.\n\nThe client, typically a frontend or checkout page, can use to securely collect payment details and process a transaction.\n\nAlthough it is not required, we encourage using it.\nUsing a payment session :\n* protects payments from duplicating charges\n* manages complex flows, such as those with tips, surcharges, discounts, and authorization steps.\n* offers fraud protection.\n", "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "Payment session creation request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PaymentSessions.Create.CreatePaymentSessionRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PaymentSessions.Create.CreatePaymentSessionResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/payment-sessions/{paymentSessionId}/cancel": { "post": { "tags": [ "Payment Sessions" ], "summary": "Cancels the payment session", "description": "POST {{baseURL}}/pay-int-api/payment-sessions/{{paymentSessionId}}/cancel\n", "parameters": [ { "name": "paymentSessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Payment session cancelled successfully" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='.DataAccess.Entities.Entity'", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample" }, "example": { "details": null, "statusCode": 500, "source": "", "exceptionType": "Exceptions.IntegrationException", "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70", "entityId": null, "errorCode": null } } } } } } }, "/pay-int-api/payment-sessions/{paymentSessionId}": { "get": { "tags": [ "Payment Sessions" ], "summary": "Gets payment session details by ID", "operationId": "pay_int_api_payment_sessions_{paymentSessionId}", "description": "GET {{baseURL}}/pay-int-api/payment-sessions/{{paymentSessionId}}\n\nThis endpoint returns the details of the specified payment session.\n", "parameters": [ { "name": "paymentSessionId", "in": "path", "required": true, "description": "Specifies the identifier of the payment session to get the status and details.\n", "schema": { "type": "string", "format": "uuid", "example": "fffa1259-272a-4bf3-a197-a5757c26eccb" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionIsvResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } }, "/pay-int-api/ping": { "get": { "tags": [ "Ping" ], "summary": "Pings the terminal", "description": "GET {{baseURL}}/pay-int-api/ping\n\nThis endpoint pings the terminal to check the current status and context.\n", "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.WebApi.Isv.Controllers.PingController.PingResponse" } }, "application/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.WebApi.Isv.Controllers.PingController.PingResponse" } }, "text/json; x-api-version=1.0": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.WebApi.Isv.Controllers.PingController.PingResponse" } } } } } } }, "/pay-int-api/quick-payments/one-time": { "post": { "tags": [ "Quick Payments" ], "summary": "Creates a one-time payment link", "description": "POST {{baseURL}}/pay-int-api/quick-payments/one-time\n\nThis endpoint creates link for a one-time payment.\n\nA one-time is one that can be used only once and then it expires. \nThis can be used for cases like purchases or fee payments. \nIt is limited to only one person. \nA one-time is in contrast to a reusable payment payment that can be use multiple times by different people.\n\nThe link must be activated before use as a security feature.\nTo activate a one-time payment link, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate`\n\nThe link remains active until one of the following occurs:\n* The customer completes the payment.\n* The link is manually deactivated.\n* The link's time limit expires.\n\nSee Also:
\nTo activate a link, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate`
\nTo send a one-time payment link to a customer, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification`
\nTo deactivate a link, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`
\nTo get a list of all one-time payments links, see `GET /pay-int-api/quick-payments/one-time`
\nTo get details for a specified one-time payments link, see `POST /pay-int-api/quick-payments/one-time/{{quickPaymentId}}`\n", "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The one-time payment link creation request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Create.CreateIsvOneTimeQuickPaymentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Create.CreateIsvOneTimeQuickPaymentResponse" } } } } } }, "get": { "tags": [ "Quick Payments" ], "summary": "Gets list of one-time links", "description": "GET {{baseURL}}/pay-int-api/quick-payments/one-time\n\nThis endpoint returns a list of one-time payment links.\n\nThe links may be valid or expired.\n\nThe request may be filtered to limit returns to the specified search.\n\nSee Also:
\nTo create a one-time payment and link, see `POST /pay-int-api/quick-payments/one-time`
\nTo see the details of a specified one-time payment, see `POST /pay-int-api/quick-payments/one-time/{{quickPaymentId}}`\n", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "search", "in": "query", "description": "Specifies a term to search for.\n\nExample: contactName\n", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.GetPage.GetIsvOneTimeQuickPaymentPageResponse" } } } } } } }, "/pay-int-api/quick-payments/one-time/{quickPaymentId}": { "get": { "tags": [ "Quick Payments" ], "summary": "Gets details of a one-time link", "description": "POST {{baseURL}}/pay-int-api/quick-payments/one-time/{{quickPaymentId}}\n\nThis endpoint returns the details of a one-time payment.\n\nThe link may be valid or expired.\n\nSee Also:
\nTo create a one-time payment and link, see `POST /pay-int-api/quick-payments/one-time`
\nTo see a list of one-time payments, see `GET /pay-int-api/quick-payments/one-time`\n", "parameters": [ { "$ref": "#/components/parameters/quickpaymentid" }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Get.GetIsvOneTimeQuickPaymentResponse" } } } } } } }, "/pay-int-api/quick-payments/{quickPaymentId}/activate": { "post": { "tags": [ "Quick Payments" ], "summary": "Activates a payment link", "description": "POST {{baseURL}}/pay-int-api/quick-payments/{{quickPaymentId}}/activate\n\nThis endpoint manually activates a one-time payment link.\n\nA created one-time payment link must be activated before using it.\n\nSee Also:
\nTo create a one-time payment link, see `POST /pay-int-api/quick-payments/one-time`
\nTo send a one-time payment link to a customer, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification`
\nTo manually deactivate a link, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`
\nTo get a list of all one-time payments links, see `GET /pay-int-api/quick-payments/one-time`
\nTo get details for a specified one-time payments link, see `POST /pay-int-api/quick-payments/one-time/{{quickPaymentId}}`\n", "parameters": [ { "$ref": "#/components/parameters/quickpaymentid" }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/pay-int-api/quick-payments/{quickPaymentId}/deactivate": { "post": { "tags": [ "Quick Payments" ], "summary": "Deactivates a payment link", "description": "POST {{baseURL}}/pay-int-api/quick-payments/{{quickPaymentId}}/deactivate\n\nThis endpoint manually deactivates a one-time payment link.\nThe link can also be manually deactivated any time after it is created but before the Customer completes payment.\n\nThe link can be deactivated and cannot be used in the following situations:\n* The payment is made.\n* The link is manually deactivated.\n* The link's time limit expires.\n\nSee Also:
\nTo create a one-time payment link, see `POST /pay-int-api/quick-payments/one-time`
\nTo manually activate a link, see `POST POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate`
\nTo send a one-time payment link to a customer, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification`
\nTo get a list of all one-time payments links, see `GET /pay-int-api/quick-payments/one-time`
\nTo get details for a specified one-time payments link, see `POST /pay-int-api/quick-payments/one-time/{{quickPaymentId}}`\n", "parameters": [ { "name": "quickPaymentId", "$ref": "#/components/parameters/quickpaymentid" }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/pay-int-api/quick-payments/{quickPaymentId}/send-sms-notification": { "post": { "tags": [ "Quick Payments" ], "summary": "Sends a link by SMS", "description": "POST {{baseURL}}/pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification\n\nThis endpoint sends a one-time payment link to a customer through SMS.\n\nSee Also:
\nTo create a one-time payment link, see `POST /pay-int-api/quick-payments/one-time`
\nTo activate a link, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate`
\nTo deactivate a link, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`
\nTo get a list of all one-time payments links, see `GET /pay-int-api/quick-payments/one-time`
\nTo get details for a specified one-time payments link, see `POST /pay-int-api/quick-payments/one-time/{{quickPaymentId}}`\n", "parameters": [ { "name": "quickPaymentId", "$ref": "#/components/parameters/quickpaymentid" }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details for the SMS notification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.SmsNotification.SendIsvQuickPaymentSmsNotificationRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/pay-int-api/quick-payments/reusable": { "post": { "tags": [ "Quick Payments" ], "summary": "Creates a reusable payment link", "description": "POST {{baseURL}}/pay-int-api/quick-payments/reusable\n\nThis endpoint creates link for a quick reusable payment.\n \nA reusable payment is one that can be used multiple times and remains active after each use.\nThis can be used for cases like donations or event registration fees.\nIt is not limited to the same person each time.\nA reusable payment is in contrast to the one-time payment that expires after a single time.\n\nThe link must be activated before use as a security feature.\nTo activate a reusable link, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate`\n\nThe link remains active until one of the following occurs:\n* The link is manually deactivated.\n* The link's time limit expires.\n\nSee Also:
\nTo deactivate a link, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`
\nTo get a list of all reusable payments links, see `GET /pay-int-api/quick-payments/reusable`
\nTo get details for a specified reusable link, see `POST /pay-int-api/quick-payments/reusable/{{quickPaymentId}}`}}`\n", "parameters": [ { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "The payment link creation request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.Create.CreateIsvReusableQuickPaymentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Create.CreateIsvOneTimeQuickPaymentResponse" } } } } } }, "get": { "tags": [ "Quick Payments" ], "summary": "Gets list of reusable links", "description": "GET {{baseURL}}/pay-int-api/quick-payments/reusable\n\nThis endpoint returns a list of reusable links.\n\nThe links may be valid or expired.\n\nThe request may be filtered to limit returns to the specified search.\n\nSee Also:
\nTo create a reusable payment link, see `POST /pay-int-api/quick-payments/reusable`
\nTo deactivate a link, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`
\nTo get details for a specified reusable link, see `POST /pay-int-api/quick-payments/reusable/{{quickPaymentId}}`}}\n", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pagesize" }, { "$ref": "#/components/parameters/orderby" }, { "$ref": "#/components/parameters/asc" }, { "name": "status", "in": "query", "description": "Payment link status.\n\nPossible values:\n\n| Status ID | Status | Description |\n| :-------: |-----------|-------------|\n| 1 | Active | The link is active and can be used. |\n| 2 | Inactive | The link is inactive and cannot be used. |\n| 3 | Expired | The link is inactive by timing out. |\n| 4 | Completed | The link is inactive by having been used successfully. |\n", "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.QuickPaymentStatus" } }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.GetPage.GetIsvReusableQuickPaymentPageResponse" } } } } } } }, "/pay-int-api/quick-payments/reusable/{quickPaymentId}": { "get": { "tags": [ "Quick Payments" ], "summary": "Gets details of a reusable link", "description": "POST {{baseURL}}/pay-int-api/quick-payments/reusable/{{quickPaymentId}}\n\nThis endpoint returns the details of a reusable payment.\n\nThe link may be valid or expired.\n\nSee Also:
\nTo create a reusable payment link, see `POST /pay-int-api/quick-payments/reusable`
\nTo deactivate a link, see `POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`
\nTo get details for a specified reusable link, see `POST /pay-int-api/quick-payments/reusable/{{quickPaymentId}}`}}`\n", "parameters": [ { "$ref": "#/components/parameters/quickpaymentid" }, { "name": "x-api-version", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.Get.GetIsvReusableQuickPaymentResponse" } } } } } } } }, "components": { "securitySchemes": { "Bearer": { "type": "http", "description": "Specify the authorization token.", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "PaymentGateway.Contracts.Enums.Ach.AchSECCode": { "type": "integer", "description": "
Specifies the SEC (standard entry class) code for the payment method.\n\nAllowed values:

\n\n| Type ID | Entry Type | Description |\n| :-----: |------------|-------------|\n| 1 | Web | Internet-initiated/mobile entries. Default value. |\n| 2 | PPD | Prearranged payment and deposit entries. |\n| 3 | CCD | Corporate credit or debit. |\n| 4 | Telephone | Telephone-initiated entries. |\n\nExample: 1\n", "example": 1, "format": "int32", "default": 1 }, "ach_paymentmethodid": { "type": "string", "description": "Indentifies the customer payment method identifier.\n\nExample: b6df8625-cd25-4123-b345-638aa7b5d011\n", "example": "b6df8625-cd25-4123-b345-638aa7b5d011", "format": "uuid", "nullable": true }, "ach_customerid": { "type": "string", "description": "Specifies the customer identifier.\n\nExample: 87d8e330-2878-4742-a86f-dbbb3bf522ac\n", "example": "87d8e330-2878-4742-a86f-dbbb3bf522ac", "format": "uuid", "nullable": true }, "ach_isfasterprocessing": { "type": "boolean", "default": false, "description": "Specifies ACH (automated clearing house) transaction has same day processing enabled.\n\nMust be empty or null for card subscriptions.\n\nIf `true`, same day processing is enabled.
\nIf `false`, same day processing is not enabled.\n\nExample: false\n", "example": false }, "ach_routingnumber": { "type": "string", "description": "Specifies the payment target's bank routing number.\n\nExample: 026009593\n", "example": "026009593", "nullable": true }, "ach_accountnumber": { "type": "string", "description": "Specifies the payment target's bank account number.\n\nExample: 5413591081013511\n", "example": "5413591081013511", "nullable": true }, "ach_taxid": { "type": "string", "description": "Specifies the customer's tax identifier (TIN).\n\nExample: 98-7654321\n", "example": "98-7654321", "nullable": true }, "PaymentGateway.Contracts.Enums.AccountType": { "type": "integer", "description": "Identifies the account type.\n\nPossible values:\n\n| Type ID | Account Type | Description |\n| :-----: |--------------|-------------|\n| 1 | Checking | Checking |\n| 2 | Savings | Savings |\n\nExample: 1\n", "example": 1, "format": "int32" }, "PaymentGateway.Contracts.Enums.AccountHolderType": { "type": "integer", "description": "Identifies the account holder type.\n\nPossible values:\n\n| Type ID | Account Type | Description |\n| :-----: |--------------|-------------|\n| 1 | Business | Business |\n| 2 | Personal | Personal |\n\nExample: 1\n", "example": 1, "format": "int32" }, "PaymentGateway.Contracts.Transactions.AddressDto": { "type": "object", "required": [ "city", "countryId" ], "description": "Specifies an object defining the address.\n", "properties": { "city": { "type": "string", "description": "Specifies the name of the city.\n\nExample: Chicago\n", "example": "Chicago", "nullable": true }, "countryId": { "type": "integer", "description": "Specifies the Aurora country identifier.\n\nExample: 1\n", "example": 1, "format": "int32", "nullable": true }, "line1": { "type": "string", "description": "Specifies the street address.\n\nExample: 322 Unicorn Boulevard\n", "example": "322 Unicorn Boulevard", "nullable": true }, "line2": { "type": "string", "description": "Specifies additional street address information.\n\nExample: Apt. Block 6\n", "example": "Apt. Block 6", "nullable": true }, "postalCode": { "type": "string", "minLength": 2, "maxLength": 15, "description": "Specifies the postal or ZIP code.\n\nExamples:
\n60601
\n60601-0001\n", "example": "60601-0001", "nullable": true }, "stateName": { "type": "string", "description": "Specifies the state identifier (in two-letter USPS [United States Postal Service] postal code).\n\nExamples:
\nIL
\nTX
\nWA\n", "example": "TX", "nullable": true }, "stateId": { "type": "integer", "description": "Specifies the Aurora US state or territory identifier code.\n\nExample: 1\n", "example": 1, "format": "int32", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Transactions.ContactInfoDto": { "type": "object", "required": [ "companyName" ], "properties": { "companyName": { "type": "string", "description": "Indicates the customer's company name.\n\nExample: Peppared Street Cafe\n", "example": "Peppared Street Cafe", "nullable": false }, "firstName": { "type": "string", "nullable": true, "description": "Indicates the customer's first name.\n\nExample: Alexandro\n", "example": "Alexandro" }, "lastName": { "type": "string", "nullable": true, "description": "Indicates the customer's last name.\n\nExample: Peppared\n", "example": "Peppared" }, "email": { "type": "string", "nullable": true, "description": "Indicates the customer's email.\n\nExample: peppared@example.com\n", "example": "peppared@example.com" }, "mobilePhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "Indicates the customer's mobile phone number.\n\nExample: +15551234567\n", "example": "+15551234567", "nullable": true }, "smsNotification": { "type": "boolean", "nullable": true, "default": false, "description": "Specifies the customer is sent an SMS notification.\n\nIf `true`, the customer is sent an SMS notification.
\nIf `false`, the customer is not sent an SMS notification.\n\nExample: true\n", "example": true } }, "additionalProperties": false, "description": "This group contains the customer's contact details.\n" }, "PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.CreateAchRefundRequest": { "required": [ "amount", "paymentProcessorId", "secCode", "requesterIPaddress", "paymentMethodId" ], "type": "object", "properties": { "amount": { "type": "number", "description": "Specifies the payment amount.\n\nExample: 129.99\n", "example": 129.99, "format": "double" }, "paymentProcessorId": { "type": "string", "description": "Specifies the ACHQ (ACH check) payment processor identifier.\n\nExample: f4e41489-aea6-4279-b6f1-e1f9bffd5358\n", "example": "f4e41489-aea6-4279-b6f1-e1f9bffd5358", "format": "uuid" }, "secCode": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.Ach.AchSECCode" }, "requesterIPaddress": { "type": "string", "maxLength": 45, "minLength": 1, "description": "Specifies the IP address of the end user.\n\nThis is an IPv4 or IPv6 address.\nThis may be the customer, operator, or application responsible for submitting the transaction.\n\nExamples:
\n192.168.1.1
\n2001:0db8:85a3:0000:0000:8a2e:0370:7334\n", "example": "192.168.1.1" }, "paymentMethodId": { "$ref": "#/components/schemas/ach_paymentmethodid" }, "customerId": { "$ref": "#/components/schemas/ach_customerid" }, "isFasterProcessing": { "$ref": "#/components/schemas/ach_isfasterprocessing" }, "routingNumber": { "$ref": "#/components/schemas/ach_routingnumber" }, "accountNumber": { "$ref": "#/components/schemas/ach_accountnumber" }, "taxId": { "$ref": "#/components/schemas/ach_taxid" }, "accountType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AccountType" }, "accountHolderType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AccountHolderType" }, "billingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto" }, "shippingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto" }, "contactInfo": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.ContactInfoDto" } }, "additionalProperties": false }, "ach_transactionid": { "type": "string", "format": "uuid", "description": "Indicates the transaction identifier.\n\nExample: bf5a1dc7-57b7-4fec-ab09-52c47c1acaff\n", "example": "bf5a1dc7-57b7-4fec-ab09-52c47c1acaff" }, "ach_typeid": { "type": "integer", "format": "int32", "description": "Indicates the Aurora ACH (automated clearing house) transaction type code.\n\nExample: 6\n", "example": 6 }, "ach_type": { "type": "string", "nullable": true, "description": "Indicates the Aurora ACH transaction type.\n\nExample: CardAuthentication\n", "example": "CardAuthentication" }, "ach_statusid": { "type": "integer", "format": "int32", "description": "Indicates the Aurora ACH transaction status code.\n\nExample: 1\n", "example": 1 }, "ach_status": { "type": "string", "nullable": true, "description": "Indicates the Aurora ACH transaction status type.\n\nExample: Authorized\n", "example": "Authorized" }, "ach_responsedescription": { "type": "string", "nullable": true, "description": "Indicates a free-formed description regarding the transaction.\n\nExample: Command Successful. Approved.\n", "example": "Command Successful. Approved." }, "ach_responsecode": { "type": "string", "nullable": true, "description": "Indicates a response code regarding the transaction.\n\nExample: 000\n", "example": "000" }, "PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchPaymentResponse": { "type": "object", "properties": { "transactionId": { "$ref": "#/components/schemas/ach_transactionid" }, "typeId": { "$ref": "#/components/schemas/ach_typeid" }, "type": { "$ref": "#/components/schemas/ach_type" }, "statusId": { "$ref": "#/components/schemas/ach_statusid" }, "status": { "$ref": "#/components/schemas/ach_status" }, "responseDescription": { "$ref": "#/components/schemas/ach_responsedescription" }, "responseCode": { "$ref": "#/components/schemas/ach_responsecode" }, "processedAmount": { "type": "number", "format": "double", "description": "Indicates the transaction amount (in USD).\n\nExample: 3500.00\n", "example": 3500 } }, "additionalProperties": false }, "AspNet.Swagger.Examples.ValidationExceptionExample": { "type": "object", "properties": { "details": { "type": "string", "nullable": true, "description": "Indicates details about the error.\n\nExample: Validation failed: -- Email: 'Email' is not a valid email address. Severity: Error\n", "example": "Validation failed: -- Email: 'Email' is not a valid email address. Severity: Error" }, "statusCode": { "type": "integer", "format": "int32", "nullable": true, "description": "Indicates the error code's status.\n", "example": 404 }, "source": { "type": "string", "nullable": true, "description": "Indicates the source of the error.\n\nExample: \n", "example": "" }, "exceptionType": { "type": "string", "nullable": true, "description": "Indicates the error's exception type.\n\nExample: FluentValidation.ValidationException\n", "example": "FluentValidation.ValidationException" }, "correlationId": { "type": "string", "nullable": true, "description": "Indicates the correlation identifier.\n\nExample: aa6cfcd0-0295-4a4c-b074-8c901f114fef\n", "example": "aa6cfcd0-0295-4a4c-b074-8c901f114fef" }, "entityId": { "type": "string", "nullable": true, "description": "Indicates the entity identifier.\n\nExample:
\n null\n" }, "errorCode": { "type": "string", "nullable": true, "description": "Indicates the error code.\n\nExample:
\nnull\n" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "description": "Indicates the precise error.\n\nExample:\n", "example": [ "Email" ], "nullable": true }, "nullable": true } }, "additionalProperties": false }, "AspNet.Swagger.Examples.NotFoundExceptionExample": { "type": "object", "properties": { "details": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "source": { "type": "string", "nullable": true }, "exceptionType": { "type": "string", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.CreateAchPaymentRequest": { "required": [ "amount", "paymentProcessorId", "secCode", "requesterIPaddress" ], "type": "object", "properties": { "amount": { "type": "number", "description": "Specifies the payment amount.\n\nExample: 129.99\n", "example": 129.99, "format": "double" }, "paymentProcessorId": { "type": "string", "description": "Specifies the ACHQ (ACH check) payment processor identifier.\n\nExample: f4e41489-aea6-4279-b6f1-e1f9bffd5358\n", "example": "f4e41489-aea6-4279-b6f1-e1f9bffd5358", "format": "uuid" }, "secCode": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.Ach.AchSECCode" }, "requesterIPaddress": { "type": "string", "maxLength": 45, "minLength": 1, "description": "Specifies the IP address of the end user.\n\nThis is an IPv4 or IPv6 address.\nThis may be the customer, operator, or application responsible for submitting the transaction.\n\nExamples:
\n192.168.1.1
\n2001:0db8:85a3:0000:0000:8a2e:0370:7334\n", "example": "192.168.1.1" }, "paymentMethodId": { "type": "string", "description": "Specifies the customer payment method identifier.\n\n\nProviding this value indicates the transaction uses a stored bank account.\nIf this value is included, customerId must also be included.\n\n\nExample: b6df8625-cd25-4123-b345-638aa7b5d011\n", "example": "b6df8625-cd25-4123-b345-638aa7b5d011", "format": "uuid", "nullable": true }, "customerId": { "type": "string", "description": "Specifies the customer identifier.\n\n\nProviding this value indicates the transaction uses a stored bank account.\nThis value is required if paymentMethodId is provided.\n\n
\n\nProviding this value without also providing paymentMethodId indicates the transaction does not use a stored bank account.\nIn this case, a new customer will automatically be generated.\n\n\nExample: 87d8e330-2878-4742-a86f-dbbb3bf522ac\n", "example": "87d8e330-2878-4742-a86f-dbbb3bf522ac", "format": "uuid", "nullable": true }, "routingNumber": { "type": "string", "description": "Specifies the payment target's bank routing number.\n\n\nThis value is required when the transaction is not using using a stored bank account.\n\n\nExample: 026009593\n", "example": "026009593", "nullable": true }, "accountNumber": { "description": "Specifies the payment target's bank account number.\n\n\nThis value is required when the transaction is not using using a stored bank account.\n\n\nExample: 5413591081013511\n", "example": "5413591081013511", "nullable": true }, "accountType": { "type": "integer", "description": "Identifies the account type.\n\n\nThis value is required when the transaction is not using using a stored bank account.\n\n\nPossible values:\n\n| Type ID | Account Type | Description |\n| :-----: |--------------|-------------|\n| 1 | Checking | Checking |\n| 2 | Savings | Savings |\n\nExample: 1\n", "example": 1, "format": "int32" }, "accountHolderType": { "type": "integer", "description": "Identifies the account holder type.\n\n\nThis value is required when the transaction not using using a stored bank account.\n\n\nPossible values:\n\n| Type ID | Account Type | Description |\n| :-----: |--------------|-------------|\n| 1 | Business | Business |\n| 2 | Personal | Personal |\n\nExample: 1\n", "example": 1, "format": "int32" }, "contactInfo": { "allOf": [ { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.ContactInfoDto" } ], "description": "\nThis object is required when the transaction is not using using a stored bank account.\n\n" }, "billingAddress": { "allOf": [ { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto" } ], "description": "\nThis object is required when the transaction is not using using a stored bank account.\n\n" }, "shippingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto" }, "isFasterProcessing": { "$ref": "#/components/schemas/ach_isfasterprocessing" }, "taxId": { "$ref": "#/components/schemas/ach_taxid" } }, "additionalProperties": false }, "AspNet.Swagger.Examples.InternalExceptionExample": { "type": "object", "properties": { "details": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "source": { "type": "string", "nullable": true }, "exceptionType": { "type": "string", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchResponse": { "type": "object", "properties": { "transactionId": { "$ref": "#/components/schemas/ach_transactionid" }, "typeId": { "$ref": "#/components/schemas/ach_typeid" }, "type": { "$ref": "#/components/schemas/ach_type" }, "statusId": { "$ref": "#/components/schemas/ach_statusid" }, "status": { "$ref": "#/components/schemas/ach_status" }, "responseDescription": { "$ref": "#/components/schemas/ach_responsedescription" }, "responseCode": { "$ref": "#/components/schemas/ach_responsecode" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Enums.ZeroCostProcessingOption": { "type": "integer", "description": "
Identifies the zero cost processing option.\n\nPossible values:\n\n| Id | Type |\n|:--:|--------------|\n| 1 | None |\n| 2 | CashDiscount |\n| 3 | DualPricing |\n| 4 | Surcharge |\n\nExample: 3\n", "example": 3, "format": "int32" }, "PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.EnumDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "Indicates the currency identifier.\n\nExample: 1 (for USD)\n", "example": 1 }, "name": { "type": "string", "description": "Indicates the currency (in ISO 4217 alpha-3 currency code format).\n\nExample: USD\n", "example": "USD", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.SettlementBatchTimeSlot": { "type": "object", "properties": { "hours": { "type": "integer", "format": "int32", "description": "Indicates the hour of the batch settlement.\n\nExamples:
\n09
\n15
\n" }, "minutes": { "type": "integer", "format": "int32", "description": "Indicates the minute of the batch settlement.\n\nExamples:
\n00
\n15
\n49
\n" }, "timezoneName": { "type": "string", "nullable": true, "description": "Indicates the time zone of the batch settlement.\n\nExample: America/New_York\n", "example": "America/New_York" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.PaymentProcessorDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Indicates the payment processor identifier.\n\nExample: 965865ef-b17d-4153-b952-d8902e584f7d\n", "example": "965865ef-b17d-4153-b952-d8902e584f7d", "format": "uuid" }, "name": { "type": "string", "nullable": true, "description": "Indicates the name of the payment processor.\n\nExample: TSYS\n", "example": "TSYS" }, "isDefault": { "type": "boolean", "description": "Indicates this is the default payment processor. \n\nIf `true`, this is the default payment processor.
\nIf `false`, this is not the default payment processor. \n\nExample: true\n", "example": true }, "typeId": { "type": "integer", "format": "int32", "description": "Indicates the payment processor type identifier.\n\nPossible values are:\n\n| id | name |\n|----|------|\n| 1 | TSYS |\n| 2 | EFT |\n\nExample: 1\n", "example": 1 }, "type": { "type": "string", "nullable": true, "description": "Indicates the payment processor type.\n\nPossible values are:\n\n| name | Id |\n|------|:--:|\n| TSYS | 1 |\n| EFT | 2 |\n\nExample:TSYS\n", "example": "TSYS" }, "settlementBatchTimeSlots": { "type": "array", "description": "
Indicates an object describing the scheduled time windows for settlement batch processing.\n", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.SettlementBatchTimeSlot" }, "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.AvsOptions": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "description": "Indicates the AVS (address verification service) is enabled.\n\nIf `true`, AVS is enabled.
\nIf `false`, AVS is not enabled.\n\nExample: true\n", "example": true }, "profileId": { "type": "integer", "format": "int32", "description": "Indicates the profile type identifier of the the AVS (address verification service) configuration.\n\nExample: 1\n", "example": 1 }, "profile": { "type": "string", "nullable": true, "description": "Indicates the profile type of the the AVS (address verification service) configuration.\n\nThe profile type specifies the strictness or leniency of the validation and fraud controls on transactions.\nValues may include lenient, normal, strict, or custom.\nThe actual values may vary.\n\nExample: strict\n", "example": "strict" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto": { "type": "object", "properties": { "zeroCostProcessingOptionId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.ZeroCostProcessingOption" }, "zeroCostProcessingOption": { "type": "string", "description": "Zero cost processing option name.\n\nPossible values:\n\n| Id | Value |\n|--------------|:-----:|\n| None | 1 |\n| CashDiscount | 2 |\n| DualPricing | 3 |\n| Surcharge | 4 |\n\nExample: DualPricing\n", "example": "DualPricing", "nullable": true }, "defaultTipsOptions": { "type": "array", "description": "Identifies an array of default, or preselected, tip options.\n\nThese values could be displayed on a receipt as preselected tip value options.\nThe client's app and UX needs to support that display.\nThey are presented as a percent alongside the actual money amount.\nThe intent is to present these values from which clients can quickly select a tip amount.\nThey are suggestions presented only as a convenience to the client.\nThe client should able to select any value, a custom value, or no value\n\nThese values are configured by the merchant.\n\nExample: [10, 12.0, 15.25, 20.5]\n", "example": [ 10, 15.25, 20.5 ], "items": { "maxItems": 3, "minItems": 0, "type": "number", "format": "double" }, "nullable": true }, "isTipsEnabled": { "type": "boolean", "description": "Indicates tips are enabled.\n\nIf `true`, tips are enabled.
\nIf `false`, tips are not enabled.\nTransactions with tip values will fail with a 400 response. \nThis also includes the one-step transaction `POST {{baseURL}}/pay-api/v1/transactions/sale`.\n\nTips are enabled or disabled in the Merchant portal (https://auth.arise.risewithaurora.com).\n\nExample: true\n", "example": true }, "defaultSurchargeRate": { "type": "number", "format": "double", "nullable": true, "description": "Identifies the default surcharge rate.\n\nThis value is configured by the merchant.\n\nExample: 3.5\n", "example": 3.5 }, "defaultCashDiscountRate": { "type": "number", "format": "double", "nullable": true, "description": "Identifies the default cash discount rate.\n\nThis value is configured by the merchant.\n\nExample: 3.5\n", "example": 3.5 }, "defaultDualPricingRate": { "type": "number", "format": "double", "nullable": true, "description": "Identifies the default dual pricing rate.\n\nDual pricing is when the merchant displays two prices for the same product.\nFor example, for cash or credit card.\nThe dual pricing rate is the additional charge for the other price, such as with a credit card.\n\nThis value is configured by the merchant.\n\nExample: 3.5\n", "example": 3.5 }, "availableCurrencies": { "description": "
Identifies the available currencies\n", "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.EnumDto" }, "nullable": true }, "availableCardTypes": { "description": "
Available card types.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "Indicates the Aurora credit card type identifier code.\n\nExample: 2\n", "example": 2 }, "name": { "type": "string", "description": "Indicates the name of the credit card.\n\nExample: MasterCard\n", "example": "MasterCard", "nullable": true } }, "additionalProperties": false }, "nullable": true }, "availableTransactionTypes": { "type": "array", "nullable": true, "description": "Indicates available transactions types.\n", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "Indicates the Aurora transaction type identifier code.\n\nExample: 6\n", "example": 6 }, "name": { "type": "string", "description": "Indicates the name of the transaction type..\n\nExample: CardAuthentication\n", "example": "CardAuthentication", "nullable": true } }, "additionalProperties": false } }, "availablePaymentProcessors": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.PaymentProcessorDto" }, "description": "
Available payment processors.", "nullable": true }, "avs": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.AvsOptions" }, "isCustomerCardSavingByTerminalEnabled": { "type": "boolean", "description": "Indicates the terminal saves the customer's card after the transaction is processed.\n\nIf `true`, the customer's card is saved.
\nIf `false`, the customer's card is not saved.\n\nExample: true\n", "example": true }, "companyName": { "type": "string", "description": "Indicates the customer's company name.\n\nExample: Peppared Street Cafe\n", "example": "Peppared Street Cafe", "nullable": true }, "mccCode": { "type": "string", "description": "Indicates the MCC (merchant category code).\n\nExample: 28\n", "example": "28", "nullable": true }, "mccCodeDescription": { "type": "string", "description": "Indicates the merchant category code description.\n\nExample: Hospitals\n", "example": "Hospitals", "nullable": true }, "currencyId": { "type": "integer", "description": "Indicates the currency identifier.\n\nPossible values can be found in `AvailableCurrencies`.\n\nExample: 1 (for USD)\n", "example": 1, "format": "int32" }, "currencyIsoCode": { "type": "string", "description": "Indicates the currency (in ISO 4217 alpha-3 currency code format).\n\nExample: USD\n", "example": "USD", "nullable": true }, "maxTransactionAmount": { "type": "number", "description": "Indicates the maximum transaction amount limit.\n\nExample: 32000\n", "example": 32000, "format": "double", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Configurations.MerchantContactInfos.GetMerchantContactInfosResponse.ContactInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the contact information record.\n\nExample: 24d5e6f7-8a9b-4c0d-1e2f-3a4b5c6d7e03\n", "example": "24d5e6f7-8a9b-4c0d-1e2f-3a4b5c6d7e03", "format": "uuid" }, "addressName": { "type": "string", "description": "The name or label of the address.\n\nExamples:
\nMain Office
\nWarehouse\n", "example": "Main Office", "nullable": true }, "addressLine1": { "type": "string", "description": "Specifies the street address.\n\nExample: 322 Unicorn Boulevard\n", "example": "322 Unicorn Boulevard", "nullable": true }, "addressLine2": { "type": "string", "description": "Specifies additional street address information.\n\nExample: Office 3\n", "example": "Office 3", "nullable": true }, "city": { "type": "string", "description": "Indicates the name of the city.\n\nExample: Chicago\n", "example": "Chicago", "nullable": true }, "zip": { "type": "string", "description": "Indicates the postal or ZIP code.\n\nExamples:
\n60612
\n60612-0001\n", "example": "60612", "nullable": true }, "countryId": { "type": "integer", "description": "Specifies the Aurora country identifier.\n\nExample: 1\n", "example": 1, "format": "int32" }, "stateId": { "type": "integer", "description": "Specifies the Aurora US state or territory identifier code.\n\nExample: 4\n", "example": 4, "format": "int32", "nullable": true }, "stateName": { "type": "string", "description": "Indicates the state identifier (in two-letter USPS [United States Postal Service] postal code).\n\nExamples:
\nTX
\nWA
\nIL\n", "example": "TX", "nullable": true }, "email": { "type": "string", "description": "The email address associated with this contact information.", "nullable": true }, "businessPhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "The business phone number for this contact.\n\nExample: +14155552309\n", "example": "+14155552309", "nullable": true }, "merchantId": { "type": "string", "description": "The ID of the merchant to whom this contact information belongs.", "format": "uuid" }, "isMainAddress": { "type": "boolean", "description": "Indicates whether this is the main address for the merchant." }, "isDefaultAddress": { "type": "boolean", "description": "Indicates whether this is the default address used for the merchant." } }, "additionalProperties": false, "description": "Represents a single contact information record for a merchant." }, "PaymentGateway.Contracts.Configurations.MerchantContactInfos.GetMerchantContactInfosResponse": { "type": "object", "properties": { "contactInfos": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Configurations.MerchantContactInfos.GetMerchantContactInfosResponse.ContactInfo" }, "description": "A list of contact information entries associated with the merchant.", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Customers.Common.StateDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Indicates the state identifier.\n\nExample: 13\n", "format": "int32" }, "code": { "type": "string", "description": "Indicates the state identifier (in two-letter USPS [United States Postal Service] postal code).\n\nExamples:
\nIL
\nTX
\nMA\n", "example": "TX", "nullable": true }, "name": { "type": "string", "description": "Indicates the name of the state.\n\nExample: Illinois\n", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Customers.Common.CountryDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Indicates the country identifier.\n\nExample: 1\n", "format": "int32" }, "isoCode": { "type": "string", "description": "Indicates the country identifier (in two letter ISO 3166-1 format).\n\nExample: US\n", "nullable": true }, "name": { "type": "string", "description": "Indicates the name of the country.\n\nExample: United States\n", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Customers.Common.AddressDto": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Indicates the street address.\n\nExample: 21 E. Main Street\n", "example": "21 E. Main Street", "nullable": true }, "addressLine2": { "type": "string", "description": "Indicates additional street address information.\n\nExample: Office 3\n", "example": "Office 3", "nullable": true }, "city": { "type": "string", "description": "Indicates the name of the city.\n\nExample: Chicago\n", "example": "Chicago", "nullable": true }, "zip": { "type": "string", "description": "Indicates the postal or ZIP code.\n\nExamples:
\n60612
\n60612-0001\n", "example": "60612", "nullable": true }, "stateName": { "type": "string", "description": "Indicates the state name.\n\nExample: IL\n", "nullable": true }, "state": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Common.StateDto" }, "country": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Common.CountryDto" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Customers.Common.CustomerItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Indicates the customer identifier.\n\nExample: 019bf058-960f-72a0-8194-6d554c7d6004\n", "example": "019bf058-960f-72a0-8194-6d554c7d6004", "format": "uuid" }, "createdOn": { "type": "string", "description": "Indicates the date the customer was created (in an ISO 8601 date-time format).\n\nExamples:
\n2025-01-27T12:05:54.322587Z
\n2025-01-27T12:05:54.322587+05:30\n", "example": "2025-01-27T12:05:54.322587+05:30", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Indicates the date the customer information was last modified (in an ISO 8601 date-time format).\n\nExamples:
\n2025-01-27T12:05:54.322587Z
\n2025-01-27T12:05:54.322587+05:30\n", "example": "2025-01-27T12:05:54.322587+05:30", "format": "date-time" }, "lastTransactionDate": { "type": "string", "description": "Indicates the date of the customer's last transaction (in an ISO 8601 date-time format).\n\nExamples:
\n2025-01-27T12:05:54.322587Z
\n2025-01-27T12:05:54.322587+05:30\n", "example": "2025-01-27T12:05:54.322587+05:30", "format": "date-time", "nullable": true }, "lastTransactionAmount": { "type": "number", "description": "Indicates the amount of the customer's last transaction.\n\nExamples:
\n1600
\n249.99\n", "format": "double", "nullable": true }, "activeSubscriptionsAmount": { "type": "number", "description": "Indicates the amount of all active subscriptions.\n\nExample: 1236.83\n", "format": "double", "nullable": true }, "contactName": { "type": "string", "description": "Indicates the customer's contact name.\n\nExample: Alexandro Peppared\n", "example": "Example: Alexandro Peppared", "nullable": true }, "firstName": { "type": "string", "description": "Indicates the customer's first name.\n\nExample: Alexandro\n", "nullable": true }, "lastName": { "type": "string", "description": "Indicates the customer's last name.\n\nExample: Peppared\n", "nullable": true }, "companyName": { "type": "string", "description": "Indicates the customer's company name.\n\nExample: Peppared Street Cafe\n", "example": "Peppared Street Cafe", "nullable": true }, "email": { "type": "string", "description": "Indicates the customer's email.\n\nExample: peppared@example.com\n", "example": "peppared@example.com", "nullable": true }, "mobilePhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "Indicates the customer's mobile phone number.\n\nExample: +14155552309\n", "example": "+14155552309", "nullable": true }, "isMobileNumberSmsNotificationsEnabled": { "type": "boolean", "description": "Indicates the customer's SMS notification is enabled.\n\nIf `true`, the customer's SMS notification is enabled.
\nIf `false`, the customer's SMS notification is not enabled.
\nIf missing or omitted, the information is not available.\n\nExample: true\n" }, "billingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Common.AddressDto" }, "paymentMethodsCount": { "type": "integer", "description": "Indicates the number of the customer's payment methods.\n\nExample: 2\n", "format": "int32" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Customers.GetPage.GetCustomerPageResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Common.CustomerItemDto" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.AddressDto": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Specifies the street address.\n\nExample: 322 Unicorn Boulevard\n", "example": "322 Unicorn Boulevard", "nullable": true }, "addressLine2": { "type": "string", "description": "Specifies additional street address information.\n\nExample: Office 3\n", "example": "Office 3", "nullable": true }, "city": { "type": "string", "description": "Specifies the name of the city.\n\nExample: Chicago\n", "example": "Chicago", "nullable": true }, "zip": { "type": "string", "description": "Specifies the postal or ZIP code.\n\nExamples:
\n60612
\n60612-0001\n", "example": "60612", "nullable": true }, "stateName": { "type": "string", "description": "Indicates the state identifier (in two-letter USPS [United States Postal Service] postal code).\n\nExamples:
\nTX
\nWA
\nIL\n", "example": "TX", "nullable": true }, "stateId": { "type": "integer", "description": "Specifies the Aurora US state or territory identifier code.\n\nExample: 4\n", "example": 4, "format": "int32", "nullable": true }, "countryId": { "type": "integer", "description": "Specifies the Aurora country identifier.\n\nExample: 1\n", "example": 1, "format": "int32" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.PaymentMethodCardDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Payment method name", "nullable": true }, "pan": { "type": "string", "description": "PAN", "nullable": true }, "expirationMonth": { "type": "integer", "description": "Expiration month", "format": "int32" }, "expirationYear": { "type": "integer", "description": "Expiration year", "format": "int32" }, "securityCode": { "type": "string", "description": "Security code", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.PaymentMethodAchAccountDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "description": "Specifies the payment target's bank account number.\n\nExample: 5413591081013511\n", "example": "5413591081013511", "nullable": true }, "routingNumber": { "type": "string", "nullable": true }, "accountType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AccountType" }, "accountHolderType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AccountHolderType" }, "taxId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Customers.Create.CreateCustomerRequest": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "Specifies the customer's first name.\n\nExample: Alexandro\n", "example": "Alexandro" }, "lastName": { "type": "string", "description": "Indicates the customer's last name.\n\nExample: Peppared\n", "example": "Peppared" }, "companyName": { "type": "string", "description": "Indicates the customer's company name.\n\nExample: Peppared Street Cafe\n", "nullable": true }, "email": { "type": "string", "description": "Indicates the customer's email.\n\nExample: peppared@example.com\n", "example": "peppared@example.com", "nullable": true }, "mobilePhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "Indicates the customer's mobile phone number.\n\nExample: +14155552309\n", "example": "+14155552309", "nullable": true }, "isMobileNumberSmsNotificationsEnabled": { "type": "boolean", "description": "Indicates the customer's SMS notification is enabled.\n\nIf `true`, the customer's SMS notification is enabled.
\nIf `false`, the customer's SMS notification is not enabled.
\nIf missing or omitted, the information is not available.\n\nExample: true\n" }, "useBillingAsShippingAddress": { "type": "boolean", "description": "Indicates to use the billing address as the shipping address.\n\nIf `true`, use the billing address as the shipping address.
\nIf `false`, do not use the billing address as the shipping address.\nInstead, use the field `shippingAddress`.\n\nExample: true\n", "example": true }, "billingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.AddressDto" }, "shippingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.AddressDto" }, "paymentMethodsCards": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.PaymentMethodCardDto" }, "description": "Payment methods", "nullable": true }, "paymentMethodsAchAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.PaymentMethodAchAccountDto" }, "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Customers.Create.CreateCustomerResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Indicates the customerId or the customer identifier.\n\nExample: 965865ef-b17d-4153-b952-d8902e584f7d\n", "example": "965865ef-b17d-4153-b952-d8902e584f7d", "format": "uuid" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Enums.TokenType": { "type": "integer", "description": "Identifies the card token type.\n\nPossible values:\n\n| Id | Type | Description |\n|:--:|---------|-------------|\n| 1 | Local | Regular |\n| 2 | Network | Network |\n\nExample: 2\n", "example": 2, "format": "int32" }, "PaymentGateway.Contracts.Enums.CardType": { "type": "integer", "description": "Identifies available card types (brands).\n\nThis is a simplified list.\nFor example Discover and Diners are the same.\n\nPossible values:\n\n| Id | Card Type |\n|:--:|-----------------|\n| 0 | Unknown |\n| 1 | Visa |\n| 2 | MasterCard |\n| 3 | AmericanExpress |\n| 4 | DinersClub |\n| 5 | Discover |\n| 6 | JCB | \n\nExample: 1\n", "example": 1, "format": "int32" }, "PaymentGateway.Contracts.Enums.CreditDebitType": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|---------|\n| 1 | Credit |\n| 2 | Debit |\n| 3 | Unknown |\n\nExample: 1\n", "example": 1, "format": "int32" }, "PaymentGateway.Contracts.Customers.Get.GetCustomerResponseDto.PaymentMethodCardDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Indicates the credit card identifier.\n\nExample: db02ec6c-2e5a-4b87-98a0-8dd881707d84\n", "example": "db02ec6c-2e5a-4b87-98a0-8dd881707d84", "format": "uuid" }, "name": { "type": "string", "description": "Name", "nullable": true }, "isDefault": { "type": "boolean", "description": "Is payment method default" }, "panMask": { "type": "string", "description": "PAN", "nullable": true }, "expirationMonth": { "type": "integer", "description": "Expiration Month", "format": "int32" }, "expirationYear": { "type": "integer", "description": "Expiration year", "format": "int32" }, "cardTokenType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.TokenType" }, "cardType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.CardType" }, "creditDebitType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.CreditDebitType" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Customers.Get.GetCustomerResponseDto.PaymentMethodAchAccountDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Indicates the ACH account identifier.\n\nExample: db02ec6c-2e5a-4b87-98a0-8dd881707d84\n", "example": "db02ec6c-2e5a-4b87-98a0-8dd881707d84", "format": "uuid" }, "name": { "type": "string", "description": "Name", "nullable": true }, "isDefault": { "type": "boolean", "description": "Is payment method default." }, "accountNumber": { "type": "string", "description": "Specifies the payment target's bank account number.\n\nExample: 5413591081013511\n", "example": "5413591081013511", "nullable": true }, "routingNumber": { "type": "string", "nullable": true }, "accountTypeId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string", "nullable": true }, "accountHolderTypeId": { "type": "integer", "format": "int32" }, "accountHolderType": { "type": "string", "nullable": true }, "taxId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Customers.Get.GetCustomerResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Customer Id", "format": "uuid" }, "merchantId": { "type": "string", "description": "Merchant Id", "format": "uuid" }, "firstName": { "type": "string", "description": "Indicates the customer's first name.\n\nExample: Alexandro\n", "nullable": true }, "lastName": { "type": "string", "description": "Indicates the customer's last name.\n\nExample: Peppared\n", "example": "Peppared" }, "companyName": { "type": "string", "description": "Indicates the customer's company name.\n\nExample: Peppared Street Cafe\n", "example": "Example: Peppared Street Cafe", "nullable": true }, "email": { "type": "string", "description": "Indicates the customer's email.\n\nExample: peppared@example.com\n", "example": "peppared@example.com", "nullable": true }, "mobilePhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "Indicates the customer's mobile phone number.\n\nExample: +14155552309\n", "example": "+14155552309", "nullable": true }, "isMobileNumberSmsNotificationsEnabled": { "type": "boolean", "description": "Indicates the customer's SMS notification is enabled.\n\nIf `true`, the customer's SMS notification is enabled.
\nIf `false`, the customer's SMS notification is not enabled.
\nIf missing or omitted, the information is not available.\n\nExample: true\n" }, "useBillingAsShippingAddress": { "type": "boolean", "description": "Indicates to use the billing address as the shipping address.\n\nIf `true`, use the billing address as the shipping address.
\nIf `false`, do not use the billing address as the shipping address.\nInstead, use the field `shippingAddress`.\n\nExample: true\n", "example": true }, "defaultPaymentMethodId": { "type": "string", "description": "Default payment method Id", "format": "uuid", "nullable": true }, "defaultAchPaymentMethodId": { "type": "string", "description": "Default payment method identifier.", "format": "uuid", "nullable": true }, "createdOn": { "type": "string", "description": "Indicates the date the customer was created on (in an ISO 8601 date-time format).\n\nExamples:
\n2025-01-27T12:05:54.322587Z
\n2025-01-27T12:05:54.322587+05:30\n", "example": "2025-01-27T12:05:54.322587+05:30", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Indicates the date the customer information was last modified on (in an ISO 8601 date-time format).\n\nExamples:
\n2025-01-27T12:05:54.322587Z
\n2025-01-27T12:05:54.322587+05:30\n", "example": "2025-01-27T12:05:54.322587+05:30", "format": "date-time" }, "billingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Common.AddressDto" }, "shippingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Common.AddressDto" }, "lastTransactionDate": { "type": "string", "description": "Indicates the the Last transaction date (in an ISO 8601 date-time format).\n\nExamples:
\n2025-01-27T12:05:54.322587Z
\n2025-01-27T12:05:54.322587+05:30\n", "example": "2025-01-27T12:05:54.322587+05:30", "format": "date-time", "nullable": true }, "transactionsCount": { "type": "integer", "description": "Transactions count", "format": "int32" }, "transactionsVolume": { "type": "number", "description": "Transactions volume", "format": "double" }, "lastTransactionAmount": { "type": "number", "description": "Last transaction amount", "format": "double", "nullable": true }, "numberOfSubscriptions": { "type": "integer", "description": "Count of active subscriptions", "format": "int32" }, "cards": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Get.GetCustomerResponseDto.PaymentMethodCardDto" }, "description": "Payment methods", "nullable": true }, "achAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Get.GetCustomerResponseDto.PaymentMethodAchAccountDto" }, "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Customers.Update.UpdateCustomerRequestDto.AddressDto": { "type": "object", "description": "Specifies an object for a street address.", "properties": { "addressLine1": { "type": "string", "description": "Specifies the street address.\n\nExample: 21 E. Main Street\n", "example": "21 E. Main Street", "nullable": true }, "addressLine2": { "type": "string", "description": "Specifies additional street address information.\n\nExample: Office 3\n", "example": "Office 3", "nullable": true }, "city": { "type": "string", "description": "Specifies the name of the city.\n\nExample: Chicago\n", "example": "Chicago", "nullable": true }, "zip": { "type": "string", "minLength": 2, "maxLength": 15, "description": "Specifies the postal or ZIP code.\n\nExamples:
\n60601
\n60601-0001\n", "example": "60601-0001", "nullable": true }, "stateName": { "type": "string", "description": "Indicates the state identifier (in two-letter USPS [United States Postal Service] postal code).\n\nExamples:
\nTX
\nWA
\nIL\n", "example": "TX", "nullable": true }, "stateId": { "type": "integer", "description": "Specifies the Aurora US state or territory identifier code.\n\nExample: 4\n", "example": 4, "format": "int32", "nullable": true }, "countryId": { "type": "integer", "description": "Specifies the Aurora country identifier.\n\nExample: 1\n", "example": 1, "format": "int32", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Customers.Update.UpdateCustomerRequest": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "Specifies the customer's first name.\n\nExample: Alexandro\n", "example": "Alexandro" }, "lastName": { "type": "string", "description": "Specifies the customer's last name.\n\nExample: Peppared\n", "example": "Peppared" }, "companyName": { "type": "string", "description": "Specifies the customer's company name.\n\nExample: Peppared Street Cafe\n", "nullable": true }, "email": { "type": "string", "description": "Specifies the customer's email\n\nExample: peppared@example.com\n", "nullable": true }, "mobilePhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "Specifies the customer's mobile phone number.\n\nExample: +14155552309\n", "example": "+14155552309", "nullable": true }, "isMobileNumberSmsNotificationsEnabled": { "type": "boolean", "description": "Specifies the customer's SMS notification is enabled.\n\nIf `true`, the customer's SMS notification is enabled.
\nIf `false`, the customer's SMS notification is not enabled.
\nIf missing or omitted, the information is not available.\n\nExample: true\n" }, "useBillingAsShippingAddress": { "type": "boolean", "description": "Specifies to use the billing address as the shipping address.\n\nIf `true`, use the billing address as the shipping address.
\nIf `false`, do not use the billing address as the shipping address.\nInstead, use the field `shippingAddress`.\n\nExample: true\n", "example": true }, "billingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Update.UpdateCustomerRequestDto.AddressDto" }, "shippingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Customers.Update.UpdateCustomerRequestDto.AddressDto" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Create.CreatePaymentMethodRequest": { "required": [ "expirationMonth", "expirationYear", "pan" ], "type": "object", "properties": { "name": { "type": "string", "description": "Payment method name", "nullable": true }, "pan": { "minLength": 1, "type": "string", "description": "PAN" }, "expirationMonth": { "type": "integer", "description": "Expiration month", "format": "int32" }, "expirationYear": { "type": "integer", "description": "Expiration year", "format": "int32" }, "securityCode": { "type": "string", "description": "Security code", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Create.CreatePaymentMethodResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Indicates the payment method identifier.\n\nThis is also known the `paymentMethodId`.\n\nExample: db02ec6c-2e5a-4b87-98a0-8dd881707d84\n", "example": "db02ec6c-2e5a-4b87-98a0-8dd881707d84", "format": "uuid" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Ach.Create.CreateAchAccountPaymentMethodRequest": { "required": [ "accountNumber", "routingNumber", "accountType", "accountHolderType" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Specifies the account number.\n\nExample: 123456789\n", "example": "123456789", "nullable": true }, "routingNumber": { "minLength": 1, "type": "string", "description": "Specifies the routing number.\n\nExample: 123123123\n", "example": "123123123" }, "accountType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AccountType" }, "accountHolderType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AccountHolderType" }, "name": { "type": "string", "description": "Specifies the payment method name.\n\nThis is a free-formed name that is convenient for the merchant to recognize. \n\nExample: Peppared Street Cafe's Preferred Payment\n", "example": "Peppared Street Cafe's Preferred Payment" }, "taxId": { "type": "string", "description": "Specifies the customer's TIN (tax identifier number).\n\nExample: 98-7654321\n", "example": "98-7654321", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.GetCustomerPaymentMethods.GetCustomerPaymentMethodsResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Indicates the paymentMethodId (payment method identifier).\n\nExample: 09af9936-08ec-4235-8386-b8d341cc88e7\n", "example": "09af9936-08ec-4235-8386-b8d341cc88e7", "format": "uuid" }, "name": { "type": "string", "description": "Specifies the payment method name.\n\nThis is a free-formed name that is convenient for the merchant to recognize. \n\nExample: Peppared Street Cafe's Preferred Payment\n", "example": "Peppared Street Cafe's Preferred Payment" }, "panMask": { "type": "string", "description": "Indicates the masked PAN (primary account number) as a partially hidden card number.\n\nExample: 514631******0055\n", "example": "514631******0055", "nullable": true }, "isDefault": { "type": "boolean", "description": "Indicates this payment method is the default.\n\nIf `true`, this payment method is the default.
\nIf `false`, this payment method is not the default.\n\nExample: true\n", "example": true }, "typeId": { "type": "integer", "description": "Indicates the type identifiers.\n\nPossible values:\n\n| Id | Payment Type |\n|:--:|------------------|\n| 1 | Card |\n| 2 | ElectronicCheck |\n| 3 | Cash |\n\nExample: 2\n", "example": 2, "format": "int32" }, "typeName": { "type": "string", "description": "Indicates the type name.\n\nPossible values:\n\n| Payment Type |\n|------------------|\n| Card |\n| ElectronicCheck |\n| Cash | \n\nExample: ElectronicCheck\n", "example": "ElectronicCheck", "nullable": true }, "expirationMonth": { "type": "integer", "description": "Indicates the expiration month of the card.\n\nExample: 7\n", "example": 7, "format": "int32", "nullable": false }, "expirationYear": { "type": "integer", "format": "int32", "description": "Indicates the expiration year of the card.\n\nExample: 2032\n", "example": 2032, "nullable": false }, "createdOn": { "type": "string", "nullable": true, "description": "Indicates the date the customer was created (in an ISO 8601 date-time UTC or time zone offset format).\n\nExamples:
\n2025-01-27T12:05:54.322587Z
\n2025-01-27T12:05:54.322587+05:30
\n2025-01-27T12:05:54.322587-06:00\n", "example": "2025-01-27T12:05:54.322587+05:30", "format": "date-time" }, "accountNumber": { "type": "string", "description": "Specifies the account number.\n\nExample: 123456789\n", "example": "123456789", "nullable": true }, "routingNumber": { "minLength": 1, "type": "string", "description": "Specifies the routing number.\n\nExample: 123123123\n", "example": "123123123" }, "accountType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AccountType" }, "accountHolderType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AccountHolderType" }, "taxId": { "type": "string", "description": "Specifies the customer's tax identifier (TIN).\n\nExample: 98-7654321\n", "example": "98-7654321", "nullable": true }, "cardTokenType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.TokenType" } }, "additionalProperties": false }, "Contracts.Page.Contracts.PublicApi.Isv.Customers.PaymentMethods.GetCustomerPaymentMethods.GetCustomerPaymentMethodsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.GetCustomerPaymentMethods.GetCustomerPaymentMethodsResponse" }, "nullable": true }, "total": { "type": "integer", "description": "Indicates the total number of payment methods found.\n\nExample: 7\n", "example": 7, "format": "int32" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Update.UpdatePaymentMethodRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Specifies the payment method name.\n\nThis is a free-formed name that is convenient for the merchant to recognize. \n\nExample: Cafe Peppared\n", "example": "Cafe Peppared" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceUserResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Indicates the user identifier.\n\nExample: 04103b7f-c2fc-444b-b1ab-93eee3aec815\n", "example": "04103b7f-c2fc-444b-b1ab-93eee3aec815", "format": "uuid" }, "firstName": { "type": "string", "description": "Indicates the customer's first name.\n\nExample: Alexandro\n", "example": "Alexandro", "nullable": true }, "lastName": { "type": "string", "description": "Indicates the customer's last name.\n\nExample: Peppared\n", "example": "Peppared", "nullable": true }, "email": { "type": "string", "description": "Indicates the user's email address.\n\nExample: peppared@example.com\n", "example": "peppared@example.com", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceResponse": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "description": "Indicates the device identifier.\n\nExample: 7aafd09f-b3e6-43fb-b815-5db3bf7f1451\n", "example": "7aafd09f-b3e6-43fb-b815-5db3bf7f1451", "nullable": true }, "deviceName": { "type": "string", "description": "Indicates the device name.\n\nExample: iPhone12,1\n", "example": "iPhone12,1", "nullable": true }, "lastLoginAt": { "type": "string", "format": "date-time", "description": "Indicates the last login time (in IS0 8601 UTC time).\n\nExample: 2026-01-19T14:27:02.767105Z\n", "example": "2026-01-19T14:27:02.767105Z" }, "apiKeyName": { "type": "string", "description": "Indicates the API key name being used.\n\nExample: Peppared's Cafe Key\n", "example": "Peppared's Cafe Key", "nullable": true }, "tapToPayStatus": { "type": "string", "description": "Indicates the tap to pay status.\n\nValid values are:\n\n| Tap To Pay status |\n|-----------|\n| Active |\n| Approved |\n| Denied |\n| Inactive |\n| Requested |\n\nExample: Active\n", "example": "Active", "nullable": true }, "tapToPayStatusId": { "type": "integer", "description": "Indicates the tap to pay status identifier.\n\nValid values are:\n\n| Id | Status |\n|----|-----------|\n| 0 | Inactive |\n| 1 | Requested |\n| 2 | Approved |\n| 3 | Active |\n| 4 | Denied |\n\nExample: 2\n", "example": 2, "format": "int32" }, "tapToPayEnabled": { "type": "boolean", "description": "Indicates tap to pay feature is enabled.\n\nIf `true`, tap to pay feature is enabled.
\nIf `false`, tap to pay feature is not enabled.\n\nExample: true\n", "example": true }, "userProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceUserResponse" }, "description": "Profiles associated with this device", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.GetDevicesResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceResponse" }, "description": "Indicates a list of devices associated with the current merchant.", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Devices.CreateOrUpdate.CreateOrUpdateDeviceRequest": { "type": "object", "properties": { "deviceId": { "type": "string", "description": "Device Id", "nullable": true }, "deviceName": { "type": "string", "description": "Device name", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Devices.CreateOrUpdate.CreateOrUpdateDeviceResponse": { "type": "object", "properties": { "deviceId": { "type": "string", "description": "Device Id", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Devices.TapToPay.GenerateTapToPayJwtRequest": { "type": "object", "properties": { "deviceId": { "type": "string", "description": "Device Id", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Devices.TapToPay.GenerateTapToPayJwtResponse": { "type": "object", "properties": { "jwtToken": { "type": "string", "description": "The generated JWT for Tap-to-Pay.", "nullable": true }, "expiresAt": { "type": "string", "description": "Indicates the expiration date-time (in IS0 8601 UTC time) of the token.\n\nExample: 2026-01-19T14:27:02.767105Z\n", "example": "2026-01-19T14:27:02.767105Z", "format": "date-time" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.GetMerchantApiTokensResponseDto.MerchantApiTokenDto": { "type": "object", "properties": { "merchantId": { "type": "string", "description": "Indicates the merchant identifier of the API key.\n\nExample: fae7620d-ab02-4375-bc20-6ff326b917fd\n", "example": "fae7620d-ab02-4375-bc20-6ff326b917fd", "format": "uuid" }, "tokenName": { "type": "string", "description": "Indicates the name of the API key.\n\nThis is a free-formed descriptive name to more easily identify the API key.\n\nExample: Peppared Street Cafe's API Key\n", "example": "Peppared Street Cafe's API Key", "nullable": true }, "clientId": { "type": "string", "description": "The clientId or the first value association with the API key.\n\nThis is the public portion of the API key.\nThe second value association with the API key, the client secret, is never shown after the initial creation.\n\nExample: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5\n", "example": "3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5", "format": "uuid" }, "creationDate": { "type": "string", "description": "Specifies the creation date of the API key (in an ISO 8601 date-time UTC or time zone offset format).\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30", "format": "date-time" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.GetMerchantApiTokensResponseDto": { "type": "object", "properties": { "tokens": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.GetMerchantApiTokensResponseDto.MerchantApiTokenDto" }, "description": "
Specifies an array of objects identifying a list API keys.\nThese API keys were created for merchants under an affiliate account or as a standalone merchants.\n", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.CreateMerchantApiTokenRequestDto": { "required": [ "merchantId", "tokenName" ], "type": "object", "properties": { "merchantId": { "type": "string", "description": "Specifies the identifier of the merchant.\n\nExample: 46063d32-10fa-44cb-b118-20ddd085ce3f\n", "example": "46063d32-10fa-44cb-b118-20ddd085ce3f", "format": "uuid" }, "tokenName": { "minLength": 1, "type": "string", "description": "A free-formed descriptive name for the API key.\n\nExample: Peppared Street Cafe's API Key\n", "example": "Peppared Street Cafe's API Key" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.CreateMerchantApiTokenResponseDto": { "type": "object", "properties": { "clientId": { "type": "string", "description": "Identifies the clientId associated with the API key.\n\nSee `clientSecret` for the client secret.\n\nExample: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5\n", "example": "3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5", "format": "uuid" }, "clientSecret": { "type": "string", "description": "The generated client secret for the merchant.\n\nThis value is only shown once at the time of creation.\nBe sure to store it securely, as it cannot be retrieved again later.\n\nSee `clientId` for the client identifier.\n", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Enums.SettlementBatchStatus": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|---------|\n| 1 | Open |\n| 2 | Settled |\n\nExample: 2\n", "example": 2, "format": "int32" }, "PaymentGateway.Contracts.PublicApi.Isv.SettlementBatches.GetPage.GetIsvSettlementBatchesResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "paymentProcessorId": { "type": "string", "format": "uuid" }, "paymentProcessorName": { "type": "string", "nullable": true }, "externalBatchId": { "type": "string", "nullable": true }, "batchDateTime": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the batch date time (in an ISO 8601 date-time UTC or time zone offset format).\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "transactionCount": { "type": "number", "format": "double" }, "netAmount": { "type": "number", "format": "double" }, "refundsAmount": { "type": "number", "format": "double" }, "salesAmount": { "type": "number", "format": "double" }, "statusId": { "type": "integer", "description": "SettlementBatchStatus\nOpen = 1\nSettled = 2", "format": "int32" }, "statusName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Contracts.Page.Contracts.PublicApi.Isv.SettlementBatches.GetPage.GetIsvSettlementBatchesResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.SettlementBatches.GetPage.GetIsvSettlementBatchesResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PaymentGateway.Contracts.SourceResponseDto": { "type": "object", "properties": { "typeId": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Amounts.SuggestedTipsDto": { "type": "object", "properties": { "tipAmount": { "type": "number", "format": "double", "description": "Specifies the absolute amount (in USD) of tip to be added.\n\nThis amount adds to the base amount of the original transaction.\nThat transaction must be authorized first.\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.\n\n\nExample: 14.50\n", "example": 14.5 }, "tipPercent": { "type": "number", "description": "Specifies the tip rate as a percentage of the base amount to be added.\n\nThis amount adds to the base amount of the original transaction.\nThat transaction must be authorized first.\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.\n\n\nExample: 15 (as 15%)\n", "example": 15, "format": "double" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Transactions.GetPage.GetTransactionPageResponseDto.AvailableOperation": { "type": "object", "properties": { "typeId": { "type": "integer", "format": "int32" }, "type": { "type": "string", "nullable": true }, "availableAmount": { "type": "number", "format": "double", "nullable": true }, "suggestedTips": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Amounts.SuggestedTipsDto" }, "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Amounts.AmountDto": { "type": "object", "properties": { "baseAmount": { "type": "number", "format": "double", "description": "Identifies the original amount (in USD) of a transaction before adjustments are applied.\n\nExample: 129.99\n", "example": 129.99 }, "percentageOffAmount": { "type": "number", "format": "double", "description": "Identifies the discount amount (in USD) taken off.\n\nThis discount was calculated using the preset percentage from `percentageOffRate`.\n\nExample: 12.50\n", "example": 12.5 }, "percentageOffRate": { "type": "number", "format": "double", "description": "Identifies the discount percentage.\n\nThis value is percentage rate for the discount.\nThis discount percentage calculates the discount amount for `percentageOffAmount`.\n\nExample: 3.5 (as 3.5%)\n", "example": 3.5 }, "cashDiscountAmount": { "type": "number", "format": "double", "description": "" }, "cashDiscountRate": { "type": "number", "format": "double", "description": "Identifies the discount percentage for a cash (or cash-equivalent) discount.\n\nThis value is percentage rate for the discount.\nThis discount percentage calculates the discount amount for `cashDiscountAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "cashDiscountPercentage": { "type": "number", "format": "double", "description": "Identifies the discount percentage for a cash (or cash-equivalent) discount.\n\nThis value is percentage rate for the discount.\nThis discount percentage calculates the discount amount for `cashDiscountAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "surchargeAmount": { "type": "number", "format": "double", "description": "Identifies the amount (in USD) when a surcharge is applicable.\n\nThis is a surcharge on the base amount.\nThis surcharge was calculated using the preset percentage from `surchargeRate`.\n\nExample: 6.45\n", "example": 6.45 }, "surchargeRate": { "type": "number", "format": "double", "description": "Identifies the surcharge percentage.\n\nThis is a surcharge on the base amount.\nThis value is surcharge percentage rate.\nThis surcharge percentage calculates the surcharge amount for `surchargeAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "tipAmount": { "type": "number", "format": "double", "description": "Specifies the absolute amount (in USD) of tip to be added.\n\nThis amount adds to the base amount of the original transaction.\nThat transaction must be authorized first.\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.\n\n\nExample: 14.50\n", "example": 14.5 }, "tipRate": { "type": "number", "format": "double", "description": "Specifies the tip rate as a percentage of the base amount to be added.\n\nThis amount adds to the base amount of the original transaction.\nThat transaction must be authorized first.\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.\n\n\nExample: 15 (as 15%)\n", "example": 15 }, "taxAmount": { "type": "number", "format": "double" }, "taxRate": { "type": "number", "format": "double" }, "totalAmount": { "type": "number", "format": "double", "description": "Specifies the transaction's total amount. \n\nThis includes the base amount, tips, taxes, discounts, and other charges.\n\nExample: 3219.45\n", "example": 3219.45 } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.GetPage.GetIsvTransactionsResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Indicates the transaction identifier.\n\nExample: c7c15dd0-03e7-4e55-917c-54bedafba5e7\n", "example": "c7c15dd0-03e7-4e55-917c-54bedafba5e7", "format": "uuid" }, "paymentProcessorId": { "type": "string", "format": "uuid" }, "date": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the transaction date.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "baseAmount": { "type": "number", "format": "double", "nullable": true, "description": "Identifies the original amount (in USD) of the transaction before adjustments are applied.\n\nExample: 129.99\n", "example": 129.99 }, "totalAmount": { "type": "number", "format": "double", "nullable": true, "description": "Specifies the transaction's total amount. \n\nThis includes the base amount, tips, taxes, discounts, and other charges.\n\nExample: 3219.45\n", "example": 3219.45 }, "surchargeAmount": { "type": "number", "format": "double", "nullable": true, "description": "Identifies the amount (in USD) when a surcharge is applicable.\n\nThis is a surcharge on the base amount.\nThis surcharge was calculated using the preset percentage from `surchargePercentage`.\n\nExample: 6.45\n", "example": 6.45 }, "surchargePercentage": { "type": "number", "format": "double", "nullable": true, "description": "Identifies the surcharge percentage.\n\nThis is a surcharge on the base amount.\nThis value is surcharge percentage rate.\nThis surcharge percentage calculates the surcharge amount for `surchargeAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "currencyCode": { "type": "string", "nullable": true, "description": "Indicates the currency (in ISO 4217 alpha-3 currency code format).\n\nExample: USD\n", "example": "USD" }, "currencyId": { "type": "integer", "format": "int32", "nullable": true, "description": "Indicates the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1 }, "merchant": { "type": "string", "nullable": true }, "merchantId": { "type": "string", "format": "uuid" }, "operationMode": { "type": "string", "nullable": true }, "paymentMethodType": { "type": "string", "nullable": true }, "paymentMethodTypeId": { "type": "integer", "format": "int32" }, "paymentMethodName": { "type": "string", "nullable": true }, "customerName": { "type": "string", "nullable": true }, "customerCompany": { "type": "string", "nullable": true }, "customerPan": { "type": "string", "nullable": true }, "cardTokenType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.TokenType" }, "customerEmail": { "type": "string", "nullable": true }, "customerPhone": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "Indicates the customer's phone number.\n\nExample: +14155552309\n", "example": "+14155552309", "nullable": true }, "status": { "type": "string", "nullable": true }, "statusId": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "type": { "type": "string", "nullable": true }, "batchId": { "type": "string", "format": "uuid", "nullable": true }, "source": { "$ref": "#/components/schemas/PaymentGateway.Contracts.SourceResponseDto" }, "availableOperations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.GetPage.GetTransactionPageResponseDto.AvailableOperation" }, "nullable": true }, "amount": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto" } }, "additionalProperties": false }, "Contracts.Page.PublicApi.Isv.Transactions.GetPage.GetIsvTransactionsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.GetPage.GetIsvTransactionsResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Transactions.TransactionReceiptDto.AmountDto": { "type": "object", "description": "Indicates an object detailing the amount.\n", "properties": { "baseAmount": { "type": "number", "format": "double", "description": "Identifies the original amount (in USD) of a transaction before adjustments are applied.\n\nExample: 129.99\n", "example": 129.99 }, "percentageOffAmount": { "type": "number", "format": "double", "description": "Identifies the discount amount (in USD) taken off.\n\nThis discount was calculated using the preset percentage from `percentageOffRate`.\n\nExample: 12.50\n", "example": 12.5 }, "percentageOffRate": { "type": "number", "format": "double", "description": "Identifies the discount percentage.\n\nThis value is percentage rate for the discount.\nThis discount percentage calculates the discount amount for `percentageOffAmount`.\n\nExample: 3.5 (as 3.5%)\n", "example": 3.5 }, "cashDiscountAmount": { "type": "number", "format": "double", "description": "Identifies the discount amount (in USD) when a cash (or cash-equivalent) discount is applied.\n\nThis discount was calculated using the preset percentage from `cashDiscountRate`.\n\nExample: 10.55\n", "example": 10.55 }, "cashDiscountRate": { "type": "number", "format": "double", "description": "Identifies the discount percentage for a cash (or cash-equivalent) discount.\n\nThis value is percentage rate for the discount.\nThis discount percentage calculates the discount amount for `cashDiscountAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "surchargeAmount": { "type": "number", "format": "double", "description": "Identifies the amount (in USD) when a surcharge is applicable.\n\nThis is a surcharge on the base amount.\nThis surcharge was calculated using the preset percentage from `surchargeRate`.\n\nExample: 6.45\n", "example": 6.45 }, "surchargeRate": { "type": "number", "format": "double", "description": "Identifies the surcharge percentage.\n\nThis is a surcharge on the base amount.\nThis value is surcharge percentage rate.\nThis surcharge percentage calculates the surcharge amount for `surchargeAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "tipAmount": { "type": "number", "format": "double", "description": "Specifies the absolute amount (in USD) of tip to be added.\n\nThis amount adds to the base amount of the original transaction.\nThat transaction must be authorized first.\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.

\nIf neither value is provided, no tip is added.\n\n\nExample: 14.50\n", "example": 14.5 }, "tipRate": { "type": "number", "format": "double", "description": "Specifies the tip rate as a percentage of the base amount to be added.\n\nThis amount adds to the base amount of the original transaction.\nThat transaction must be authorized first.\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.

\nIf neither value is provided, no tip is added.\n\n\nExample: 15 (as 15%)\n", "example": 15 }, "totalAmount": { "type": "number", "format": "double", "description": "Specifies the transaction's total amount. \n\nThis includes the base amount, tips, taxes, discounts, and other charges.\n\nExample: 3219.45\n", "example": 3219.45 } }, "additionalProperties": false }, "PaymentGateway.Contracts.Enums.CardholderAuthenticationMethod": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|-----------------------------|\n| 0 | NotAuthenticated |\n| 1 | PIN |\n| 2 | ElectronicSignatureAnalysis |\n| 3 | ManualSignature |\n| 4 | ManualOther |\n| 5 | Unknown |\n| 6 | SystematicOther |\n| 7 | ETicketEnvAmex |\n| 8 | OfflinePin |\n\nExample: 0\n", "example": 0, "format": "int32" }, "PaymentGateway.Contracts.Enums.CardDataSource": { "type": "integer", "format": "int32", "description": "Specifies the card data source.\n\nPossible values:\n\n| Value | Name | Description |\n|:------:|-------------------|------------------------------------------|\n| 1 | Internet | Virtual Terminal, ISV API |\n| 2 | Swipe | Track1, Track2 |\n| 3 | NFC | EMV Tags, Track2 |\n| 4 | EMV | EMV Tags |\n| 5 | EMVContactless | EMV Tags |\n| 6 | FallbackSwipe | Track 2 |\n| 7 | Manual | Card present keyed transaction |\n\nExample: 2\n", "example": 2 }, "PaymentGateway.Contracts.Transactions.TransactionReceiptDto.CardDetailsDto": { "type": "object", "properties": { "authCode": { "type": "string", "nullable": true }, "mid": { "type": "string", "nullable": true }, "tid": { "type": "string", "nullable": true }, "cardCreditDebitTypeId": { "type": "integer", "format": "int32" }, "cardCreditDebitType": { "type": "string", "nullable": true }, "processCreditDebitTypeId": { "type": "integer", "format": "int32" }, "processCreditDebitType": { "type": "string", "nullable": true }, "rrn": { "type": "string", "nullable": true }, "cardTypeId": { "type": "integer", "format": "int32" }, "cardType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Transactions.TransactionReceiptDto.ElectronicCheckDetails": { "type": "object", "properties": { "customerAccountNumber": { "type": "string", "nullable": true }, "customerRoutingNumber": { "type": "string", "nullable": true }, "accountHolderType": { "type": "string", "nullable": true }, "accountHolderTypeId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string", "nullable": true }, "accountTypeId": { "type": "integer", "format": "int32" }, "taxId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Enums.TransactionType": { "type": "integer", "description": "Possible values:\n\n| Id | Type | Description |\n|:--:|--------------------|-------------|\n| 1 | Authorization | |\n| 2 | Sale | |\n| 3 | Capture | |\n| 4 | Void | |\n| 5 | Refund | |\n| 6 | CardAuthentication | |\n| 7 | RefundWORef | Refund without reference.

As a warning, these are considered high-risk transaction types, as funds are debited directly from the merchant’s account even if the original sale was not processed through Aurora. |\n| 8 | TipAdjustment | |\n| 11 | AchDebit | |\n| 12 | AchRefund | |\n| 13 | AchHold | |\n| 14 | AchUnHold | |\n| 15 | AchCancel | |\n| 16 | AchCredit | |\n", "format": "int32" }, "PaymentGateway.Contracts.Enums.TransactionOperation": { "type": "object", "properties": { "typeId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.TransactionType" }, "type": { "type": "string", "nullable": true, "readOnly": true }, "availableAmount": { "type": "number", "format": "double", "nullable": true }, "suggestedTips": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Amounts.SuggestedTipsDto" }, "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Enums.AvsActions": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|-------|\n| 1 | Allow |\n| 2 | Deny |\n\nExample: 1\n", "example": 1, "format": "int32" }, "PaymentGateway.Contracts.Enums.AvsCodeGroupType": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|-----------------|\n| 1 | NoMatch |\n| 2 | PartialMatch |\n| 3 | Incompatible |\n| 4 | Unavailable |\n| 5 | ValidGroup |\n\nExample: 5\n", "example": 5, "format": "int32" }, "PaymentGateway.Contracts.Enums.AvsResponseResult": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|--------|\n| 1 | Passed |\n| 2 | Failed |\n\nExample: 1\n", "example": 1, "format": "int32" }, "PaymentGateway.Contracts.Transactions.AvsResponseDto": { "type": "object", "properties": { "actionId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AvsActions" }, "action": { "type": "string", "description": "AVS Action", "nullable": true, "readOnly": true }, "responseCode": { "type": "string", "description": "AVS Response Code", "nullable": true }, "groupId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AvsCodeGroupType" }, "group": { "type": "string", "description": "AVS Code Group", "nullable": true, "readOnly": true }, "resultId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.AvsResponseResult" }, "result": { "type": "string", "description": "AVS Response Result. Passed - all address data is correct. Failed - some address data is incorrect.", "nullable": true, "readOnly": true }, "codeDescription": { "type": "string", "description": "AVS Response Code Description", "nullable": true } }, "additionalProperties": false, "description": "Address Verification Service Response" }, "KeyValuePair`2": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Transactions.TransactionReceiptDto.EmvTagsDto": { "type": "object", "properties": { "ac": { "type": "string", "nullable": true }, "tvr": { "type": "string", "nullable": true }, "tsi": { "type": "string", "nullable": true }, "aid": { "type": "string", "nullable": true }, "applicationLabel": { "type": "string", "nullable": true }, "rawTags": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValuePair`2" }, "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse.TsysCardDetailsDto": { "type": "object", "properties": { "authCode": { "type": "string", "nullable": true }, "mid": { "type": "string", "nullable": true }, "tid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse.AchDetailsDto": { "type": "object", "properties": { "customerAccountNumber": { "type": "string", "nullable": true }, "customerRoutingNumber": { "type": "string", "nullable": true }, "accountHolderType": { "type": "string", "nullable": true }, "accountHolderTypeId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string", "nullable": true }, "accountTypeId": { "type": "integer", "format": "int32" }, "taxId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse": { "type": "object", "properties": { "transactionId": { "type": "string", "format": "uuid", "description": "Indicates the transaction identifier.\n\nExample: c7c15dd0-03e7-4e55-917c-54bedafba5e7\n", "example": "c7c15dd0-03e7-4e55-917c-54bedafba5e7" }, "transactionDateTime": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the transaction execution.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "amount": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.AmountDto" }, "currencyId": { "type": "integer", "format": "int32", "description": "Indicates the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1 }, "currency": { "type": "string", "nullable": true }, "processorId": { "type": "string", "format": "uuid" }, "processor": { "type": "string", "nullable": true }, "operationTypeId": { "type": "integer", "format": "int32" }, "operationType": { "type": "string", "nullable": true }, "paymentMethodTypeId": { "type": "integer", "format": "int32" }, "paymentMethodType": { "type": "string", "nullable": true }, "transactionTypeId": { "type": "integer", "format": "int32" }, "transactionType": { "type": "string", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289de5" }, "customerPan": { "type": "string", "nullable": true }, "cardTokenType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.TokenType" }, "statusId": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true }, "merchantName": { "type": "string", "nullable": true }, "merchantAddress": { "type": "string", "nullable": true }, "merchantPhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "Indicates the merchant's phone number.\n\nExample: +14155552309\n", "example": "+14155552309", "nullable": true }, "merchantEmailAddress": { "type": "string", "nullable": true }, "merchantWebsite": { "type": "string", "nullable": true }, "authCode": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/PaymentGateway.Contracts.SourceResponseDto" }, "cardholderAuthenticationMethodId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.CardholderAuthenticationMethod" }, "cardholderAuthenticationMethod": { "type": "string", "nullable": true, "readOnly": true }, "cvmResultMsg": { "type": "string", "nullable": true }, "cardDataSourceId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource" }, "cardDataSource": { "type": "string", "nullable": true, "readOnly": true }, "responseCode": { "type": "string", "nullable": true }, "responseDescription": { "type": "string", "nullable": true }, "cardProcessingDetails": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.CardDetailsDto" }, "achProcessingDetails": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.ElectronicCheckDetails" }, "availableOperations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.TransactionOperation" }, "nullable": true }, "avsResponse": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AvsResponseDto" }, "emvTags": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.EmvTagsDto" }, "orderNumber": { "type": "string", "nullable": true }, "baseAmount": { "type": "number", "description": "Identifies the original amount (in USD) of a transaction before adjustments are applied.\n\nDeprecated. Use Amount.BaseAmount\n\nExample: 129.99\n", "example": 129.99, "format": "double", "deprecated": true }, "totalAmount": { "type": "number", "description": "Deprecated. Use Amount.TotalAmount", "format": "double", "deprecated": true }, "tsysCardDetails": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse.TsysCardDetailsDto" }, "achDetails": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse.AchDetailsDto" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Enums.EMVFallbackCondition": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|-------------------|\n| 0 | ICCTerminalError |\n| 1 | NoCandidateList |\n\nExample: 2\n", "example": 2, "format": "int32" }, "PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|-----------------------|\n| 0 | Successful |\n| 1 | Failed |\n| 2 | NotAChipTransaction |\n| 3 | Unknown |\n\nExample: 1\n", "example": 1, "format": "int32" }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL2Data": { "type": "object", "properties": { "salesTaxRate": { "type": "number", "description": "Sales tax rate. Decimal Number. Max length=4. Allowed characters: 0-9 .(dot) Allowed range: 0.01 - 100", "format": "double", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Transactions.TransactionProductDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the product. Alphanumeric and Special Characters. Min Length=1, max length=50. Allowed special characters: Space, Slash /, Hyphen -, Comma", "nullable": true }, "code": { "type": "string", "description": "The merchant’s assigned unique product identification code. Alphanumeric and Special Characters. Min length=1, max length=20. Allowed special characters: Space, Slash /", "nullable": true }, "unitPrice": { "type": "number", "description": "The product amount. Numeric. Max length=12. Allowed characters: 0-9 .(dot)", "format": "double", "nullable": true }, "measurementUnit": { "type": "string", "description": "The unit of measurement for the product. Alphanumeric and special character Space. Max length=20", "nullable": true }, "quantity": { "type": "number", "description": "The quantity of a product. Decimal number. Max length=12", "format": "double", "nullable": true }, "taxAmount": { "type": "number", "description": "The tax amount established on a product. Numeric. Max length=12. Allowed characters: 0-9 .(dot)", "format": "double", "nullable": true }, "discountRate": { "type": "number", "description": "The discount percentage applied to a product. Corresponds with productDiscountName. This does not impact transaction functionality. It is used for reporting purposes. Numeric. Max Length=4. Allowed range:0.01 to 100", "format": "double", "nullable": true }, "description": { "type": "string", "description": "The description of the product. Alphanumeric and Special Characters. Min length=1, max length=200.", "nullable": true }, "measurementUnitId": { "type": "integer", "description": "MeasurementUnitId", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL3Data": { "type": "object", "properties": { "invoiceNumber": { "type": "string", "description": "The Value Added Tax(VAT) invoice number associated with the transaction. Max length=15. Allowed characters: a-z A-Z 0-9 Space", "nullable": true }, "purchaseOrder": { "type": "string", "description": "The value used by the customer to identify an order. Issued by the buyer to the seller. Max length=25. Allowed characters: a-z A-Z 0-9 Space", "nullable": true }, "shippingCharges": { "type": "number", "description": "The dollar amount for shipping or freight charges applied to a product or transaction. Numeric. Max length=12. Allowed characters: 0-9 .(dot)", "format": "double", "nullable": true }, "dutyCharges": { "type": "number", "description": "Indicates the total charges for any import or export duties included in the order. Numeric. Max length=12. Allowed characters: 0-9 .(dot)", "format": "double", "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionProductDto" }, "description": "You can send multiple products in a request", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationRequest": { "required": [ "accountNumber", "amount", "currencyId", "expirationMonth", "expirationYear" ], "type": "object", "properties": { "amount": { "type": "number", "format": "double", "nullable": false, "description": "Specifies the amount of the transaction.\n\nExample: 29.99\n", "example": 29.99 }, "accountNumber": { "type": "string", "nullable": false, "description": "Specifies the card number used for the transaction.\n\nThis field may contain a token issued against a card number.\nThis is de-tokenized by TransIT to process the transaction.\n\nExample: 4111111111111111\n", "example": "4111111111111111" }, "currencyId": { "type": "integer", "nullable": false, "description": "Specifies the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1, "format": "int32" }, "expirationMonth": { "type": "integer", "nullable": false, "description": "Specifies the expiration month of the card.\n\nExample: 7\n", "example": 7, "format": "int32" }, "expirationYear": { "type": "integer", "nullable": false, "description": "Specifies the expiration year of the card.\n\nExample: 2032\n", "example": 2032, "format": "int32" }, "cardDataSource": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource" }, "deviceId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the device when using the Arise Mobile app.\n\nIf this value is included, the user is linked to that device.\nThis stores their name as the transaction creator `createdBy`.\n\nExample: a30f9b66-b2f0-4b18-a03a-b861b00afa8b\n", "example": "a30f9b66-b2f0-4b18-a03a-b861b00afa8b" }, "paymentProcessorId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the payment processor identifier.\n\nExample: 37bd9ccb-2c9d-45cf-a65f-c9a224bdeaeb\n", "example": "37bd9ccb-2c9d-45cf-a65f-c9a224bdeaeb" }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289de5" }, "paymentMethodId": { "type": "string", "description": "Customer payment method ID", "format": "uuid", "nullable": true }, "tipAmount": { "type": "number", "format": "double", "nullable": true, "description": "Specifies the absolute amount (in USD) of tip to be added.\n\nThis amount adds to the number included in the field `amount` earlier.\nFor example if `amount` is $100 and this `tipAmount` is $10, the authorize amount is $110.\n\nNo additional tip amount or tip rate is required to be added, such as from `POST {{baseURL}}/pay-api/v1/transactions/tip-adjustment`\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.\n\n\nExample: 14.50\n", "example": 14.5 }, "tipRate": { "type": "number", "format": "double", "nullable": true, "description": "Specifies the tip rate as a percentage of the base amount to be added.\n\nThis amount adds to the number included in the field `amount` earlier.\nFor example if `amount` is $100 and this `tipRate` is `10`, the authorize amount is $110.\n\nNo additional tip amount or tip rate is required to be added, such as from `POST {{baseURL}}/pay-api/v1/transactions/tip-adjustment`\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.\n\n\nExample: 15 (as 15%)\n", "example": 15 }, "percentageOffRate": { "type": "number", "description": "The percent of the base amount to be discounted.\n\nExample:
\n8.25 (as 8.25%)
\n12 (as 12%)\n", "example": 12, "format": "double", "nullable": true }, "surchargeRate": { "type": "number", "description": "The percent of transaction amount to be added to the amount after `percentageOffRate` is applied.\n\nExample:
\n8.25 (as 8.25%)
\n12 (as 12%)\n", "example": 12, "format": "double", "nullable": true }, "useCardPrice": { "type": "boolean", "description": "Parameter is mandatory when merchant has ZeroCostProcessingOption == Dual\nPricing. \n\nParameter must be null when merchant has other ZeroCostProcessingOption. \n\nFor Dual Pricing, amount should be the card price and useCardPrice should\nbe `true`, or amount should be the cash price and useCardPrice should be\n`false`.\n", "nullable": true }, "appVersion": { "type": "string", "nullable": true, "description": "Specifies the version of the mobile app.\n\nThis value is stored on the transaction.\nIt is visible in the transaction details.\nThe `appVersion` value takes priority over the `sdkVersion` if both are present.\n\nExample: 10.413.01\n", "example": "10.413.01" }, "sdkVersion": { "type": "string", "nullable": true, "description": "Specifies the version of the Aurora SDK.\n\nThis value is stored on the transaction.\nIt is visible in the transaction details.\nThe `appVersion` value takes priority over the `sdkVersion` if both are present.\n\nExample: 8.61.01\n", "example": "8.61.01" }, "billingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto" }, "shippingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto" }, "contactInfo": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.ContactInfoDto" }, "securityCode": { "type": "string", "description": "The three or four digit security code on the credit card.", "nullable": true }, "track1": { "type": "string", "description": "The card data from track 1 of the magnetic stripe.", "nullable": true }, "track2": { "type": "string", "description": "Information stored on the magnetic stripe of a credit or debit card, including the card number, expiration date, and cardholder's name.", "nullable": true }, "emvTags": { "type": "array", "items": { "type": "string" }, "description": "Each tag corresponds to a particular piece of data stored on the card.", "nullable": true }, "emvPaymentAppVersion": { "type": "string", "description": "The version number of the payment application in use.", "nullable": true }, "pin": { "type": "string", "nullable": true }, "pinKsn": { "type": "string", "nullable": true }, "emvFallbackCondition": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackCondition" }, "emvFallbackLastChipRead": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead" }, "referenceId": { "type": "string", "description": "Specifies an external transaction identifier for client-side tracking.\n\nAlso used in duplicate control validation.\nA unique value allows similar transactions to process as distinct, bypassing duplicate blocking when needed.\n", "nullable": true }, "l2": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL2Data" }, "l3": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL3Data" }, "customerInitiatedTransaction": { "type": "boolean", "description": "Customer Initiated Transaction if true\nMerchant Initiated Transaction if false\nDefault value - false." } }, "additionalProperties": false }, "PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto": { "type": "object", "properties": { "hostResponseCode": { "type": "string", "description": "A two-character response code indicating the status of the authorization request", "nullable": true }, "hostResponseMessage": { "type": "string", "description": "Authorization response message", "nullable": true }, "hostResponseDefinition": { "type": "string", "description": "Response definition", "nullable": true }, "code": { "type": "string", "description": "High-level operation response - approve, decline or error.", "nullable": true }, "message": { "type": "string", "description": "Free-form result description.", "nullable": true }, "processorResponseCode": { "type": "string", "description": "Processor-specific response code that precisely describes the operation result.", "nullable": true }, "authCode": { "type": "string", "description": "The authorization code received for the transaction.", "nullable": true }, "maskedPan": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Transactions.TransactionReceiptDto": { "type": "object", "nullable": true, "description": "
Indicates an object describing the transaction receipt.\nThe transaction receipt will be null or empty before the transaction is completed.\nAfter the completed transaction, it be filled out.\n", "properties": { "transactionId": { "type": "string", "format": "uuid", "description": "Identifies the transaction identifier.\n\nExample: c7c15dd0-03e7-4e55-917c-54bedafba5e7\n", "example": "c7c15dd0-03e7-4e55-917c-54bedafba5e7" }, "transactionDateTime": { "type": "string", "format": "date-time", "description": "Identifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the transaction execution.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "amount": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.AmountDto" }, "currencyId": { "type": "integer", "format": "int32", "description": "Indicates the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1 }, "currency": { "type": "string", "nullable": true }, "processorId": { "type": "string", "format": "uuid" }, "processor": { "type": "string", "nullable": true }, "operationTypeId": { "type": "integer", "format": "int32" }, "operationType": { "type": "string", "nullable": true }, "paymentMethodTypeId": { "type": "integer", "format": "int32" }, "paymentMethodType": { "type": "string", "nullable": true }, "transactionTypeId": { "type": "integer", "format": "int32" }, "transactionType": { "type": "string", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "customerPan": { "type": "string", "nullable": true }, "cardTokenType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.TokenType" }, "statusId": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true }, "merchantName": { "type": "string", "nullable": true }, "merchantAddress": { "type": "string", "nullable": true }, "merchantPhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "nullable": true, "description": "Indicates the merchant's phone number.\n\nExample: +14155552309\n", "example": "+14155552309" }, "merchantEmailAddress": { "type": "string", "nullable": true }, "merchantWebsite": { "type": "string", "nullable": true }, "authCode": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/PaymentGateway.Contracts.SourceResponseDto" }, "cardholderAuthenticationMethodId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.CardholderAuthenticationMethod" }, "cardholderAuthenticationMethod": { "type": "string", "nullable": true, "readOnly": true }, "cvmResultMsg": { "type": "string", "nullable": true }, "cardDataSourceId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource" }, "cardDataSource": { "type": "string", "nullable": true, "readOnly": true }, "responseCode": { "type": "string", "nullable": true }, "responseDescription": { "type": "string", "nullable": true }, "cardProcessingDetails": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.CardDetailsDto" }, "achProcessingDetails": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.ElectronicCheckDetails" }, "availableOperations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.TransactionOperation" }, "nullable": true }, "avsResponse": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AvsResponseDto" }, "emvTags": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.EmvTagsDto" }, "orderNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationResponse": { "type": "object", "properties": { "transactionId": { "type": "string", "format": "uuid", "description": "Identifies the transaction identifier.\n\nExample: c7c15dd0-03e7-4e55-917c-54bedafba5e7\n", "example": "c7c15dd0-03e7-4e55-917c-54bedafba5e7" }, "transactionDateTime": { "type": "string", "format": "date-time", "description": "Specifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the transaction execution.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "typeId": { "type": "integer", "description": "Type id of transaction.", "format": "int32" }, "type": { "type": "string", "description": "Type name of transaction", "nullable": true }, "statusId": { "type": "integer", "description": "Indicates the status identifier of the transaction.\n", "format": "int32" }, "status": { "type": "string", "description": "Indicates the status name of the transaction\n", "nullable": true }, "details": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto" }, "transactionReceipt": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto" }, "processedAmount": { "type": "number", "description": "Indicates which amount is authorized. The amount may differ from the amount in the request.", "format": "double" }, "avsResponse": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AvsResponseDto" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Sale.IsvSaleRequest": { "required": [ "amount", "accountNumber", "cardDataSource", "currencyId", "expirationMonth", "expirationYear" ], "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "Specifies the amount of the transaction.\n\nExample: 64.99\n", "example": 64.99 }, "accountNumber": { "type": "string", "description": "Specifies the 13-19 digit card number used for the transaction.\n\nThis field may contain a token issued against a card number.\nThis is de-tokenized by TransIT to process the transaction.\n", "nullable": false }, "cardDataSource": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource" }, "currencyId": { "type": "integer", "description": "Specifies the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1, "format": "int32" }, "expirationMonth": { "type": "integer", "description": "Specifies the expiration month of the card.\n\nExample: 7\n", "example": 7, "format": "int32", "nullable": false }, "expirationYear": { "type": "integer", "format": "int32", "description": "Specifies the expiration year of the card.\n\nExample: 2032\n", "example": 2032, "nullable": false }, "deviceId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the device when using the Arise Mobile app.\n\nIf this value is included, the user is linked to that device.\nThis stores their name as the transaction creator `createdBy`.\n\nExample: a30f9b66-b2f0-4b18-a03a-b861b00afa8b\n", "example": "a30f9b66-b2f0-4b18-a03a-b861b00afa8b" }, "paymentProcessorId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the payment processor identifier.\n\nExample: 8ebb41c8-e1b0-4777-8f8e-1402e756ee7d\n", "example": "8ebb41c8-e1b0-4777-8f8e-1402e756ee7d" }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "paymentMethodId": { "type": "string", "description": "Specifies the customer payment method identifier.", "format": "uuid", "nullable": true }, "tipAmount": { "type": "number", "format": "double", "nullable": true, "description": "Specifies the absolute amount (in USD) of tip to be added.\n\nThis amount adds to the base amount of the original transaction.\nThat transaction must be authorized first.\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.\n\n\nExample: 14.50\n", "example": 14.5 }, "tipRate": { "type": "number", "format": "double", "nullable": true, "description": "Specifies the tip rate as a percentage of the base amount to be added.\n\nThis amount adds to the base amount of the original transaction.\nThat transaction must be authorized first.\n\n\nValues for tipAmount and tipRate are mutually exclusive.\nCare must be taken to include one or the other but not both.\n\n\nExample: 15 (as 15%)\n", "example": 15 }, "percentageOffRate": { "type": "number", "format": "double", "nullable": true, "description": "Identifies the discount percentage.\n\nThis value is percentage rate for the discount.\n\nExample: 3.5 (as 3.5%)\n", "example": 3.5 }, "surchargeRate": { "type": "number", "format": "double", "nullable": true, "description": "Identifies the surcharge percentage.\n\nThis is a surcharge on the base amount.\nThis value is surcharge percentage rate.\nThis surcharge percentage calculates the surcharge amount for `surchargeAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "useCardPrice": { "type": "boolean", "description": "Parameter is mandatory when merchant has ZeroCostProcessingOption == Dual Pricing. \n\nParameter must be null when merchant has other ZeroCostProcessingOption. \n\nFor Dual Pricing, amount should be the card price and useCardPrice should be `true`, or amount should be the cash price and useCardPrice should be `false'.\n", "nullable": true }, "appVersion": { "type": "string", "nullable": true, "description": "Specifies the version of the mobile app.\n\nThis value is stored on the transaction.\nIt is visible in the transaction details.\nThe `appVersion` value takes priority over the `sdkVersion` if both are present.\n\nExample: 10.413.01\n", "example": "10.413.01" }, "sdkVersion": { "type": "string", "nullable": true, "description": "Specifies the version of the Aurora SDK.\n\nThis value is stored on the transaction.\nIt is visible in the transaction details.\nThe `appVersion` value takes priority over the `sdkVersion` if both are present.\n\nExample: 8.61.08\n", "example": "8.61.08" }, "billingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto" }, "shippingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto" }, "contactInfo": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.ContactInfoDto" }, "securityCode": { "type": "string", "nullable": true, "description": "Specifies the three or four digit security code on the credit card." }, "track1": { "type": "string", "description": "Specifies the card data from track 1 of the magnetic stripe.", "nullable": true }, "track2": { "type": "string", "description": "Information stored on the magnetic stripe of a credit or debit card.\n\nThis includes the card number, expiration date, and cardholder's name.\n", "nullable": true }, "emvTags": { "type": "array", "items": { "type": "string" }, "description": "Each tag corresponds to a particular piece of data stored on the card.", "nullable": true }, "emvPaymentAppVersion": { "type": "string", "description": "Specifies the version number of the payment application in use.", "nullable": true }, "pin": { "type": "string", "description": "Specifies the encrypted PIN for the terminal.", "nullable": true }, "pinKsn": { "type": "string", "description": "Specifies the KSN for DUKPT PIN encryption.\n\nRequired only if the PIN is encrypted using DUKPT.\n", "nullable": true }, "debit": { "type": "boolean", "description": "IF Debit THEN use card as a debit card, else use card as a credit card\n", "nullable": true }, "emvFallbackCondition": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackCondition" }, "emvFallbackLastChipRead": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead" }, "referenceId": { "type": "string", "description": "Specifies an external transaction identifier for client-side tracking.\n\nAlso used in duplicate control validation.\nA unique value allows similar transactions to process as distinct, bypassing duplicate blocking when needed.\n", "nullable": true }, "l2": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL2Data" }, "l3": { "$ref": "#/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL3Data" }, "customerInitiatedTransaction": { "type": "boolean", "default": false, "description": "Customer Initiated Transaction if true.\n\nMerchant Initiated Transaction if false\n" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Capture.IsvCaptureRequest": { "required": [ "amount", "transactionId" ], "type": "object", "properties": { "amount": { "type": "number", "description": "Specifies the base amount of the transaction before adjustments (if any).\n\nAdjustments, such as tips, discounts, and surcharges, are added individually through request parameters.\nThe call makes all adjustments during processing.\nThe total amount charged is returned in the response body `amount.totalAmount`.\n\nExample: 124.86\n", "example": 124.86, "format": "double" }, "transactionId": { "type": "string", "description": "Specifies the transactionId from the original authorization.\n\nAfter the transaction is complete, the transactionId is invalidated for future attempts.\n\nExample: 19be194d-d962-41e2-bba0-ee719ed94634\n", "example": "19be194d-d962-41e2-bba0-ee719ed94634", "format": "uuid" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvTransactionResponse": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "Indicates the transaction identifier.\n\nExample: c7c15dd0-03e7-4e55-917c-54bedafba5e7\n", "example": "c7c15dd0-03e7-4e55-917c-54bedafba5e7", "format": "uuid" }, "transactionDateTime": { "type": "string", "description": "Indicates the date-time (in ISO 8601 UTC or timezone offset format) of the transaction.\n\nExamples:
\n2026-08-24T08:45:22Z
\n2026-08-24T14:15:22+05:30\n", "example": "2026-08-24T08:45:22Z", "format": "date-time" }, "typeId": { "type": "integer", "description": "Type id of transaction.", "format": "int32" }, "type": { "type": "string", "description": "Type name of transaction", "nullable": true }, "statusId": { "type": "integer", "description": "Status id of transaction.", "format": "int32" }, "status": { "type": "string", "description": "Status name of transaction", "nullable": true }, "details": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto" }, "transactionReceipt": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Return.IsvReturnRequest": { "required": [ "cardDataSource", "transactionId" ], "type": "object", "properties": { "cardDataSource": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource" }, "transactionId": { "type": "string", "format": "uuid", "description": "Specifies the transaction identifier.\n\nExample: 94c59697-3db4-4ef7-84f7-b1cc14f21d93\n", "example": "94c59697-3db4-4ef7-84f7-b1cc14f21d93" }, "track1": { "type": "string", "description": "The card data from track 1 of the magnetic stripe.", "nullable": true }, "track2": { "type": "string", "description": "Information stored on the magnetic stripe of a credit or debit card, including the card number, expiration date, and cardholder's name.", "nullable": true }, "emvTags": { "type": "array", "items": { "type": "string" }, "description": "Each tag corresponds to a particular piece of data stored on the card.", "nullable": true }, "emvPaymentAppVersion": { "type": "string", "description": "The version number of the payment application in use.", "nullable": true }, "pin": { "type": "string", "nullable": true }, "pinKsn": { "type": "string", "nullable": true }, "amount": { "type": "number", "description": "Amount", "format": "double", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Return.ReturnWORefRequest": { "required": [ "cardDataSource", "currencyId", "debit", "paymentProcessorId" ], "type": "object", "properties": { "cardDataSource": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource" }, "currencyId": { "type": "integer", "description": "Specifies the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1, "format": "int32" }, "debit": { "type": "boolean", "description": "Specifies the card as a debit card.\n\nIf `true`, the card as a debit card.
\nIf `false`, the card as a credit card.\n\nExample: true\n", "example": true }, "paymentProcessorId": { "type": "string", "format": "uuid", "description": "Specifies the identifier assigned to the payment processor.\n\nExample: 0c16d6e5-6157-42f0-a285-d14abbc54faa\n", "example": "0c16d6e5-6157-42f0-a285-d14abbc54faa" }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "amount": { "type": "number", "description": "The amount of the transaction.", "format": "double" }, "accountNumber": { "type": "string", "description": "The 13-19 digit card number used for the transaction.\n\nThis field may contain a token issued against a card number.\nThis is de-tokenized by TransIT to process the transaction.\n\nExample: 5413591081013511\nexample: \"5413591081013511\"\n", "nullable": true }, "securityCode": { "type": "string", "description": "The three or four digit security code on the credit card.", "nullable": true }, "expirationMonth": { "type": "integer", "description": "The expiration month of the card", "format": "int32", "nullable": true }, "expirationYear": { "type": "integer", "description": "The expiration year of the card", "format": "int32", "nullable": true }, "track1": { "type": "string", "description": "Magnetic track 1.", "nullable": true }, "track2": { "type": "string", "description": "Magnetic track 2.", "nullable": true }, "emvTags": { "type": "array", "items": { "type": "string" }, "description": "Holds data fetched from a EMV Chip Credit/Debit card to perform transaction.\nThat is a string array of variable size, should be used as is.", "nullable": true }, "emvPaymentAppVersion": { "type": "string", "description": "The version number of the payment application in use.", "nullable": true }, "billingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto" }, "shippingAddress": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto" }, "contactInfo": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.ContactInfoDto" }, "pin": { "type": "string", "description": "Encrypted PIN for the terminal.", "nullable": true }, "pinKsn": { "type": "string", "description": "The KSN for DUKPT PIN encryption.\nRequired only if the PIN is encrypted using DUKPT.", "nullable": true }, "emvFallbackCondition": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackCondition" }, "emvFallbackLastChipRead": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead" }, "referenceId": { "type": "string", "description": "Specifies an external transaction identifier for client-side tracking.\n\nAlso used in duplicate control validation.\nA unique value allows similar transactions to process as distinct, bypassing duplicate blocking when needed.\n", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Settle.IsvSettleRequest": { "required": [ "paymentProcessorId" ], "type": "object", "properties": { "paymentProcessorId": { "type": "string", "format": "uuid", "description": "Specifies the payment processor identifier.\n\nExample: 8f5a4c27-71c4-4b5d-944e-8bb457594d86\n", "example": "8f5a4c27-71c4-4b5d-944e-8bb457594d86" } }, "additionalProperties": false }, "PaymentGateway.Contracts.Enums.ResponseCode": { "type": "integer", "description": "xxx A vendor independent response code.

Possible values:\n\n| Value | Name | Description |\n|-------|---------|------------------------------------------------------------------------------|\n| 0 | Approve | Operation fully or partially approved. |\n| 1 | Decline | Operation declined. |\n| 2 | Error | Something prevents to complete the operation. Request format is wrong, or system error, or any other reason that prevented normal processing. |\n\nExample: 0\n", "example": 0, "format": "int32" }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Settle.IsvSettleResponse": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.ResponseCode" }, "message": { "type": "string", "description": "Free-form result description.", "nullable": true }, "processorResponseCode": { "type": "string", "description": "Processor-specific response code that precisely describes the operation result.", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.Void.IsvVoidRequest": { "required": [ "transactionId" ], "type": "object", "properties": { "transactionId": { "type": "string", "format": "uuid", "description": "Specifies the transaction identifier.\n\nExample: c7c15dd0-03e7-4e55-917c-54bedafba5e7\n", "example": "c7c15dd0-03e7-4e55-917c-54bedafba5e7" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.TipAdjustment.TipAdjustmentRequest": { "type": "object", "required": [ "transactionId", "tipAmount" ], "properties": { "transactionId": { "type": "string", "description": "Specifies the transaction identifier.\n\nExample: c7c15dd0-03e7-4e55-917c-54bedafba5e7\n", "example": "c7c15dd0-03e7-4e55-917c-54bedafba5e7", "format": "uuid" }, "tipAmount": { "type": "number", "format": "double", "description": "Specifies the absolute amount (in USD) of tip to be added.\n\nThis amount adds to the base amount of the original transaction.\nThat transaction must be authorized first.\n\nExample: 14.50\n", "example": 14.5 } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.Transactions.SendReceiptBySms.SendIsvTransactionReceiptBySmsRequest": { "required": [ "customerConsent", "phoneNumber" ], "type": "object", "properties": { "phoneNumber": { "minLength": 1, "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "Identifies the customer's phone number.\n\nExample: +15551234567\n", "example": "+15551234567" }, "customerConsent": { "type": "boolean", "description": "Identifies the customer has consented to receiving the SMS.\n\nIf `true`, the customer has consented to receiving the SMS.
\nIf `false`, the customer has not consented to receiving the SMS.\n\nExample: true\n", "example": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.Enums.Currency": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|------|\n| 1 | USD |\n\nExample: 1\n", "example": 1, "format": "int32" }, "PaymentGateway.Contracts.PublicApi.Isv.Amounts.IsvAmountsResponse": { "type": "object", "properties": { "currencyId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.Currency" }, "currency": { "type": "string", "nullable": true, "readOnly": true }, "zeroCostProcessingOptionId": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.ZeroCostProcessingOption" }, "zeroCostProcessingOption": { "type": "string", "nullable": true, "readOnly": true, "description": "Zero Cost Processing Option name.\n\nPossible values:\n\n| Type | Id |\n|--------------|:--:|\n| None | 1 |\n| CashDiscount | 2 |\n| DualPricing | 3 |\n| Surcharge | 4 |\n\nExample: DualPricing\n", "example": "DualPricing" }, "useCardPrice": { "type": "boolean", "nullable": true }, "cash": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto" }, "creditCard": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto" }, "debitCard": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto" }, "ach": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto" } }, "additionalProperties": false }, "PaymentGateway.Contracts.TransactionSettings.L2Settings": { "type": "object", "properties": { "taxRate": { "type": "number", "description": "The type of tax rate.\nThis field is used if taxCategory is not used.\nDefault sale tax rate in percentage Must be between 0% - 22% ,Applicable only Level 2 AutoFill.", "format": "double", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.TransactionSettings.Product": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the product.", "nullable": true }, "code": { "type": "string", "description": "The merchant assigned unique product identification code.", "nullable": true }, "unitPrice": { "type": "number", "description": "The unit price for the product.", "format": "double", "nullable": true }, "measurementUnit": { "type": "string", "description": "The unit of measurement for the product.", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of the product.", "format": "double", "nullable": true }, "discountPercentage": { "type": "number", "description": "Product discount percentage", "format": "double", "nullable": true }, "description": { "type": "string", "description": "Product description", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.TransactionSettings.L3Settings": { "type": "object", "properties": { "product": { "$ref": "#/components/schemas/PaymentGateway.Contracts.TransactionSettings.Product" }, "shippingCharge": { "type": "number", "description": "The percentage for shipping or freight charges applied to a product or transaction.", "format": "double", "nullable": true }, "dutyChargeRate": { "type": "number", "description": "Indicates the percentage for any import or export duties included in the order.", "format": "double", "nullable": true } }, "additionalProperties": false }, "PaymentGateway.Contracts.TransactionSettings.GetAutofillSettingsResponseDto": { "type": "object", "properties": { "l2Settings": { "$ref": "#/components/schemas/PaymentGateway.Contracts.TransactionSettings.L2Settings" }, "l3Settings": { "$ref": "#/components/schemas/PaymentGateway.Contracts.TransactionSettings.L3Settings" } }, "additionalProperties": false }, "PaymentGateway.Contracts.PublicApi.Isv.TransactionSettings.CreateAutofillSettingsRequest": { "required": [ "l2Settings", "l3Settings" ], "type": "object", "properties": { "l2Settings": { "$ref": "#/components/schemas/PaymentGateway.Contracts.TransactionSettings.L2Settings" }, "l3Settings": { "$ref": "#/components/schemas/PaymentGateway.Contracts.TransactionSettings.L3Settings" } }, "additionalProperties": false }, "SubscriptionsService.Contracts.Subscriptions.PaymentAmountDto": { "type": "object", "properties": { "baseAmount": { "type": "number", "format": "double", "description": "Identifies the original amount (in USD) of a transaction before adjustments are applied.\n\nExample: 129.99\n", "example": 129.99 }, "percentageOffAmount": { "type": "number", "format": "double", "description": "Identifies the discount amount (in USD) taken off.\n\nThis discount was calculated using the preset percentage from `percentageOffRate`.\n\nExample: 12.50\n", "example": 12.5 }, "percentageOffRate": { "type": "number", "format": "double", "description": "Identifies the discount percentage.\n\nThis value is percentage rate for the discount.\nThis discount percentage calculates the discount amount for `percentageOffAmount`.\n\nExample: 3.5 (as 3.5%)\n", "example": 3.5 }, "cashDiscountAmount": { "type": "number", "format": "double", "description": "Identifies the discount amount (in USD) when a cash (or cash-equivalent) discount is applied.\n\nThis discount was calculated using the preset percentage from `cashDiscountRate`.\n\nExample: 10.55\n", "example": 10.55 }, "cashDiscountRate": { "type": "number", "format": "double", "description": "Identifies the discount percentage for a cash (or cash-equivalent) discount.\n\nThis value is percentage rate for the discount.\nThis discount percentage calculates the discount amount for `cashDiscountAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "surchargeAmount": { "type": "number", "format": "double", "description": "Identifies the amount (in USD) when a surcharge is applicable.\n\nThis is a surcharge on the base amount.\nThis surcharge was calculated using the preset percentage from `surchargeRate`.\n\nExample: 6.45\n", "example": 6.45 }, "surchargeRate": { "type": "number", "format": "double", "description": "Identifies the surcharge percentage.\n\nThis is a surcharge on the base amount.\nThis value is surcharge percentage rate.\nThis surcharge percentage calculates the surcharge amount for `surchargeAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "totalAmount": { "type": "number", "format": "double", "description": "Specifies the transaction's total amount. \n\nThis includes the base amount, tips, taxes, discounts, and other charges.\n\nExample: 3219.45\n", "example": 3219.45 } }, "additionalProperties": false }, "SubscriptionsService.Contracts.Enums.PaymentFrequencyUnit": { "type": "integer", "format": "int32", "description": "Indicates the payment frequency unit.\n\nAs examples:
\nWith a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of `1`, payments are made once a week.
\nWith a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of `2`, payments are made twice a week\n\nPossible values:\n\n| ID | Label |\n|:--:|---------|\n| 1 | Daily |\n| 2 | Weekly |\n| 3 | Monthly |\n\nExample: 3\n", "example": 3 }, "SubscriptionsService.Contracts.Subscriptions.Get.GetSubscriptionResponseDto.CustomerDto": { "type": "object", "description": "
Indicates an object for returning subscription details.\n", "properties": { "customerName": { "type": "string", "description": "Indicates the customer's full name.\n\nExample: Alexandro Peppared\n", "example": "Example: Alexandro Peppard", "nullable": true }, "companyName": { "type": "string", "description": "Indicates the name of the customer's company or organization.\n\nExample: Peppared Street Cafe\n", "example": "Example: Peppared Street Cafe", "nullable": true }, "panMask": { "type": "string", "description": "Indicates the masked PAN (primary Account number).\n\nThis is a partially obscured representation of a card's PAN.\nThis value can be safely displayed to clients without revealing the actual or full account number,\n\nExamples:
\n4111********1234
\n************1234
\n****1234\n", "example": "4111********1234", "nullable": true }, "cardTokenType": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.TokenType" }, "emailAddress": { "type": "string", "description": "Indicates the customer's email contact.\n\nExample: peppared@example.com\n", "example": "peppared@example.com", "nullable": true }, "phoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "nullable": true, "description": "Indicates the customer's telephone number.\n\nExample: +15551234567\n", "example": "+15551234567" } }, "additionalProperties": false }, "SubscriptionsService.Contracts.SourceResponseDto": { "type": "object", "properties": { "typeId": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubscriptionsService.Contracts.InternalApi.Subscriptions.Get.GetSubscriptionResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Indicates the subscription identifier.\n\nExample: 35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14\n", "example": "35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14" }, "merchantId": { "type": "string", "format": "uuid", "description": "Indicates the merchant identifier.\n\nExample: 46f7a8b9-0c1d-4e2f-3a4b-5c6d7e8f9a25\n", "example": "46f7a8b9-0c1d-4e2f-3a4b-5c6d7e8f9a25" }, "paymentProcessorId": { "type": "string", "format": "uuid", "description": "Indicates the payment processor identifier.\n\nExample: 57a8b9c0-1d2e-4f3a-4b5c-6d7e8f9a0b36\n", "example": "57a8b9c0-1d2e-4f3a-4b5c-6d7e8f9a0b36" }, "statusId": { "type": "integer", "format": "int32", "description": "Indicates the subscription status identifier.\n\nPossible values:\n\n| Value | Meaning | \n|:-----:|------------| \n| 1 | Active | \n| 2 | Completed | \n| 3 | Suspended | \n| 4 | Delinquent | \n| 5 | Terminated |\n| 6 | Deleted |\n\nExample: 2\n", "example": 2 }, "status": { "type": "string", "nullable": true, "description": "Indicates the subscription status.\n\nPossible values:\n| Value | Meaning | \n|------------|:----------:| \n| Active | 1 | \n| Completed | 2 |\n| Suspended | 3 | \n| Delinquent | 4 | \n| Terminated | 5 |\n| Deleted | 6 |\n\nExample: Completed\n", "example": "Completed" }, "transactionTypeId": { "type": "integer", "description": "Indicates the Aurora transaction type identifier code value.\n\nExample: 6\n", "example": 6, "format": "int32" }, "transactionType": { "type": "string", "description": "Indicates the Aurora transaction type identifier code name.\n\nExample: CardAuthentication\n", "example": "CardAuthentication", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "paymentMethodId": { "$ref": "#/components/schemas/ach_paymentmethodid" }, "paymentAmount": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.Subscriptions.PaymentAmountDto" }, "alreadyPaidAmount": { "type": "number", "format": "double", "description": "Indicates the total amount the client has already paid as part of this subscription.\n\nExample: 259.99\n", "example": 259.99 }, "allPaymentsAmount": { "type": "number", "format": "double", "description": "Indicates the total of all amounts due of the subscription.\n\nExample: 54.92\n", "example": 54.92 }, "currencyId": { "type": "integer", "format": "int32", "description": "Indicates the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1 }, "paymentFrequencyUnitId": { "type": "integer", "description": "Indicates the payment frequency identifier.\n\nPossible values:\n\n| ID | Label |\n|:--:|---------|\n| 1 | Daily |\n| 2 | Weekly |\n| 3 | Monthly |\n\nExample: 3\n", "example": 3, "format": "int32" }, "paymentFrequencyUnit": { "allOf": [ { "$ref": "#/components/schemas/SubscriptionsService.Contracts.Enums.PaymentFrequencyUnit" } ], "nullable": true }, "paymentFrequency": { "type": "integer", "format": "int32", "description": "Indicates the payment frequency identifier.\n\nPossible values:\n\n| Value | Meaning |\n|---------|:--:|\n| Daily | 1 |\n| Weekly | 2 |\n| Monthly | 3 |\n \nAs examples:
\nWith a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of `1`, payments are made once a week.
\nWith a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of `2`, payments are made twice a week.\n\nExample: Weekly\n", "example": "Weekly" }, "createdOn": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the subscription was created.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "subscriptionStartDate": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's first payment.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "subscriptionEndDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's last payment.\n\nExamples:
\n2027-02-19T20:24:52.934Z
\n2027-02-19T20:24:52.934+05:30
\n2027-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "lastPaymentDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's last payment date.\n\nExamples:
\n2027-02-19T20:24:52.934Z
\n2027-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "nextPaymentDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's next payment date.\n\nExamples:
\n2026-03-19T20:24:52.934Z
\n2026-03-19T20:24:52.934+05:30
\n2026-03-19T20:24:52.934-06:00\n", "example": "2026-03-19T20:24:52.934+05:" }, "successfulPaymentsCount": { "type": "integer", "description": "Indicates the number of successful payments for the subscription.\n\nSee `numberOfPayments` for the total expected number of payments.\n\nExample: 32\n", "example": 32, "format": "int32" }, "numberOfPayments": { "type": "integer", "description": "Total number of payments for the subscription.\n\nSee `successfulPaymentsCount` for the current number of payments.\n\nExample: 60\n", "example": 60, "format": "int32" }, "customer": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.Subscriptions.Get.GetSubscriptionResponseDto.CustomerDto" }, "source": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.SourceResponseDto" } }, "additionalProperties": false }, "SubscriptionsService.Contracts.Enums.TransactionType": { "type": "integer", "description": "Specifies the transaction type.\n\nPossible values:\n\n| Id | Type | Notes |\n|:--:|---------------| ----- |\n| 1 | Authorization | |\n| 2 | Sale | The field `secCode` must also be omitted or set to null. |\n| 11 | AchDebit | The field `secCode` must also be set to a valid value. |\n\nExample: 11\n", "example": 11, "format": "int32" }, "SubscriptionsService.Contracts.Subscriptions.Create.CreateSubscriptionRequestDto": { "type": "object", "required": [ "amount", "currencyId", "paymentProcessorId", "transactionType", "paymentFrequencyUnit", "paymentFrequency", "numberOfPayments", "customerId", "paymentMethodId", "isFasterProcessing" ], "properties": { "amount": { "type": "number", "description": "Specifies the total amount due (in USD) of the transaction.\n\nExample: 43.99\n", "example": 43.99, "format": "double" }, "transactionType": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.Enums.TransactionType" }, "currencyId": { "type": "integer", "format": "int32", "description": "Specifies the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1 }, "paymentProcessorId": { "type": "string", "format": "uuid", "description": "Specifies the payment processor identifier.\n\nExample: 8ebb41c8-e1b0-4777-8f8e-1402e756ee7d\n", "example": "8ebb41c8-e1b0-4777-8f8e-1402e756ee7d" }, "paymentMethodId": { "type": "string", "description": "Specifies the payment method identifier.\n\nMust be added and active before subscription creation.\n\nExample: 7ef038b0-d612-4d10-9e2c-80e791b54632\nexample: \"7ef038b0-d612-4d10-9e2c-80e791b54632\"\n", "format": "uuid" }, "paymentFrequencyUnit": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.Enums.PaymentFrequencyUnit" }, "paymentFrequency": { "type": "integer", "description": "Specifies the frequency of the payment value.\n\nAs examples:
\nWith a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of `1`, payments are made once a week.
\nWith a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of `2`, payments are made twice a week.\n\nExample: 2\n", "example": 2, "format": "int32" }, "numberOfPayments": { "type": "integer", "format": "int32", "description": "Specifies the number of payments for the subscription.\n\nExample: 60\n", "example": 60 }, "customerId": { "type": "string", "description": "Specifies the customer identifier of the subscription.\n\nExample: d368cf28-4390-4f6d-b363-ce8d112e8517\n", "example": "d368cf28-4390-4f6d-b363-ce8d112e8517", "format": "uuid" }, "isFasterProcessing": { "$ref": "#/components/schemas/ach_isfasterprocessing" }, "useCardPrice": { "type": "boolean", "nullable": false, "description": "Specifies appling the card-based pricing instead of the cash-based pricing.\n\nThe card price is typically higher because of processing fees.\nThis fee is embedded in the price and not added as a line item.\n\nIf `true`, use card-based pricing.
\nIf `false`, use cash-based pricing.\n\n\nThis value is required when the merchant ZeroCostProcessingOption is DualPricing. \n\n\n
\nThis value must be null when the merchant ZeroCostProcessingOption is other than DualPricing. \n\n\nExample: true\n", "example": true }, "secCode": { "type": "integer", "description": "
Specifies the SEC (standard entry class) code for the payment method.\n\n\n This value is required if transactionType is 11 (AchDebit).
\n\n\n
\n This value must be omitted or null if transactionType is 2 (Sale).\n\n\nAllowed values:\n\n| secCode ID | Entry Type | Description |\n| :--------: |------------|-------------|\n| 1 | Web | Internet-initiated/mobile entries. |\n| 2 | PPD | Prearranged payment and deposit entries. |\n| 3 | CCD | Corporate credit or debit. |\n| 4 | Telephone | Telephone-initiated entries. |\n\nExample: 1\n", "example": 1, "format": "int32", "default": 1 }, "percentageOffRate": { "type": "number", "description": "Specifies the percent of the base amount to be discounted.\n\nExample:
\n8.25 (as 8.25%)
\n12 (as 12%)\n", "example": 12, "format": "double", "nullable": true }, "surchargeRate": { "type": "number", "description": "Specifies the surcharge percentage.\n\nThis is a surcharge on the base amount.\nThis value is surcharge percentage rate.\nThis surcharge percentage calculates the surcharge amount for `surchargeAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5, "format": "double", "nullable": true }, "paymentStartDateTime": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's first payment date.\n\nIf omitted or null, it indicates immediate payment(PayNow).\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" } }, "additionalProperties": false }, "SubscriptionsService.Contracts.Subscriptions.Create.CreateSubscriptionResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Subscription Id", "format": "uuid" }, "payNowSuccess": { "type": "boolean", "description": "True if PayNow was executed successfully, otherwise false.", "nullable": true }, "transactionId": { "type": "string", "description": "Transaction Id if PayNowSuccess was True.", "format": "uuid", "nullable": true }, "payNowResponse": { "type": "string", "description": "Payment response if PayNowSucess was False.", "nullable": true } }, "additionalProperties": false }, "SubscriptionsService.Contracts.Subscriptions.Isv.GetSubscriptionPayments.GetIsvSubscriptionPaymentAttemptResponseDto": { "type": "object", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "Indicates the subscription identifier.\n\nExample: 35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14\n", "example": "35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14" }, "executionDateTime": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's execution.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "statusId": { "type": "integer", "format": "int32", "description": "Indicates the subscription status identifier.\n\nPossible values:\n\n| Value | Meaning | \n|:-----:|------------| \n| 1 | Active | \n| 2 | Completed | \n| 3 | Suspended | \n| 4 | Delinquent | \n| 5 | Terminated |\n| 6 | Deleted |\n\nExample: 2\n", "example": 2 }, "status": { "type": "string", "nullable": true, "description": "Indicates the subscription status.\n\nPossible values:\n| Value | Meaning | \n|------------|:----------:| \n| Active | 1 | \n| Completed | 2 |\n| Suspended | 3 | \n| Delinquent | 4 | \n| Terminated | 5 |\n| Deleted | 6 |\n\nExample: Completed\n", "example": "Completed" }, "transactionStatusId": { "type": "integer", "format": "int32", "nullable": true }, "transactionStatus": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "SubscriptionsService.Contracts.Subscriptions.Isv.GetSubscriptionPayments.GetIsvSubscriptionPaymentsResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Indicates the subscription identifier.\n\nExample: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58\n" }, "initialExecutionDateTime": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's initial execution.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+0" }, "statusId": { "type": "integer", "format": "int32", "description": "Indicates the subscription status identifier.\n\nPossible values:\n\n| Value | Meaning | \n|:-----:|------------| \n| 1 | Active | \n| 2 | Completed | \n| 3 | Suspended | \n| 4 | Delinquent | \n| 5 | Terminated |\n| 6 | Deleted |\n\nExample: 2\n", "example": 2 }, "status": { "type": "string", "nullable": true, "description": "Indicates the subscription status.\n\nPossible values:\n| Value | Meaning | \n|------------|:----------:| \n| Active | 1 | \n| Completed | 2 |\n| Suspended | 3 | \n| Delinquent | 4 | \n| Terminated | 5 |\n| Deleted | 6 |\n\nExample: Completed\n", "example": "Completed" }, "amount": { "type": "number", "format": "double", "description": "Indicates the payment amount.\n\nExample: 129.99\n", "example": 129.99 }, "paymentOrder": { "type": "integer", "format": "int32", "description": "Indicates a payment attempt identifier.\n\nExample: 748411\n", "example": 748411 }, "attempts": { "type": "array", "description": "
Indicates the history of attempting to complete this order.\n", "items": { "$ref": "#/components/schemas/SubscriptionsService.Contracts.Subscriptions.Isv.GetSubscriptionPayments.GetIsvSubscriptionPaymentAttemptResponseDto" }, "nullable": true } }, "additionalProperties": false }, "SubscriptionsService.Contracts.InternalApi.Subscriptions.Terminate.TerminateSubscriptionResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Indicates the subscription identifier.\n\nExample: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58\n" }, "statusId": { "type": "integer", "format": "int32", "description": "Indicates the subscription status identifier.\n\nPossible values:\n\n| Value | Meaning | \n|:-----:|------------| \n| 1 | Active | \n| 2 | Completed | \n| 3 | Suspended | \n| 4 | Delinquent | \n| 5 | Terminated |\n| 6 | Deleted |\n\nExample: 2\n", "example": 2 }, "status": { "type": "string", "nullable": true, "description": "Indicates the subscription status.\n\nPossible values:\n| Value | Meaning | \n|------------|:----------:| \n| Active | 1 | \n| Completed | 2 |\n| Suspended | 3 | \n| Delinquent | 4 | \n| Terminated | 5 |\n| Deleted | 6 |\n\nExample: Completed\n", "example": "Completed" }, "message": { "type": "string", "nullable": true, "description": "Indicates a message with additional details.\n\nExample: Subscription is terminated. Future payments will no longer be processed. This action is permanent.\n", "example": "Subscription is terminated. Future payments will no longer be processed. This action is permanent" } }, "additionalProperties": false }, "PosService.Contracts.PosTransactionStatus": { "type": "integer", "description": "Indicates the value of the status identifier.\n\nPossible values:\n\n| Value | Name |\n|:-----:|----------------------------|\n| 1 | TerminalConnecting |\n| 2 | TransactionProcessing |\n| 3 | DeclinedByProcessor |\n| 4 | CancelByPos |\n| 5 | CancelByTerminal |\n| 6 | Completed |\n| 7 | Error |\n| 8 | Inconsistency |\n| 9 | TerminalOffline |\n| 10 | TransactionSentToProcessor |\n\nExample: 2\n", "example": 2, "format": "int32" }, "PosService.Contracts.TransactionType": { "type": "integer", "description": "Set the transaction type to be processed by the terminal.\n\nPossible values:\n\n| Id | Type | Remarks |\n|:--:|--------------------|---------|\n| 1 | Authorization | |\n| 2 | Sale | |\n| 3 | Capture | |\n| 4 | Void | |\n| 5 | Refund | |\n| 6 | CardAuthentication | |\n| 7 | RefundWORef | Refund without reference.

As a warning, these are considered high-risk transaction types, as funds are debited directly from the merchant’s account even if the original sale was not processed through Aurora. |\n| 8 | TipAdjustment | |\n| 10 | Settle | |\n\nExample: 10\n", "example": 10, "format": "int32" }, "PosService.Contracts.PosTransactions.Get.ListPosTransactionsResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of POS transaction", "format": "uuid" }, "createdOn": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the POS transaction creation.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "terminalId": { "type": "string", "description": "ID of terminal should handle POS Transaction", "format": "uuid" }, "posTransactionStatusId": { "$ref": "#/components/schemas/PosService.Contracts.PosTransactionStatus" }, "posTransactionStatus": { "type": "string", "description": "Indicates the status identifier.\n\nPossible values:\n\n| Name | Value |\n|----------------------------|:-----:|\n| TerminalConnecting | 1 |\n| TransactionProcessing | 2 |\n| DeclinedByProcessor | 3 |\n| CancelByPos | 4 |\n| CancelByTerminal | 5 |\n| Completed | 6 |\n| Error | 7 |\n| Inconsistency | 8 |\n| TerminalOffline | 9 |\n| TransactionSentToProcessor | 10 |\n\nExample: TransactionProcessing\n", "example": "TransactionProcessing", "nullable": true, "readOnly": true }, "transactionId": { "type": "string", "description": "ID of attached transaction. Available after processing.", "format": "uuid", "nullable": true }, "amount": { "type": "number", "description": "Transaction amount for transaction types requires Amount", "format": "double", "nullable": true }, "currencyId": { "type": "integer", "description": "Indicates the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1, "format": "int32", "nullable": true }, "targetTransactionId": { "type": "string", "description": "Transaction Id for Void, Capture, Refund", "format": "uuid", "nullable": true }, "transactionTypeId": { "$ref": "#/components/schemas/PosService.Contracts.TransactionType" }, "transactionType": { "type": "string", "nullable": true, "readOnly": true, "description": "Indicates the transaction type being processed by the terminal.\n\nPossible values:\n\n| Id | Type |\n|---------------|:--:|\n| Authorization | 1 |\n| Sale | 2 |\n| Capture | 3 |\n| Void | 4 |\n| Refund | 5 |\n\nExample: Authorization\n", "example": "Authorization" }, "isCompleted": { "type": "boolean", "description": "Indicates the POS transaction completion status.\n\nIf `true`, the transaction is complete.
\nIf `false`, the transaction is being processed. \nThe POS transaction status can still be changed.\n\nExample: true\n", "example": true } }, "additionalProperties": false }, "Contracts.Page.Contracts.PosTransactions.Get.ListPosTransactionsResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PosService.Contracts.PosTransactions.Get.ListPosTransactionsResponseDto" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PosService.Contracts.Enums.PosTransactionReadingMethod": { "type": "integer", "description": "xxx Set the card reading method for the transaction.

Possible values:\n\n| Value | Name | Description |\n|-------|----------|------------------------------------------------------------------------------|\n| 1 | Reading | Regular card reading method (Tap, Insert or Swipe) [default] |\n| 2 | KeyedIn | Manual entry of card details (Keyed-in) |\n\nExample: 1\n", "example": 1, "format": "int32", "nullable": true }, "PosService.Contracts.PosTransactions.Create.CreatePosTransactionRequestDto": { "type": "object", "required": [ "amount", "currencyId", "posDeviceId", "terminalId", "transactionTypeId", "waitForAcceptanceByTerminal", "requestPaymentMethodStorageConsent", "targetTransactionId" ], "properties": { "amount": { "type": "number", "description": "Specifies the total transaction amount (in USD).\n\n\nThis is required when transactionTypeId is:\n\n| Id | Type | Remark |\n|----|---------------|--------|\n| 1 | Authorization | |\n| 2 | Sale | |\n| 7 | RefundWORef | Refund without reference.

As a warning, these are considered high-risk transaction types, as funds are debited directly from the merchant’s account even if the original sale was not processed through Aurora. |\n| 8 | TipAdjustment | |\n\n\nExample: 45.99\n", "example": 45.99, "format": "integer", "nullable": true }, "currencyId": { "type": "integer", "description": "Specifies the Aurora currency identifier.\n\nAlways set to *1*.\n\n\nThis is required when transactionTypeId is:\n\n| Id | Type | Remark |\n|----|---------------|--------|\n| 1 | Authorization | |\n| 2 | Sale | |\n| 7 | RefundWORef | Refund without reference.

As a warning, these are considered high-risk transaction types, as funds are debited directly from the merchant’s account even if the original sale was not processed through Aurora. |\n| 8 | TipAdjustment | |\n\n\nExample: 1\n", "example": 1, "format": "integer", "nullable": true }, "posDeviceId": { "type": "string", "minLength": 1, "maxLength": 36, "description": "Specifies the External POS (point of sale) device identifier.\n\nExample: 000000001\n", "example": "000000001" }, "terminalId": { "type": "string", "format": "uuid", "description": "Specifies the terminal identifier.\n\nThis is the the terminal used to initiate and handle the transaction.\n\nThis terminal must be in the semi-integrated mode and available (online and ready).\n\nExample: 914358ab-efd7-4c5c-8570-fe4c0370fc37\n", "example": "914358ab-efd7-4c5c-8570-fe4c0370fc37" }, "transactionTypeId": { "$ref": "#/components/schemas/PosService.Contracts.TransactionType" }, "waitForAcceptanceByTerminal": { "type": "boolean", "description": "Specifies the long polling response mode. \n\nIf `true`, use the long pooling response mode.\nThe HTTP response will be provided once the terminal either: \n- accepts or declines to initiate the transaction \n- times out (terminal does not respond).\n\nIf `false`, use the short pooling response mode.\nThe HTTP response will be returned immediately, while the terminal is still receiving the transaction request.\n\nIn either result, use **Gets POS transaction by ID** (`GET {{baseURL}}/pos-api/v1/pos-transactions/{{posTransactionsid}}`) to retrieve the latest information of the transaction submission.\n\nExample: true\n", "example": true }, "requestPaymentMethodStorageConsent": { "type": "boolean", "description": "Specifies to show popup about saving customer payment method information on the terminal.\n\nIf `true`, show popup about saving customer payment method information on the terminal.
\nIf `false`, do not show popup about saving customer payment method information on the terminal.\n\nExample: true\n", "example": true }, "targetTransactionId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the transaction identifier.\n\n\nThis is required for the following operations:\n\n* Capture\n* Void\n* Refund\n* TipAdjustment\n\nExample: 250521bd-1e4e-4363-8381-de512760d19a\n\n", "example": "250521bd-1e4e-4363-8381-de512760d19a" }, "referenceId": { "type": "string", "minLength": 0, "maxLength": 36, "description": "Specifies the external transaction reference identifier.", "nullable": true }, "useCardPrice": { "type": "boolean", "description": "Set the type of price being sent in the `amount` parameter.\n\nThis field is mandatory only if the merchant’s ZeroCostProcessingOption is Dual Pricing.\nFor other ZeroCostProcessingOption values, set it as `null`.\n\nIf `ZeroCostProcessingOption` is `Dual Pricing`, set `useCardPrice=true`.
\nIf the `amount` contains the card price, or `useCardPrice=false`.
\nIf the `amount` contains the cash price.\n\nThe application will automatically calculate the total amounts by each payment method based on these inputs.\n", "nullable": true }, "paymentProcessorId": { "type": "string", "description": "Set the Payment Processor ID to be used in the transaction. If not provided, it will use the merchant’s default processor.", "format": "uuid", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "readingMethodId": { "$ref": "#/components/schemas/PosService.Contracts.Enums.PosTransactionReadingMethod" } }, "additionalProperties": false }, "PosService.Contracts.PosTransactions.PosTransactionResponseDto": { "type": "object", "properties": { "posTransactionId": { "type": "string", "description": "ID of POS transaction", "format": "uuid" }, "statusId": { "$ref": "#/components/schemas/PosService.Contracts.PosTransactionStatus" }, "status": { "type": "string", "description": "Indicates the status identifier.\n\nPossible values:\n\n| Name | Value |\n|----------------------------|:-----:|\n| TerminalConnecting | 1 |\n| TransactionProcessing | 2 |\n| DeclinedByProcessor | 3 |\n| CancelByPos | 4 |\n| CancelByTerminal | 5 |\n| Completed | 6 |\n| Error | 7 |\n| Inconsistency | 8 |\n| TerminalOffline | 9 |\n| TransactionSentToProcessor | 10 |\n\nExample: TransactionProcessing\n", "example": "TransactionProcessing", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "PosService.Contracts.PosTransactions.Get.GetPosTransactionResponseDto.TransactionDto": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "Transaction ID", "format": "uuid" }, "amount": { "type": "number", "description": "Transaction amount", "format": "double", "nullable": true }, "currencyId": { "type": "integer", "format": "int32", "nullable": true, "description": "Indicates the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1 }, "transactionStatusId": { "type": "integer", "format": "int32", "description": "Indicates the transaction status identifier.\n\nPossible values:\n\n| Value | Status |\n|-------|--------|\n| 1 | Authorized |\n| 2 | Captured |\n| 3 | Voided |\n| 4 | Refunded |\n| 5 | Verified |\n| 6 | Settled |\n| 7 | PartiallyAuthorized |\n| 90 | Pending |\n| 91 | Declined |\n| 92 | Failed |\n\nExample: 6\n", "example": 6 }, "transactionStatus": { "type": "string", "nullable": true, "description": "Indicates the transaction status.\n\nPossible values:\n\n| Value | Status |\n|---------------------|:------:|\n| Authorized | 1 |\n| Captured | 2 |\n| Voided | 3 |\n| Refunded | 4 |\n| Verified | 5 |\n| Settled | 6 |\n| PartiallyAuthorized | 7 |\n| Pending | 90 |\n| Declined | 91 |\n| Failed | 92 |\n\nExample: Settled\n", "example": "Settled" }, "transactionTypeId": { "type": "integer", "format": "int32", "description": "Indicates the transaction type identifier.\n\nPossible values:\n\n| Value | Type |\n|:-----:|---------------|\n| 1 | Authorization |\n| 2 | Sale |\n| 3 | Capture |\n| 4 | Void |\n| 5 | Refund |\n| 6 | Verify |\n\nExample: 5\n", "example": 5 }, "transactionType": { "type": "string", "nullable": true, "description": "Indicates the transaction type name,\n\nPossible values:\n\n| Value | Type |\n|---------------|:-----:|\n| Authorization | 1 |\n| Sale | 2 |\n| Capture | 3 |\n| Void | 4 |\n| Refund | 5 |\n| Verify | 6 |\n\nExample: Refund\n", "example": "Refund" }, "authCode": { "type": "string", "description": "Indicates the authorization code received for the transaction.\n\nExample: VTLMC1\n", "example": "VTLMC1", "nullable": true }, "mid": { "type": "string", "nullable": true, "description": "Indicates the MID (merchant identifier) assigned to this transaction.\n\nExample: 43252511\n", "example": "43252511" }, "tid": { "type": "string", "nullable": true, "description": "Indicates the TID (terminal identifier) assigned to this transaction.\n\nExample: 8820432549239101\n", "example": "8820432549239101" } }, "additionalProperties": false }, "PosService.Contracts.PosTransactions.Get.GetPosTransactionResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of POS transaction", "format": "uuid" }, "createdOn": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the POS transaction was created.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "modifiedOn": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the last POS transaction modification.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "merchantId": { "type": "string", "description": "ARISE Merchant ID", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "terminalId": { "type": "string", "description": "ID of terminal should handle POS Transaction", "format": "uuid" }, "paymentProcessorId": { "type": "string", "description": "Predefined PaymentProcessorID", "format": "uuid", "nullable": true }, "posDeviceId": { "type": "string", "description": "External POS Device ID", "nullable": true }, "referenceId": { "type": "string", "description": "External Reference Device ID", "nullable": true }, "posTransactionStatusId": { "$ref": "#/components/schemas/PosService.Contracts.PosTransactionStatus" }, "posTransactionStatus": { "type": "string", "description": "Indicates the status identifier.\n\nPossible values:\n\n| Name | Value |\n|----------------------------|:-----:|\n| TerminalConnecting | 1 |\n| TransactionProcessing | 2 |\n| DeclinedByProcessor | 3 |\n| CancelByPos | 4 |\n| CancelByTerminal | 5 |\n| Completed | 6 |\n| Error | 7 |\n| Inconsistency | 8 |\n| TerminalOffline | 9 |\n| TransactionSentToProcessor | 10 |\n\nExample: TransactionProcessing\n", "example": "TransactionProcessing", "nullable": true, "readOnly": true }, "transactionId": { "type": "string", "description": "ID of attached transaction. Available after processing.", "format": "uuid", "nullable": true }, "amount": { "type": "number", "description": "Transaction amount for transaction types requires Amount.", "format": "double", "nullable": true }, "currencyId": { "type": "integer", "format": "int32", "nullable": true, "description": "Indicates the Aurora currency identifier.\n\nAlways set to *1*.\n\nExample: 1\n", "example": 1 }, "targetTransactionId": { "type": "string", "description": "Transaction Id for Void, Capture, Refund.", "format": "uuid", "nullable": true }, "transactionTypeId": { "$ref": "#/components/schemas/PosService.Contracts.TransactionType" }, "transactionType": { "type": "string", "description": "Specifies transaction type being processed by the terminal.\n\nPossible values:\n\n| Id | Type |\n|:--:|---------------|\n| 1 | Authorization |\n| 2 | Sale |\n| 3 | Capture |\n| 4 | Void |\n| 5 | Refund |\n\nExample: 1\n", "example": "1", "nullable": true, "readOnly": true }, "isCompleted": { "type": "boolean", "description": "Indicates the POS transaction completion status.\n\nIf `true`, the transaction is complete.
\nIf `false`, the transaction is being processed. \nThe POS transaction status can still be changed.\n\nExample: true\n", "example": true }, "transaction": { "$ref": "#/components/schemas/PosService.Contracts.PosTransactions.Get.GetPosTransactionResponseDto.TransactionDto" }, "transactionReceipt": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto" } }, "additionalProperties": false }, "PosService.Contracts.PosTransactions.PrintTransactionReceipt.PrintTransactionReceiptRequestDto": { "type": "object", "properties": { "terminalId": { "type": "string", "description": "Terminal ID from the terminal that will initiate and handle the transaction receipt print request.\nTerminal must be in the semi-integrated mode and available (online and ready).", "format": "uuid" } }, "additionalProperties": false }, "PosService.Contracts.Terminals.List.GetTerminalsResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "merchantId": { "type": "string", "format": "uuid", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "terminalManufacturer": { "type": "string", "nullable": true }, "terminalModel": { "type": "string", "nullable": true }, "deliveryStatusId": { "type": "integer", "format": "int32" }, "deliveryStatusName": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the terminal creation.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "modifiedOn": { "type": "string", "format": "date-time", "nullable": true }, "merchantCompanyName": { "type": "string", "nullable": true }, "terminalModeId": { "type": "integer", "format": "int32" }, "terminalModeName": { "type": "string", "nullable": true, "readOnly": true }, "connectionStatusId": { "type": "integer", "format": "int32", "nullable": true }, "connectionStatus": { "type": "string", "nullable": true, "readOnly": true }, "lastSeenTimestamp": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) the terminal was last seen or used.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" } }, "additionalProperties": false }, "Contracts.Page.Contracts.Terminals.List.GetTerminalsResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PosService.Contracts.Terminals.List.GetTerminalsResponseDto" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PosService.Contracts.Enums.TerminalConnectionStatus": { "type": "integer", "description": "Possible values:\n

    \n
  • 1 - Online:
    • \n
  • 2 - Offline:
    • \n
\n", "format": "int32" }, "PosService.Contracts.Enums.TerminalConnectionType": { "type": "integer", "description": "Possible values:\n\n
    \n
  • 1 - WiFi:
    • \n
  • 2 - Mobile:
    • \n
  • 3 - Ethernet:
    • \n
\n", "format": "int32" }, "PosService.Contracts.Enums.TerminalDebitPinKey": { "type": "integer", "description": "Possible values:\n
    \n
  • 1 - Injected:
    • \n
  • 2 - Missing:
    • \n
\n", "format": "int32" }, "PosService.Contracts.Enums.TerminalAvailabilityStatus": { "type": "integer", "description": "Possible values:\n
    \n
  • 1 - Ready:
    • \n
  • 2 - Busy:
    • \n
\n", "format": "int32" }, "PosService.Contracts.Enums.TerminalPrinterStatus": { "type": "integer", "description": "Possible values:\n
    \n
  • 1 - Normal:
    • \n
  • 2 - NotNormal:
    • \n
  • 3 - NotSupported:
    • \n
\n", "format": "int32" }, "PosService.Contracts.Terminals.Status.Get.Get.GetTerminalStatusResponseDto.DeviceSoftwareDetailsDto": { "type": "object", "properties": { "operatingSystem": { "type": "string", "description": "Operating System", "nullable": true }, "androidBaseServiceVersion": { "type": "string", "description": "Android Base Service Version", "nullable": true }, "sunmiTrustedManagementVersion": { "type": "string", "description": "Sunmi Trusted Management Version", "nullable": true }, "sunmiCloudConnectionVersion": { "type": "string", "description": "Sunmi Cloud Connection Version", "nullable": true }, "sunmiPayHardwareServiceVersion": { "type": "string", "description": "Sunmi Pay Hardware Service Version", "nullable": true }, "posStewardAppVersion": { "type": "string", "description": "POS Steward app version", "nullable": true }, "remoteAssistanceAppVersion": { "type": "string", "description": "Remote Assistance app version", "nullable": true }, "sunmiFutureXAppVersion": { "type": "string", "description": "SUNMI FutureX app version", "nullable": true }, "sunmiRomVersion": { "type": "string", "description": "Sunmi ROM Version", "nullable": true } }, "additionalProperties": false }, "PosService.Contracts.Enums.TerminalPosStatus": { "type": "integer", "description": "Possible values:\n
    \n
  • 1 - Active:
    • \n
  • 2 - Busy:
    • \n
  • 3 - Offline:
    • \n
\n", "format": "int32" }, "PosService.Contracts.Terminals.Status.Retrieve.RetrieveTerminalStatusResponseDto": { "type": "object", "properties": { "terminalId": { "type": "string", "description": "Terminal Id", "format": "uuid" }, "timestamp": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the terminal's status log.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "connectionStatusId": { "$ref": "#/components/schemas/PosService.Contracts.Enums.TerminalConnectionStatus" }, "connectionStatus": { "type": "string", "nullable": true, "readOnly": true }, "connectionTypeId": { "$ref": "#/components/schemas/PosService.Contracts.Enums.TerminalConnectionType" }, "connectionType": { "type": "string", "nullable": true, "readOnly": true }, "wifiConnectionStrength": { "type": "integer", "description": "Wifi Connection Strength 0-100", "format": "int32" }, "mobileConnectionStrength": { "type": "integer", "description": "Mobile Connection Strength 0-100", "format": "int32" }, "lastSeenTimestamp": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the terminal's online status.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "debitPinKeyId": { "$ref": "#/components/schemas/PosService.Contracts.Enums.TerminalDebitPinKey" }, "debitPinKey": { "type": "string", "nullable": true, "readOnly": true }, "availabilityStatusId": { "$ref": "#/components/schemas/PosService.Contracts.Enums.TerminalAvailabilityStatus" }, "availabilityStatus": { "type": "string", "nullable": true, "readOnly": true }, "ariseTerminalVersion": { "type": "string", "description": "ARISE Terminal version", "nullable": true }, "batteryLevel": { "type": "integer", "description": "Battery Level 0-100", "format": "int32" }, "printerStatusId": { "$ref": "#/components/schemas/PosService.Contracts.Enums.TerminalPrinterStatus" }, "printerStatus": { "type": "string", "nullable": true, "readOnly": true }, "deviceSoftwareDetails": { "$ref": "#/components/schemas/PosService.Contracts.Terminals.Status.Get.Get.GetTerminalStatusResponseDto.DeviceSoftwareDetailsDto" }, "terminalPosStatusId": { "$ref": "#/components/schemas/PosService.Contracts.Enums.TerminalPosStatus" }, "terminalPosStatus": { "type": "string", "description": "Terminal Status name.\nActive = 1 - terminal is online and ready to accept the POS transaction\nBusy = 2 - terminal is online, but cannot accept the POS transaction\nOffline = 3 - terminal is not subscribed for push notifications, or didn't respond before timeout issued", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Categories.Get.GetCategoriesResponseDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Gets the name of the category.", "nullable": true }, "id": { "type": "string", "description": "Gets the identifier of the category.", "format": "uuid" }, "defaultUnitTypeId": { "type": "integer", "description": "Gets the default unit type identifier for the category, if any.", "format": "int32", "nullable": true }, "itemCount": { "type": "integer", "description": "Gets the count of items within the category.", "format": "int32" } }, "additionalProperties": false, "description": "Represents the response DTO for retrieving categories." }, "PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Get.GetIsvCategoriesPageResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Categories.Get.GetCategoriesResponseDto" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Create.CreateIsvCategoryRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Sets the name of the category.", "nullable": true }, "defaultUnitTypeId": { "type": "integer", "description": "Sets the default unit type identifier for the category.", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Categories.Create.CreateCategoryResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the created category.", "format": "uuid" } }, "additionalProperties": false, "description": "Represents the response DTO after creating a category." }, "PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Update.UpdateCategoryRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Gets or sets the new name of the category.", "nullable": true }, "defaultUnitTypeId": { "type": "integer", "description": "Gets or sets the default unit type identifier for the category, if it needs to be updated.", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Enums.InvoiceStatus": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|-------------------|\n| 1 | Draft |\n| 2 | Published |\n| 3 | Paid |\n| 4 | Expired |\n| 5 | Canceled |\n| 6 | ProcessingPayment |\n| 7 | Refunded |\n\nExample: 2\n", "example": 2, "format": "int32" }, "PaymentIntegrations.Contracts.Invoices.Get.GetInvoicesResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "string", "nullable": true }, "customerName": { "type": "string", "nullable": true }, "issueDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the invoice's issue.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "dueDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) the due date of the invoice.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "paymentDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the invoice's payment date.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "totalAmount": { "type": "number", "format": "double", "description": "Specifies the transaction's total amount. \n\nThis includes the base amount, tips, taxes, discounts, and other charges.\n\nExample: 3219.45\n", "example": 3219.45 }, "status": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.InvoiceStatus" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Get.GetIsvInvoicesPageResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.Get.GetInvoicesResponseDto" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "invoice_duedate": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) the invoice is due.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "cardPaymentProcessorid": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies an identifier for the payment processor handling a card transaction.\n\nExample: 78723ff2-d47e-460b-b838-d602bdf0e1bc\n", "example": "78723ff2-d47e-460b-b838-d602bdf0e1bc" }, "ach_paymentrocessorid": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies an identifier for the automated clearing house (ACH) payment processor handling a transaction.\n\nExample: 9925a0b0-eb18-4d74-8967-7e0cf6af0729\n", "example": "9925a0b0-eb18-4d74-8967-7e0cf6af0729" }, "PaymentIntegrations.Contracts.Invoices.InvoiceAddressDto": { "type": "object", "properties": { "line1": { "type": "string", "description": "Indicates the street address.\n\nExample: 21 E. Main Street\n", "example": "21 E. Main Street", "nullable": true }, "line2": { "type": "string", "description": "Indicates additional street address information.\n\nExample: Apt. Block 6\n", "example": "Apt. Block 6", "nullable": true }, "city": { "type": "string", "description": "Identifies the name of the city.\n\nExample: Chicago\n", "example": "Chicago", "nullable": true }, "zip": { "type": "string", "nullable": true, "description": "Indicates the postal or ZIP code.\n\nExamples:
\n60612
\n60612-0001\n", "example": "60612" }, "countryId": { "type": "integer", "format": "int32", "nullable": true, "description": "Specifies the Aurora country identifier.\n\nExample: 1\n", "example": 1 }, "stateId": { "type": "integer", "description": "Specifies the Aurora US state or territory identifier code.\n\nExample: 1\n", "example": 1, "format": "int32", "nullable": true }, "stateName": { "type": "string", "description": "Indicates the state identifier (in two-letter USPS [United States Postal Service] postal code).\n\nExamples:
\nTX
\nWA
\nIL\n", "example": "TX", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto": { "type": "object", "properties": { "firstName": { "type": "string", "description": "Indicates the customer's first name.\n\nExample: Alexandro\n", "example": "Alexandro", "nullable": true }, "lastName": { "type": "string", "description": "Indicates the customer's last name.\n\nExample: Peppared\n", "example": "Peppared", "nullable": true }, "companyName": { "type": "string", "description": "Indicates the customer's company name.\n\nExample: Peppared Street Cafe\n", "nullable": true }, "email": { "type": "string", "description": "Indicates the customer's email.\n\nExample: peppared@example.com\n", "example": "peppared@example.com", "nullable": true }, "mobilePhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "Indicates the customer's mobile phone number.\n\nExample: +14155552309\n", "example": "+14155552309", "nullable": true }, "isMobileNumberSmsNotificationsEnabled": { "type": "boolean", "description": "Indicates the customer's SMS notification is enabled.\n\nIf `true`, the customer's SMS notification is enabled.
\nIf `false`, the customer's SMS notification is not enabled.
\nIf missing or omitted, the information is not available.\n\nExample: true\n" }, "useBillingAsShippingAddress": { "type": "boolean", "description": "Indicates to use the billing address as the shipping address.\n\nIf `true`, use the billing address as the shipping address.
\nIf `false`, do not use the billing address as the shipping address.\nInstead, use the field `shippingAddress`.\n\nExample: true\n", "example": true }, "billingAddress": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceAddressDto" }, "shippingAddress": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceAddressDto" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "lineItemId": { "type": "string", "format": "uuid" }, "unitTypeId": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "unitPrice": { "type": "number", "format": "double", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "discountPercentage": { "type": "number", "format": "double", "nullable": true }, "totalAmount": { "type": "number", "format": "double", "description": "Specifies the transaction's total amount. \n\nThis includes the base amount, tips, taxes, discounts, and other charges.\n\nExample: 3219.45\n", "example": 3219.45 } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Create.CreateIsvInvoiceRequest": { "type": "object", "properties": { "dueDate": { "$ref": "#/components/schemas/invoice_duedate" }, "cardPaymentProcessorId": { "$ref": "#/components/schemas/cardPaymentProcessorid" }, "achPaymentProcessorId": { "$ref": "#/components/schemas/ach_paymentrocessorid" }, "additionalNotes": { "type": "string", "nullable": true }, "shippingAmount": { "type": "number", "format": "double", "nullable": true }, "taxPercentage": { "type": "number", "format": "double", "nullable": true }, "feesPercentage": { "type": "number", "format": "double", "nullable": true }, "discountPercentage": { "type": "number", "format": "double", "nullable": true }, "merchantContactInfoId": { "type": "string", "format": "uuid", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "achAllowFasterProcessing": { "type": "boolean", "nullable": true }, "customer": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto" }, "nullable": true }, "canPriceBeForceOverrided": { "type": "boolean" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Invoices.Create.CreateInvoiceResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Invoices.InvoiceMerchantContactInfoDto": { "type": "object", "properties": { "addressLine1": { "type": "string", "nullable": true, "description": "Specifies the street address.\n\nExample: 21 E. Main Street\n", "example": "21 E. Main Street" }, "addressLine2": { "type": "string", "nullable": true, "description": "Specifies additional street address information.\n\nExample: Office 3\n", "example": "Office 3" }, "city": { "type": "string", "nullable": true, "description": "Indicates the name of the city.\n\nExample: Chicago\n", "example": "Chicago" }, "zip": { "type": "string", "nullable": true, "description": "Indicates the postal or ZIP code.\n\nExamples:
\n60612
\n60612-0001\n", "example": "60612" }, "countryId": { "type": "integer", "format": "int32", "description": "Specifies the Aurora country identifier.\n\nExample: 1\n", "example": 1 }, "stateId": { "type": "integer", "format": "int32", "nullable": true, "description": "Specifies the Aurora US state or territory identifier code.\n\nExample: 4\n", "example": 4 }, "stateName": { "type": "string", "description": "Indicates the state identifier (in two-letter USPS [United States Postal Service] postal code).\n\nExamples:
\nTX
\nWA
\nIL\n", "example": "TX", "nullable": true }, "email": { "type": "string", "nullable": true, "description": "Indicates the customer's email.\n\nExample: peppared@example.com\n", "example": "peppared@example.com" }, "businessPhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "nullable": true, "description": "Indicates the business’s mobile phone number.\n\nExample: +14155552309\n", "example": "+14155552309" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Invoices.InvoiceHistoryDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "format": "uuid" }, "typeId": { "type": "integer", "format": "int32" }, "typeName": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "notificationId": { "type": "string", "format": "uuid", "nullable": true }, "notificationType": { "type": "string", "nullable": true }, "notificationTypeId": { "type": "integer", "format": "int32", "nullable": true }, "notificationTemplateType": { "type": "string", "nullable": true }, "notificationTemplateTypeId": { "type": "integer", "format": "int32", "nullable": true }, "notificationTarget": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "format": "uuid", "nullable": true }, "paymentMethodTypeId": { "type": "integer", "format": "int32", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) the invoice was created.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceAmountsDto": { "type": "object", "properties": { "subTotalAmount": { "type": "number", "format": "double" }, "totalAmount": { "type": "number", "format": "double", "description": "Specifies the transaction's total amount. \n\nThis includes the base amount, tips, taxes, discounts, and other charges.\n\nExample: 3219.45\n", "example": 3219.45 }, "shippingAmount": { "type": "number", "format": "double" }, "taxAmount": { "type": "number", "format": "double" }, "taxPercentage": { "type": "number", "format": "double" }, "feesAmount": { "type": "number", "format": "double" }, "feesPercentage": { "type": "number", "format": "double" }, "discountAmount": { "type": "number", "format": "double" }, "discountPercentage": { "type": "number", "format": "double" }, "surchargeAmount": { "type": "number", "format": "double", "description": "Identifies the amount (in USD) when a surcharge is applicable.\n\nThis is a surcharge on the base amount.\nThis surcharge was calculated using the preset percentage from `surchargePercentage`.\n\nExample: 6.45\n", "example": 6.45 }, "surchargePercentage": { "type": "number", "format": "double", "description": "Identifies the surcharge percentage.\n\nThis is a surcharge on the base amount.\nThis value is surcharge percentage rate.\nThis surcharge percentage calculates the surcharge amount for `surchargeAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "cashDiscountAmount": { "type": "number", "format": "double", "description": "Identifies the discount amount (in USD) when a cash (or cash-equivalent) discount is applied.\n\nThis discount was calculated using the preset percentage from `cashDiscountRate`.\n\nExample: 10.55\n", "example": 10.55 }, "cashDiscountPercentage": { "type": "number", "format": "double", "description": "Identifies the discount percentage for a cash (or cash-equivalent) discount.\n\nThis value is percentage rate for the discount.\nThis discount percentage calculates the discount amount for `cashDiscountAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceCalculationsDto": { "type": "object", "properties": { "debitCard": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceAmountsDto" }, "creditCard": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceAmountsDto" }, "ach": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceAmountsDto" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Get.GetIsvInvoiceResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.InvoiceStatus" }, "issueDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the invoice's issue.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "dueDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the invoice due date.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "paymentDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the invoice payment.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "cardPaymentProcessorId": { "type": "string", "format": "uuid", "nullable": true }, "achPaymentProcessorId": { "type": "string", "format": "uuid", "nullable": true }, "additionalNotes": { "type": "string", "nullable": true }, "subTotalAmount": { "type": "number", "format": "double" }, "shippingAmount": { "type": "number", "format": "double" }, "totalAmount": { "type": "number", "format": "double", "description": "Specifies the transaction's total amount. \n\nThis includes the base amount, tips, taxes, discounts, and other charges.\n\nExample: 3219.45\n", "example": 3219.45 }, "taxPercentage": { "type": "number", "format": "double" }, "feesPercentage": { "type": "number", "format": "double" }, "discountPercentage": { "type": "number", "format": "double" }, "surchargeAmount": { "type": "number", "format": "double", "description": "Identifies the amount (in USD) when a surcharge is applicable.\n\nThis is a surcharge on the base amount.\nThis surcharge was calculated using the preset percentage from `surchargePercentage`.\n\nExample: 6.45\n", "example": 6.45 }, "surchargePercentage": { "type": "number", "format": "double", "description": "Identifies the surcharge percentage.\n\nThis is a surcharge on the base amount.\nThis value is surcharge percentage rate.\nThis surcharge percentage calculates the surcharge amount for `surchargeAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "cashDiscountAmount": { "type": "number", "format": "double", "description": "Identifies the discount amount (in USD) when a cash (or cash-equivalent) discount is applied.\n\nThis discount was calculated using the preset percentage from `cashDiscountRate`.\n\nExample: 10.55\n", "example": 10.55 }, "cashDiscountPercentage": { "type": "number", "format": "double", "description": "Identifies the discount percentage for a cash (or cash-equivalent) discount.\n\nThis value is percentage rate for the discount.\nThis discount percentage calculates the discount amount for `cashDiscountAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "paymentMethodTypeId": { "type": "integer", "format": "int32", "nullable": true }, "merchantId": { "type": "string", "format": "uuid" }, "merchantContactInfoId": { "type": "string", "format": "uuid", "nullable": true }, "merchantContactInfo": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceMerchantContactInfoDto" }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "customer": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto" }, "nullable": true }, "isCustomerUpdated": { "type": "boolean" }, "isLineItemsUpdated": { "type": "boolean" }, "fullUrl": { "type": "string", "nullable": true }, "shortUrl": { "type": "string", "nullable": true }, "markedAsPaid": { "type": "boolean", "nullable": true }, "transactionId": { "type": "string", "format": "uuid", "nullable": true }, "achAllowFasterProcessing": { "type": "boolean", "nullable": true }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceHistoryDto" }, "nullable": true }, "zeroCostProcessingOptionId": { "type": "integer", "description": "ZCP Option Id\nAvailable when invoice is in Published or Paid status", "format": "int32", "nullable": true }, "zeroCostProcessingOption": { "type": "string", "description": "Specifies using the type of zero cost processing.\n\nZero cost processing has the customer covering the card fees and not the merchant.\n\nAvailable when invoice is in `Published` or `Paid` status\n\nPossible values:\n\n| Type | Id |\n|--------------|:--:|\n| None | 1 |\n| CashDiscount | 2 |\n| DualPricing | 3 |\n| Surcharge | 4 |\n\nExample: DualPricing\n", "example": "DualPricing", "nullable": true }, "useCardPrice": { "type": "boolean", "description": "Available for ZCP Option == Dual pricing only, when invoice is in Published or Paid status\ntrue - dual pricing, use card price\nfalse - dual pricing, use cash price\nnull - other ZCP option", "nullable": true }, "invoiceCalculations": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceCalculationsDto" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Update.UpdateIsvInvoiceRequest": { "type": "object", "properties": { "dueDate": { "$ref": "#/components/schemas/invoice_duedate" }, "cardPaymentProcessorId": { "$ref": "#/components/schemas/cardPaymentProcessorid" }, "achPaymentProcessorId": { "$ref": "#/components/schemas/ach_paymentrocessorid" }, "additionalNotes": { "type": "string", "nullable": true }, "shippingAmount": { "type": "number", "format": "double", "nullable": true }, "taxPercentage": { "type": "number", "format": "double", "nullable": true }, "feesPercentage": { "type": "number", "format": "double", "nullable": true }, "discountPercentage": { "type": "number", "format": "double", "nullable": true }, "merchantContactInfoId": { "type": "string", "format": "uuid", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "achAllowFasterProcessing": { "type": "boolean", "nullable": true }, "customer": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto" }, "nullable": true }, "canPriceBeForceOverrided": { "type": "boolean" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Submit.SubmitIsvInvoiceRequest": { "type": "object", "properties": { "totalAmount": { "type": "number", "format": "double", "description": "Specifies the transaction's total amount. \n\nThis includes the base amount, tips, taxes, discounts, and other charges.\n\nExample: 3219.45\n", "example": 3219.45 }, "accountNumber": { "type": "string", "nullable": true, "description": "Specifies the payment target's bank account number.\n\nExample: 5413591081013511\n", "example": "5413591081013511" }, "expirationYear": { "type": "integer", "format": "int32" }, "expirationMonth": { "type": "integer", "format": "int32" }, "securityCode": { "type": "string", "nullable": true }, "billingCountryId": { "type": "integer", "format": "int32", "description": "Specifies the Aurora country identifier.\n\nExample: 1\n", "example": 1 }, "billingPostalCode": { "type": "string", "nullable": true }, "savePaymentMethod": { "type": "boolean" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Submit.SubmitIsvInvoiceResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates the payment was successfully submitted.\n\nIf `true`, the payment was successfully submitted.
\nIf `false`, the payment was not successfully submitted..\n\nExample: true\n", "example": true }, "paymentMethodCreated": { "type": "boolean", "description": "Indicates the payment method was created.\n\nIf `true`, the payment method was created.
\nIf `false`, the payment method was not created.\n\nExample: true\n", "example": true }, "customerInfoSaved": { "type": "boolean", "description": "Indicates the customer info was saved.\n\nIf `true`, the customer info was saved.
\nIf `false`, the customer info was not saved.\n\nExample: true\n", "example": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Enums.AccountType": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|----------|\n| 1 | Checking |\n| 2 | Savings |\n\nExample: 1\n", "example": 1, "format": "int32" }, "PaymentIntegrations.Contracts.Enums.AccountHolderType": { "type": "integer", "description": "Possible values:\n\n| Value | Name |\n|-------|----------|\n| 1 | Business |\n| 2 | Personal |\n\nExample: 1\n", "example": 1, "format": "int32" }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SubmitAch.SubmitIsvAchInvoiceRequest": { "type": "object", "properties": { "routingNumber": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "description": null, "nullable": true }, "accountType": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.AccountType" }, "accountHolderType": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.AccountHolderType" }, "firstName": { "type": "string", "description": "Indicates the customer's first name.\n\nExample: Alexandro\n", "example": "Alexandro" }, "lastName": { "type": "string", "description": "Indicates the customer's last name.\n\nExample: Peppared\n", "example": "Peppared" }, "companyName": { "type": "string", "description": "Indicates the customer's company name.\n\nExample: Peppared Street Cafe\n", "nullable": true }, "email": { "type": "string", "description": "Indicates the customer's email.\n\nExample: peppared@example.com\n", "example": "peppared@example.com", "nullable": true }, "mobilePhoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "description": "Indicates the customer's mobile phone number.\n\nExample: +14155552309\n", "example": "+14155552309", "nullable": true }, "smsNotification": { "type": "boolean", "nullable": true, "default": false, "description": "Specifies the customer is sent an SMS notification.\n\nIf `true`, the customer is sent an SMS notification.
\nIf `false`, the customer is not sent an SMS notification.\n\nExample: true\n", "example": true }, "addressLine1": { "type": "string", "nullable": true, "description": "Indicates the street address.\n\nExample: 21 E. Main Street\n", "example": "21 E. Main Street" }, "addressLine2": { "type": "string", "nullable": true, "description": "Specifies additional street address information.\n\nExample: Office 3\n", "example": "Office 3" }, "city": { "type": "string", "description": "Specifies the name of the city.\n\nExample: Chicago\n", "example": "Chicago", "nullable": true }, "stateId": { "type": "integer", "format": "int32", "description": "Specifies the Aurora US state or territory identifier code.\n\nExample: 4\n", "example": 4 }, "billingPostalCode": { "type": "string", "nullable": true, "description": "Specifies the billing postal or ZIP code.\n\nExamples:
\n60612
\n60612-0001\n", "example": "60612" }, "savePaymentMethod": { "type": "boolean" }, "authorizeBankWithdrawal": { "type": "boolean" }, "authorizationConsentTimestamp": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when customer checked the authorization checkbox.\n\nThis is required for ACH compliance audit logging.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Calculations.GetIsvInvoiceCalculationsResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subTotalAmount": { "type": "number", "format": "double" }, "shippingAmount": { "type": "number", "format": "double" }, "taxPercentage": { "type": "number", "format": "double" }, "taxAmount": { "type": "number", "format": "double" }, "feesPercentage": { "type": "number", "format": "double" }, "feesAmount": { "type": "number", "format": "double" }, "discountPercentage": { "type": "number", "format": "double" }, "discountAmount": { "type": "number", "format": "double" }, "surchargeAmount": { "type": "number", "format": "double", "description": "Identifies the amount (in USD) when a surcharge is applicable.\n\nThis is a surcharge on the base amount.\nThis surcharge was calculated using the preset percentage from `surchargePercentage`.\n\nExample: 6.45\n", "example": 6.45 }, "surchargePercentage": { "type": "number", "format": "double", "nullable": true, "description": "Identifies the surcharge percentage.\n\nThis is a surcharge on the base amount.\nThis value is surcharge percentage rate.\nThis surcharge percentage calculates the surcharge amount for `surchargeAmount`.\n\nExample: 1.5 (as 1.5%)\n", "example": 1.5 }, "totalAmount": { "type": "number", "format": "double", "description": "Specifies the transaction's total amount. \n\nThis includes the base amount, tips, taxes, discounts, and other charges.\n\nExample: 3219.45\n", "example": 3219.45 } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Publish.PublishIsvInvoiceRequest": { "type": "object", "properties": { "dueDate": { "$ref": "#/components/schemas/invoice_duedate" }, "cardPaymentProcessorId": { "$ref": "#/components/schemas/cardPaymentProcessorid" }, "achPaymentProcessorId": { "$ref": "#/components/schemas/ach_paymentrocessorid" }, "additionalNotes": { "type": "string", "nullable": true }, "shippingAmount": { "type": "number", "format": "double", "nullable": true }, "taxPercentage": { "type": "number", "format": "double", "nullable": true }, "feesPercentage": { "type": "number", "format": "double", "nullable": true }, "discountPercentage": { "type": "number", "format": "double", "nullable": true }, "merchantContactInfoId": { "type": "string", "format": "uuid", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "achAllowFasterProcessing": { "type": "boolean", "nullable": true }, "customer": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto" }, "nullable": true }, "canPriceBeForceOverrided": { "type": "boolean" }, "id": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Publish.PublishIsvInvoiceResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Update.UpdateIsvInvoiceStatusRequest": { "type": "object", "properties": { "paymentMethodTypeId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SendInvoicePublishedSmsNotification.SendIsvInvoicePublishedSmsNotificationRequest": { "type": "object", "properties": { "phoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "nullable": true, "description": "Indicates the SMS phone number.\n\nExample: +14155552309\n", "example": "+14155552309" }, "customerConsent": { "type": "boolean", "description": "Identifies the customer has consented to receiving the SMS.\n\nIf `true`, the customer has consented to receiving the SMS.
\nIf `false`, the customer has not consented to receiving the SMS.\n\nExample: true\n", "example": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SendInvoiceEmailNotification.SendInvoiceEmailNotificationRequest": { "type": "object", "properties": { "receiverEmail": { "type": "string", "nullable": true }, "customerConsent": { "type": "boolean", "description": "Identifies the customer has consented to receiving the SMS.\n\nIf `true`, the customer has consented to receiving the SMS.
\nIf `false`, the customer has not consented to receiving the SMS.\n\nExample: true\n", "example": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.InvoiceSettings.Get.GetIsvInvoiceSettingsResponse": { "type": "object", "properties": { "merchantId": { "type": "string", "format": "uuid" }, "dueDateAfterDays": { "type": "integer", "format": "int32", "nullable": true }, "taxPercentage": { "type": "number", "format": "double", "nullable": true }, "isDiscountEnabled": { "type": "boolean" }, "discountPercentage": { "type": "number", "format": "double", "nullable": true }, "isShippingFeeEnabled": { "type": "boolean" }, "shippingFeeAmount": { "type": "number", "format": "double", "nullable": true }, "isFeesEnabled": { "type": "boolean" }, "feesPercentage": { "type": "number", "format": "double", "nullable": true }, "notes": { "type": "string", "nullable": true }, "paymentMethodTypeId": { "type": "integer", "format": "int32" }, "cardPaymentProcessorId": { "$ref": "#/components/schemas/cardPaymentProcessorid" }, "achPaymentProcessorId": { "$ref": "#/components/schemas/ach_paymentrocessorid" }, "allowStaffToSetDiscountAndLineItemDiscount": { "type": "boolean" }, "allowManuallyEnterLineItems": { "type": "boolean" }, "isSmsNotificationAfterPaymentEnabled": { "type": "boolean" }, "isSmsNotificationAfterPaymentFailedEnabled": { "type": "boolean" }, "canOverWriteInvoiceLineItemPrice": { "type": "boolean" }, "newZcpFeatureEnabled": { "type": "boolean" } }, "additionalProperties": false }, "AspNet.Swagger.Examples.ForbiddenExceptionExample": { "type": "object", "properties": { "details": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "source": { "type": "string", "nullable": true }, "exceptionType": { "type": "string", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.InvoiceSettings.Update.UpdateIsvInvoiceSettingsRequest": { "type": "object", "properties": { "dueDateAfterDays": { "type": "integer", "format": "int32", "nullable": true }, "taxPercentage": { "type": "number", "format": "double", "nullable": true }, "isDiscountEnabled": { "type": "boolean" }, "discountPercentage": { "type": "number", "format": "double", "nullable": true }, "isShippingFeeEnabled": { "type": "boolean" }, "shippingFeeAmount": { "type": "number", "format": "double", "nullable": true }, "isFeesEnabled": { "type": "boolean" }, "feesPercentage": { "type": "number", "format": "double", "nullable": true }, "notes": { "type": "string", "nullable": true }, "paymentMethodTypeId": { "type": "integer", "format": "int32", "nullable": true }, "cardPaymentProcessorId": { "$ref": "#/components/schemas/cardPaymentProcessorid" }, "achPaymentProcessorId": { "$ref": "#/components/schemas/ach_paymentrocessorid" }, "allowStaffToSetDiscountAndLineItemDiscount": { "type": "boolean" }, "allowManuallyEnterLineItems": { "type": "boolean" }, "isSmsNotificationAfterPaymentEnabled": { "type": "boolean" }, "isSmsNotificationAfterPaymentFailedEnabled": { "type": "boolean" }, "achAllowFasterProcessing": { "type": "boolean", "nullable": true }, "canOverWriteInvoiceLineItemPrice": { "type": "boolean" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.LineItems.Get.GetLineItemsResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "unitType": { "type": "string", "nullable": true }, "unitTypeId": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "unitPrice": { "type": "number", "format": "double" }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "categoryDefaultUnitTypeId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Get.GetIsvLineItemsPageResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.LineItems.Get.GetLineItemsResponseDto" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Create.CreateIsvLineItemRequest": { "type": "object", "properties": { "productName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "unitPrice": { "type": "number", "format": "double" }, "unitTypeId": { "type": "integer", "format": "int32" }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "taxRate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Create.CreateIsvLineItemResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Update.UpdateIsvLineItemRequest": { "type": "object", "properties": { "productName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "unitPrice": { "type": "number", "format": "double" }, "unitTypeId": { "type": "integer", "format": "int32" }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "taxRate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Get.GetIsvLineItemUnitTypesResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "abbreviation": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PaymentSessions.Create.CreatePaymentSessionRequestDto": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number", "format": "double", "description": "Specifies the base amount (in USD) to charge.\n\nFor payment sessions, this value must be greater than zero.
\nFor vault-only sessions, this value must be zero.\n\nExamples:
\n64.99
\n0\n", "example": 64.99 }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289de5" }, "mode": { "type": "integer", "format": "enum", "default": 1, "description": "Specifies the intent of the session.\n\n| Value | Name | Description |\n|:-----:|-----------------|-----------------------------------------------|\n| 1 | Payment | Standard payment session. Makes `skipAddressVerification` applicable. Default. |\n| 2 | SaveMethod | Vault-only session to store a payment method. |\n| 3 | PaymentAndSave | Charge the payment and save the method. Makes `skipAddressVerification` applicable. |\n\nExample: 2\n", "example": 2 }, "skipAddressVerification": { "type": "boolean", "default": false, "description": "Specifies to bypass the AVS (address verification service) in the payment gateway.\n\nThis value is applicable only to `Payment` and `PaymentAndSave` from `mode`.\n\nIf `true`, bypasses AVS in the payment gateway.
\nIf `false`, does not bypass AVS in the payment gateway.\n\nExample: true\n", "example": true }, "referenceId": { "type": "string", "description": "Specifies a reference identifier provided by the ISV.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifies are different.\n\nExample: 10001\n", "example": "10001" }, "tipAmount": { "type": "number", "format": "double", "nullable": true, "minimum": 0.01, "multipleOf": 0.01, "description": "Specifies the absolute amount (in USD) of tip to be added.\n\nIf this value is provided, it must be greater than zero.\n\nThis amount adds to the base amount of the original transaction.\nThat transaction must be authorized first (`POST /pay-api/v1/transactions/auth`).\n\nExample: 14.50\n", "example": 14.5 } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PaymentSessions.Create.CreatePaymentSessionResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Indicates the payment session identifier.\n\nThis value allows the customer to send the card information to complete the transaction.\n\nExample: 16143c97-07bc-448c-9807-924189311a66\n", "example": "16143c97-07bc-448c-9807-924189311a66" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Enums.PaymentSessionStatus": { "type": "integer", "format": "int32", "description": "Indicates the payment session status.\n\nPossible values:\n\n| Value | Status | Description |\n| :---: | -----------|-------------|\n| 1 | Created | Payment session was initialized but not yet processed. |\n| 2 | Cancelled | Payment session was cancelled before completion. |\n| 3 | Completed | Payment session was completed. Check transaction details to verify if the payment was approved or not. |\n| 4 | Failed | Payment was attempted but did not succeed. A new session must be created for a new payment attempt. |\n\nExample: 2\n", "example": 2 }, "PaymentGateway.Contracts.TransactionSourceResponseDto": { "type": "object", "properties": { "typeId": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionTransactionDetails.History": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Indicates the transaction identifier.\n\nExample: c7c15dd0-03e7-4e55-917c-54bedafba5e7\n", "example": "c7c15dd0-03e7-4e55-917c-54bedafba5e7" }, "transactionDateTime": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the invoice transaction.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "transactionAmount": { "type": "number", "format": "double", "nullable": true }, "transactionTypeId": { "type": "integer", "format": "int32" }, "transactionType": { "type": "string", "nullable": true }, "transactionStatusId": { "type": "integer", "format": "int32" }, "transactionStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionTransactionDetails": { "type": "object", "description": "Contains information about the processed transaction.", "properties": { "transactionReceiptUrl": { "type": "string", "description": "Indicates the direct link URL to the transaction receipt.", "nullable": true }, "transactionReceiptShortUrl": { "type": "string", "description": "Indicates the shortened URL to access the transaction receipt.", "nullable": true }, "source": { "$ref": "#/components/schemas/PaymentGateway.Contracts.TransactionSourceResponseDto" }, "transactionReceipt": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto" }, "id": { "type": "string", "format": "uuid", "description": "Indicates the transaction identifier.\n\nExample: 0e0034bd-028f-4809-b185-f4cca086eb33\n", "example": "0e0034bd-028f-4809-b185-f4cca086eb33" }, "paymentProcessorId": { "type": "string", "format": "uuid", "description": "Specifies the payment processor identifier.\n\nExample: 2059fcc1-5507-42be-8e4c-f4fcce245027\n", "example": "2059fcc1-5507-42be-8e4c-f4fcce245027" }, "date": { "type": "string", "format": "date-time", "nullable": true, "description": "Indicates the date of the transaction (in an ISO 8601 date-time UTC or time zone offset format).\n\nExamples:
\n2025-01-27T12:05:54.322587Z
\n2025-01-27T12:05:54.322587+05:30\n", "example": "2025-01-27T12:05:54.322587+05:30" }, "amount": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto" }, "currencyId": { "type": "integer", "format": "int32", "nullable": true, "description": "Indicates the currency identifier (in Aurora currency code).\n\nThis value is set to 1.\n\nExample: 1\n", "example": 1 }, "currencyCode": { "type": "string", "nullable": true, "description": "Indicates the currency (in ISO 4217 alpha-3 currency code format).\n\nExample: USD\n", "example": "USD" }, "createdBy": { "type": "string", "nullable": true, "description": "Indicates the creator of the transaction.\n" }, "merchant": { "type": "string", "nullable": true, "description": "Indicates the merchant creating the transaction.\n" }, "merchantId": { "type": "string", "format": "uuid", "description": "Indicates the merchant identifier of the transaction.\n\nExample: fae7620d-ab02-4375-bc20-6ff326b917fd\n", "example": "fae7620d-ab02-4375-bc20-6ff326b917fd" }, "processorId": { "type": "string", "format": "uuid", "description": "Indicates the processor identifier.\n\nExample: 5e9018ff-dbbb-4ff4-8cde-b10579a3fcd9\n", "example": "5e9018ff-dbbb-4ff4-8cde-b10579a3fcd9" }, "processor": { "type": "string", "nullable": true }, "operationMode": { "type": "string", "nullable": true, "description": "Indicates the operation mode.\n\nPossible values:\n\n| OperationMode | Id |\n|---------------|:--:|\n| PayNow | 1 |\n| Subscription | 2 |\n" }, "paymentMethodTypeId": { "type": "integer", "format": "int32", "description": "Indicates the processor identifier.\n" }, "paymentMethodType": { "type": "string", "nullable": true }, "paymentMethodName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "customerName": { "type": "string", "nullable": true }, "customerCompany": { "type": "string", "nullable": true, "description": "Indicates the customer name.\n\nExample:\n", "example": "Peppared Street Cafe" }, "customerPan": { "type": "string", "nullable": true }, "customerEmail": { "type": "string", "nullable": true, "description": "Indicates the customer's email.\n\nExample: peppared@example.com\n", "example": "peppared@example.com" }, "customerPhone": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "nullable": true, "description": "Indicates the customer's phone number.\n\nExample: +14155552309\n", "example": "+14155552309" }, "status": { "type": "string", "nullable": true, "description": "Indicates the session status.\n\nExample: Processing\n", "example": "Processing" }, "statusId": { "type": "integer", "format": "int32", "description": "Indicates the session status identifier.\n\nExample: 1\n", "example": 1 }, "responseCode": { "type": "string", "nullable": true, "description": "Indicates a response code regarding the transaction.\n\nExample: 000\n", "example": "000" }, "responseMessage": { "type": "string", "nullable": true, "description": "Indicates the message for the response code regarding the transaction.\n" }, "responseDescription": { "type": "string", "nullable": true, "description": "Indicates a free-formed description regarding the transaction.\n\nExample: Command Successful. Approved.\n", "example": "Command Successful. Approved." }, "avsResponseCode": { "type": "string", "nullable": true }, "availableStates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "refunded": { "type": "boolean", "description": "Indicates the transaction was refunded.\n\nIf `true`, transaction was refunded.
\nIf `false`, transaction was nit refunded.\n\nExample: true\n", "example": true }, "cardType": { "type": "string", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "type": { "type": "string", "nullable": true }, "creditDebitTypeId": { "type": "integer", "format": "int32", "nullable": true, "description": "Indicates the credit or debit type identifier.\n\nPossible values:\n\n| Int | Value |\n|:---:|---------|\n| 1 | Credit |\n| 2 | Debit |\n| 3 | Unknown |\n" }, "creditDebitTypeType": { "type": "string", "nullable": true, "description": "Indicates the credit or debit type.\n\nPossible values:\n\n| Value | Int |\n|---------|:---:|\n| Credit | 1 |\n| Debit | 2 |\n| Unknown | 3 |\n" }, "authCode": { "type": "string", "nullable": true }, "mid": { "type": "string", "nullable": true, "description": "Indicates the merchant identifier (MID) assigned to this transaction.\n" }, "tid": { "type": "string", "nullable": true, "description": "Indicates the terminal identifier (TID) assigned to this transaction.\n" }, "referenceId": { "type": "string", "nullable": true }, "availableOperations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Enums.TransactionOperation" }, "nullable": true }, "avsResponse": { "$ref": "#/components/schemas/PaymentGateway.Contracts.Transactions.AvsResponseDto" }, "histories": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionTransactionDetails.History" }, "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionIsvResponse": { "type": "object", "properties": { "statusId": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.PaymentSessionStatus" }, "status": { "type": "string", "description": "Indicates the payment session status.\n\nPossible values:\n\n| Status | Value | Description |\n|-----------|:-----:|-------------|\n| Created | 1 | Payment session was initialized but not yet processed. |\n| Cancelled | 2 | Payment session was cancelled before completion. |\n| Completed | 3 | Payment session was completed. Check transaction details to verify if the payment was approved or not. |\n| Failed | 4 | Payment was attempted but did not succeed. A new session must be created for a new payment attempt. |\n\nExample: 2\n", "example": 2, "nullable": true, "readOnly": true }, "customerId": { "type": "string", "format": "uuid", "description": "Indicates the customer identifier.\n\nThis was used when saving the payment method.
\nIf this value was provided, the payment method was saved to the specified customer.
\nIf this value was not provided, a new customer record was created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289de5" }, "mode": { "type": "integer", "format": "enum", "description": "Specifies the intent of the session.\n\nDefaults to Payment if omitted.\n\n| Value | Name | Description |\n|:-----:|-----------------|-----------------------------------------------|\n| 1 | Payment | Standard payment session. |\n| 2 | SaveMethod | Vault-only session to store a payment method. |\n| 3 | PaymentAndSave | Charge the payment and save the method. |\n\nExample: 2\n", "example": 2 }, "skipAddressVerification": { "type": "boolean", "default": false, "description": "Indicates to bypass the AVS (address verification service) in the payment gateway.\n\nThis value is applicable only to `Payment` and `PaymentAndSave` from `mode`.\n\nIf `true`, bypasses AVS in the payment gateway.
\nIf `false`, does not bypass AVS in the payment gateway.\n\nExample: true\n", "example": true }, "referenceId": { "type": "string", "nullable": true, "description": "Specifies an external transaction identifier for client-side tracking.\n\nAlso used in duplicate control validation.\nA unique value allows similar transactions to process as distinct, bypassing duplicate blocking when needed.\n\nExample: 10001\n", "example": "10001" }, "vaultedPaymentMethodId": { "type": "string", "format": "uuid", "nullable": true, "description": "Indicates the identifier of the vaulted payment method when the session involves saving or using a stored payment method.\n\nExample: 990a65f4-519c-44f9-a615-fc9c7781190c\n", "example": "990a65f4-519c-44f9-a615-fc9c7781190c" }, "transactionDetails": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionTransactionDetails" } }, "additionalProperties": false }, "PaymentIntegrations.WebApi.Isv.Controllers.PingController.PingResponse": { "type": "object", "description": "Indicates an object describing the response returned by the `GET /pay-int-api/ping` endpoint.\n", "properties": { "authenticated": { "type": "boolean", "description": "Indicates the request is authenticated.\n\nIf `true`, the request is authenticated.
\nIf `false`, the request is not authenticated.\n\nExample: true\n", "example": true }, "merchantId": { "type": "string", "format": "uuid", "nullable": true, "description": "Indicates the identifier of the merchant.\n\nIf a value is provided, the API key is valid and requests can be made.
\nIf a value is omitted or null, the API key is not valid.\nIt may mean that the API key is not associated with this merchant.\nCheck that the API key, clientId, and client secret are correct.\n\nExample: 46063d32-10fa-44cb-b118-20ddd085ce3f\n", "example": "46063d32-10fa-44cb-b118-20ddd085ce3f" }, "clientId": { "type": "string", "format": "uuid", "nullable": true, "description": "Indicates the first value association with the API key.\n\nThe second value association with the API key, the client secret, is never shown after the initial creation.\n\nExample: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5\n", "example": "3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.Enums.QuickPaymentStatus": { "type": "integer", "description": "Payment link status.\n\nPossible values:\n\n| Status ID | Status | Description |\n| :-------: |-----------|-------------|\n| 1 | Active | The link is active and can be used. |\n| 2 | Inactive | The link is inactive and cannot be used. |\n| 3 | Expired | The link is inactive by timing out. |\n| 4 | Completed | The link is inactive by having been used successfully. |\n", "format": "int32" }, "PaymentIntegrations.Contracts.QuickPayments.OneTime.GetPage.GetOneTimeQuickPaymentPageResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerName": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "status": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.QuickPaymentStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the one-time quick payment was created.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "expirationTime": { "type": "string", "format": "date-time", "nullable": true }, "transactionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.GetPage.GetIsvOneTimeQuickPaymentPageResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.QuickPayments.OneTime.GetPage.GetOneTimeQuickPaymentPageResponseDto" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Create.CreateIsvOneTimeQuickPaymentRequest": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "minimum": 0, "exclusiveMinimum": true, "description": "Specifies the amount (in USD) of the one-time payment.\n\nExample: 45.99\n", "example": 45.99 }, "referenceId": { "type": "string", "maximum": 100, "minimum": 0, "description": "Specifies the ReferenceId.\n\nExample: 10001\n", "example": "10001", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nExample: c9ae4972-b934-41aa-8e1a-1e5d8ad34bec\n", "example": "c9ae4972-b934-41aa-8e1a-1e5d8ad34bec" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Create.CreateIsvOneTimeQuickPaymentResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Indicates the payment reference link identifier, also known as the *quickPaymentId*.\n\nExample: c8c67f32-aca5-47c4-b10e-123086a43075\n", "example": "c8c67f32-aca5-47c4-b10e-123086a43075" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Get.GetIsvOneTimeQuickPaymentResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "referenceId": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.QuickPaymentStatus" }, "shortUrl": { "type": "string", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true, "description": "Specifies the customer identifier.\n\nThis is used when saving the payment method.
\nIf this value is provided, the payment method is saved to the specified customer.
\nIf this value is not provided, a new customer record is created.\n\nExample: fd9198a4-eb6f-4620-9603-4f4638289de5\n", "example": "fd9198a4-eb6f-4620-9603-4f4638289d" }, "customerName": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the quick payment was created.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.SmsNotification.SendIsvQuickPaymentSmsNotificationRequest": { "type": "object", "properties": { "phoneNumber": { "type": "string", "format": "E.164", "maxLength": 20, "pattern": "^(null|\\+\\d{1,20})$", "nullable": true, "description": "Indicates the SMS phone number.\n\nExample: +14155552309\n", "example": "+14155552309" }, "customerConsent": { "type": "boolean", "description": "Indicates the customer has consented to receiving the SMS.\n\nIf `true`, the customer has consented to receiving the SMS.
\nIf `false`, the customer has not consented to receiving the SMS.\n\nExample: true\n", "example": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.QuickPayments.Reusable.GetPage.GetReusableQuickPaymentPageResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "status": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.QuickPaymentStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the reusable quick payment was created.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" }, "totalTransactionsAmount": { "type": "number", "format": "double" }, "shortUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.GetPage.GetIsvReusableQuickPaymentPageResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.QuickPayments.Reusable.GetPage.GetReusableQuickPaymentPageResponseDto" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.Create.CreateIsvReusableQuickPaymentRequest": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "minimum": 0, "exclusiveMinimum": true, "description": "Specifies the amount (in USD) of the one-time payment.\n\nExample: 45.99\n", "example": 45.99 } }, "additionalProperties": false }, "PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.Get.GetIsvReusableQuickPaymentResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "status": { "$ref": "#/components/schemas/PaymentIntegrations.Contracts.Enums.QuickPaymentStatus" }, "shortUrl": { "type": "string", "nullable": true }, "totalTransactionsAmount": { "type": "number", "format": "double" }, "totalTransactionsCount": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "description": "Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the reusable quick payment was created.\n\nExamples:
\n2026-02-19T20:24:52.934Z
\n2026-02-19T20:24:52.934+05:30
\n2026-02-19T20:24:52.934-06:00\n", "example": "2026-02-19T20:24:52.934+05:30" } }, "additionalProperties": false } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample" }, "example": { "errors": { "Email": [ "'Email' is not a valid email address." ] }, "details": "Validation failed: -- Email: 'Email' is not a valid email address. Severity: Error\n", "statusCode": 400, "source": "", "exceptionType": "FluentValidation.ValidationException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fef", "entityId": null, "errorCode": null } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "No identifier found with 'b31fbe9f-eebb-45ce-9cae-92265389f471' with type=.DataAccess.Entities.Entity\n", "statusCode": 404, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee", "entityId": null, "errorCode": null } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample" }, "example": { "details": "No identifier found with 'b31fbe9f-eebb-45ce-9cae-92265389f47f', type='.DataAccess.Entities.Entity'\n", "statusCode": 500, "source": "", "exceptionType": "Exceptions.NotFoundException", "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fef", "entityId": null, "errorCode": null } } } } }, "parameters": { "transaction_id": { "name": "transactionId", "in": "path", "required": true, "description": "Specifies the ACH (automated clearing house) transaction identifier.\n\nThis value is returned as `transactionId` from either of the following endpoints:\n* `POST /pay-api/v1/transactions/ach/payment`\n* `GET /pay-api/v1/transactions/ach/payment/credit`\n\nExample: 004db5a8-a153-4334-a0b4-1aa22fbffb3e\n", "schema": { "type": "string", "format": "uuid", "example": "004db5a8-a153-4334-a0b4-1aa22fbffb3e" } }, "orderby": { "name": "orderBy", "in": "query", "description": "Specifies the field the results get ordered by.\n\nThe sort order is specified by the `asc` value.\n\nExample: contactName\n", "schema": { "type": "string" } }, "asc": { "name": "asc", "in": "query", "description": "Specifies the sort order is ascending.\n\nThe sort field is specified by the `orderBy` value.\n\nIf `true`, the sort order is ascending.
\nIf `false`, the sort order is descending.\n\nExample: true\n", "schema": { "type": "boolean", "default": true } }, "page": { "name": "page", "in": "query", "description": "Specifies the page number of the returned search results.\n\nA page is considered each set of the `pageSize` value.\n\nThe maximum page value is the `pageSize` divided by the `total` count rounded up.\nThe count is zero-based.\nFor example, if `pageSize` is 50 and the `total` is 130, there are three pages.\nThe maximum `page` value is 2.\n\nValues above the maximum page value will complete successfully but not return any items.\n\nExample: 0\n", "schema": { "type": "integer", "format": "int32", "default": 0 } }, "pagesize": { "name": "pageSize", "in": "query", "description": "Specifies the number of items for each page of the returned search results.\n\nA page is considered each set of the `pageSize` value.\n\nThe maximum page value is the `pageSize` divided by the `total` count rounded up.\nThe count is zero-based.\nFor example, if `pageSize` is 50 and the `total` is 130, there are three pages.\nThe maximum `page` value is 2.\n\nExample: 50\n", "schema": { "type": "integer", "format": "int32", "default": 15 } }, "quickpaymentid": { "name": "quickPaymentId", "in": "path", "description": "Specifies the payment link identifier.\n\nThis value is returned from either:\n* `POST /pay-int-api/quick-payments/one-time`\n* `POST /pay-int-api/quick-payments/reusable`\n", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0423617a-2004-4516-935d-e5ad4bbbe93e" } } } }, "x-tagGroups": [ { "name": "Aurora API Overview", "tags": [ "Getting Started", "API Suite Fundamentals" ] }, { "name": "Aurora API Reference", "tags": [ "ACH Transactions", "Categories", "Configurations", "Customers", "Devices", "Invoices", "Invoices Settings", "Line Items", "Merchant API Keys", "Payment Sessions", "Ping", "POS Transactions", "Quick Payments", "Settlement Batches", "Subscription", "Terminals", "Transactions", "Transaction Settings" ] } ] }