Download OpenAPI specification:Download
Last updated: 4.28.2026 4:19 PM
The following is an overview for using the Aurora API suite and making endpoint calls. Getting started has the following steps:
The appropriate sales team will create your user account and help customize access based on your integration requirements. You will be assigned an account name. This will be a registered account on the Aurora Merchant Portal Sandbox. Upon first login, you will create your account password.
If you are already a registered merchant and have technical or operational questions, contact the Aurora Integrations Support Team: isvsupport@risewithaurora.com
An API key is a pair of credentials, the client Id and the client secret, that together uniquely identifies and authenticates a specific account. The API key is important in that it is needed to create an API token. An API token is required to use each Aurora API endpoint.
Each merchant account requires at least one active and valid API key.
To create an API key, see Creating an API Key.
API keys may also be explicitly deleted as needed.
This deletion may be part of a periodic key rotation, as your security procedures require.
We recommended deleting an API key if you suspect that the client secret is compromised.
In either case, a new API key can be created.
To delete an API key, see Deleting an API Key.
You will work with your Aurora support team developing workflows and tools. This will be in the sandbox account for development and testing. The sandbox account is a fully isolated account that mirrors production behavior. It does not process real transactions. It is used to validate your integration before going live.
When your product is ready to be deployed live, the Aurora support team will work with you to ensure compliance. This compliance follows the production readiness checklist. It ensures the best and optimal developer, client, and customer experience.
For more information and details about the production readiness checklist, see Production Go-Live Guide.
The following sections are general information required for using the Aurora API suite.
Aurora provides different environments to run endpoints
Sandbox
The sandbox environment is for development and testing.
No payments, charges, or invoices will be enforced.
It is a fully isolated account that mirrors production behavior.
It is used to validate your integration before going live. You will work with your Aurora support team developing workflows and tools.
baseURL: https://api.uat.arise.risewithaurora.com
Production
Use the production environment for deploying the payment system live to clients.
All payments, charges, or invoices will be enforced.
When your product is ready to be deployed live, the Aurora support team will work with you to ensure compliance. This compliance follows the production readiness checklist. It ensures the best and optimal developer, client, and customer experience.
For more information and details about the production readiness checklist, see Production Go-Live Guide.
baseURL: https://api.arise.risewithaurora.com
Using the baseURL
Use the baseURL instead of the placeholder noted in each endpoint.
For example, an endpoint may be described as in the endpoint documentation as:
POST {{baseURL}}/pay-api/v1/customers
To make this call in the sandbox environment, use:
POST https://api.uat.arise.risewithaurora.com/pay-api/v1/customers
To make this call in the production environment, use:
POST https://api.arise.risewithaurora.com/pay-api/v1/customers
The API token is an authorization token needed for each for endpoint. It is an encrypted string that combines the client Id and client secret from an API key (created earlier). It contains authentication and authorization coding. This includes any privileges the user or account affords. Being encrypted means the API token is safe to expose in frontend code. The API token is time-sensitive and expires after an amount of time.
It may be created as needed. We recommend generating a new API token before each endpoint use. This ensures the API token will be valid for each call.
The API token is an OAuth 2.0 Client Credentials authorization flow. The Client Credentials Flow is an OAuth 2.0 authorization Bearer grant. This means a server-side application obtains an access token using its client credentials (client ID and client secret) to protect resources.
Production
Use the production environment for deploying the payment system live to clients.
All payments, charges, or invoices will be enforced.
Endpoint: POST https://oauth.arise.risewithaurora.com/oauth2/token
Sandbox
Use the sandbox environment for development and testing.
No payments, charges, or invoices will be enforced.
Endpoint: POST https://oauth.uat.arise.risewithaurora.com/oauth2/token
The sandbox and production environments API tokens use the same API key and differentiated only by the environment endpoint. The two API tokens types are not interchangeable and cannot be used in an environment different than they were created for.
The API key that was created in the initial account registration is needed to create an API token. The client ID and client secret are used together to create an API token.
In the POST request, include the following as the request body:
| Parameter Name | Example | Notes |
|---|---|---|
| grant_type | client_credentials |
It must be this literal value. |
| scope | offline_access |
It must be this literal value. |
| client_id | 594838709594...38697242c | The client ID from the API key for the account. |
| client_secret | 9eb2c6859daa4...d8ae5da02a9 | The client secret from the API key for the account. |
The following is an example of the complete request for the sandbox environment:
curl -X POST 'https://oauth.uat.arise.risewithaurora.com/oauth2/token' \
-u '594838709594...38697242c:9eb2c6859daa4...d8ae5da9' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials&scope=offline_access'
The following example is passed back in the response body:
{
"access_token": "u7BYwJx26U1lT...TZpKvndLCC4",
"refresh_token": "def50200newrefresh123456789",
"token_type": "Bearer",
"expires_in": 3600
}
The response body:
| Field Name | Description |
|---|---|
| access_token | The JWT (JSON web token) access token to include as the API request Authorization header field of each endpoint. |
| refresh_token | The JWT (JSON web token) refresh access token. |
| token_type | Always Bearer. |
| expires_in | The access_token's lifetime in seconds.For example, 900 (seconds) is 15 minutes. |
The token endpoint returns both an access_token and a refresh_token.
The lifespan of the access_token is indicated by the expires_in value.
The lifespan of the refresh_token is set by OAuth standards.
Clients are encouraged to use either token as needed.
For example, it may be easier to call for a new access_token before each user-initiated action.
The access_token may also be left to expire, and then use refresh_token procedures to continue.
Alternatively, mobile phones apps may need to use the refresh_token to avoid consistently signing back in.
In the endpoint header, use the following access_token format:
"Authorization": "Bearer: u7BYwJx26U1lT...TZpKvndLCC4"
The following example creates a new access token:
curl 'https://api.uat.arise.risewithaurora.com/pay-api/v1/transactions' \
-H 'Authorization: Bearer u7BYwJx26U1lT...TZpKvndLCC44' \
-H 'Accept: application/json'
As a reminder, always secure your client ID and especially your client secret. Never expose the client secret in client-side code or public repositories. It should be kept private and secure. If it is suspected that the client secret has been compromised, the owning API key must be deleted. A new API key can then be created
If authentication fails, the token endpoint returns an error. The following are commonly encountered errors.
| HTTP Status | Common Cause |
|---|---|
| 400 Bad Request | Missing or invalid grant_type, or malformed request body. |
| 401 Unauthorized | The API token has likely expired. Create a new one and retry the request. |
| id | name |
|---|---|
| 1 | Business |
| 2 | Personal |
| id | name |
|---|---|
| 1 | Checking |
| 2 | Savings |
| id | name |
|---|---|
| 1 | Active |
| 2 | Suspended |
| id | name |
|---|---|
| 1 | SingleAffiliateModel |
| 2 | SubAffiliateModel |
| id | name |
|---|---|
| 1 | WebDeveloper |
| 2 | IndependentSoftwareVendor |
| 3 | IndependentSalesOrganization |
| id | isoCode | name |
|---|---|---|
| 1 | US | United States |
| 2 | CA | Canada |
| 3 | PR | Puerto Rico |
| 4 | AF | Afghanistan |
| 5 | AX | Åland Islands |
| 6 | AL | Albania |
| 7 | DZ | Algeria |
| 8 | AS | American Samoa |
| 9 | AD | Andorra |
| 10 | AO | Angola |
| 11 | AI | Anguilla |
| 12 | AQ | Antarctica |
| 13 | AG | Antigua and Barbuda |
| 14 | AR | Argentina |
| 15 | AM | Armenia |
| 16 | AW | Aruba |
| 17 | AU | Australia |
| 18 | AT | Austria |
| 19 | AZ | Azerbaijan |
| 20 | BS | Bahamas |
| 21 | BH | Bahrain |
| 22 | BD | Bangladesh |
| 23 | BB | Barbados |
| 24 | BY | Belarus |
| 25 | BE | Belgium |
| 26 | BZ | Belize |
| 27 | BJ | Benin |
| 28 | BM | Bermuda |
| 29 | BT | Bhutan |
| 30 | BO | Bolivia (Plurinational State of) |
| 31 | BQ | Bonaire, Sint Eustatius and Saba |
| 32 | BA | Bosnia and Herzegovina |
| 33 | BW | Botswana |
| 34 | BV | Bouvet Island |
| 35 | BR | Brazil |
| 36 | IO | British Indian Ocean Territory |
| 37 | UM | United States Minor Outlying Islands |
| 38 | VG | Virgin Islands (British) |
| 39 | VI | Virgin Islands (U.S.) |
| 40 | BN | Brunei Darussalam |
| 41 | BG | Bulgaria |
| 42 | BF | Burkina Faso |
| 43 | BI | Burundi |
| 44 | KH | Cambodia |
| 45 | CM | Cameroon |
| 46 | CV | Cabo Verde |
| 47 | KY | Cayman Islands |
| 48 | CF | Central African Republic |
| 49 | TD | Chad |
| 50 | CL | Chile |
| 51 | CN | China |
| 52 | CX | Christmas Island |
| 53 | CC | Cocos (Keeling) Islands |
| 54 | CO | Colombia |
| 55 | KM | Comoros |
| 56 | CG | Congo |
| 57 | CD | Congo (Democratic Republic of the) |
| 58 | CK | Cook Islands |
| 59 | CR | Costa Rica |
| 60 | HR | Croatia |
| 61 | CU | Cuba |
| 62 | CW | Curaçao |
| 63 | CY | Cyprus |
| 64 | CZ | Czech Republic |
| 65 | DK | Denmark |
| 66 | DJ | Djibouti |
| 67 | DM | Dominica |
| 68 | DO | Dominican Republic |
| 69 | EC | Ecuador |
| 70 | EG | Egypt |
| 71 | SV | El Salvador |
| 72 | GQ | Equatorial Guinea |
| 73 | ER | Eritrea |
| 74 | EE | Estonia |
| 75 | ET | Ethiopia |
| 76 | FK | Falkland Islands (Malvinas) |
| 77 | FO | Faroe Islands |
| 78 | FJ | Fiji |
| 79 | FI | Finland |
| 80 | FR | France |
| 81 | GF | French Guiana |
| 82 | PF | French Polynesia |
| 83 | TF | French Southern Territories |
| 84 | GA | Gabon |
| 85 | GM | Gambia |
| 86 | GE | Georgia |
| 87 | DE | Germany |
| 88 | GH | Ghana |
| 89 | GI | Gibraltar |
| 90 | GR | Greece |
| 91 | GL | Greenland |
| 92 | GD | Grenada |
| 93 | GP | Guadeloupe |
| 94 | GU | Guam |
| 95 | GT | Guatemala |
| 96 | GG | Guernsey |
| 97 | GN | Guinea |
| 98 | GW | Guinea-Bissau |
| 99 | GY | Guyana |
| 100 | HT | Haiti |
| 101 | HM | Heard Island and McDonald Islands |
| 102 | VA | Holy See |
| 103 | HN | Honduras |
| 104 | HK | Hong Kong |
| 105 | HU | Hungary |
| 106 | IS | Iceland |
| 107 | IN | India |
| 108 | ID | Indonesia |
| 109 | CI | Côte d'Ivoire |
| 110 | IR | Iran (Islamic Republic of) |
| 111 | IQ | Iraq |
| 112 | IE | Ireland |
| 113 | IM | Isle of Man |
| 114 | IL | Israel |
| 115 | IT | Italy |
| 116 | JM | Jamaica |
| 117 | JP | Japan |
| 118 | JE | Jersey |
| 119 | JO | Jordan |
| 120 | KZ | Kazakhstan |
| 121 | KE | Kenya |
| 122 | KI | Kiribati |
| 123 | KW | Kuwait |
| 124 | KG | Kyrgyzstan |
| 125 | LA | Lao People's Democratic Republic |
| 126 | LV | Latvia |
| 127 | LB | Lebanon |
| 128 | LS | Lesotho |
| 129 | LR | Liberia |
| 130 | LY | Libya |
| 131 | LI | Liechtenstein |
| 132 | LT | Lithuania |
| 133 | LU | Luxembourg |
| 134 | MO | Macao |
| 135 | MK | Macedonia (the former Yugoslav Republic of) |
| 136 | MG | Madagascar |
| 137 | MW | Malawi |
| 138 | MY | Malaysia |
| 139 | MV | Maldives |
| 140 | ML | Mali |
| 141 | MT | Malta |
| 142 | MH | Marshall Islands |
| 143 | MQ | Martinique |
| 144 | MR | Mauritania |
| 145 | MU | Mauritius |
| 146 | YT | Mayotte |
| 147 | MX | Mexico |
| 148 | FM | Micronesia (Federated States of) |
| 149 | MD | Moldova (Republic of) |
| 150 | MC | Monaco |
| 151 | MN | Mongolia |
| 152 | ME | Montenegro |
| 153 | MS | Montserrat |
| 154 | MA | Morocco |
| 155 | MZ | Mozambique |
| 156 | MM | Myanmar |
| 157 | NA | Namibia |
| 158 | NR | Nauru |
| 159 | NP | Nepal |
| 160 | NL | Netherlands |
| 161 | NC | New Caledonia |
| 162 | NZ | New Zealand |
| 163 | NI | Nicaragua |
| 164 | NE | Niger |
| 165 | NG | Nigeria |
| 166 | NU | Niue |
| 167 | NF | Norfolk Island |
| 168 | KP | Korea (Democratic People's Republic of) |
| 169 | MP | Northern Mariana Islands |
| 170 | NO | Norway |
| 171 | OM | Oman |
| 172 | PK | Pakistan |
| 173 | PW | Palau |
| 174 | PS | Palestine, State of |
| 175 | PA | Panama |
| 176 | PG | Papua New Guinea |
| 177 | PY | Paraguay |
| 178 | PE | Peru |
| 179 | PH | Philippines |
| 180 | PN | Pitcairn |
| 181 | PL | Poland |
| 182 | PT | Portugal |
| 183 | QA | Qatar |
| 184 | XK | Republic of Kosovo |
| 185 | RE | Réunion |
| 186 | RO | Romania |
| 187 | RU | Russian Federation |
| 188 | RW | Rwanda |
| 189 | BL | Saint Barthélemy |
| 190 | SH | Saint Helena, Ascension and Tristan da Cunha |
| 191 | KN | Saint Kitts and Nevis |
| 192 | LC | Saint Lucia |
| 193 | MF | Saint Martin (French part) |
| 194 | PM | Saint Pierre and Miquelon |
| 195 | VC | Saint Vincent and the Grenadines |
| 196 | WS | Samoa |
| 197 | SM | San Marino |
| 198 | ST | Sao Tome and Principe |
| 199 | SA | Saudi Arabia |
| 200 | SN | Senegal |
| 201 | RS | Serbia |
| 202 | SC | Seychelles |
| 203 | SL | Sierra Leone |
| 204 | SG | Singapore |
| 205 | SX | Sint Maarten (Dutch part) |
| 206 | SK | Slovakia |
| 207 | SI | Slovenia |
| 208 | SB | Solomon Islands |
| 209 | SO | Somalia |
| 210 | ZA | South Africa |
| 211 | GS | South Georgia and the South Sandwich Islands |
| 212 | KR | Korea (Republic of) |
| 213 | SS | South Sudan |
| 214 | ES | Spain |
| 215 | LK | Sri Lanka |
| 216 | SD | Sudan |
| 217 | SR | Suriname |
| 218 | SJ | Svalbard and Jan Mayen |
| 219 | SZ | Swaziland |
| 220 | SE | Sweden |
| 221 | CH | Switzerland |
| 222 | SY | Syrian Arab Republic |
| 223 | TW | Taiwan |
| 224 | TJ | Tajikistan |
| 225 | TZ | Tanzania, United Republic of |
| 226 | TH | Thailand |
| 227 | TL | Timor-Leste |
| 228 | TG | Togo |
| 229 | TK | Tokelau |
| 230 | TO | Tonga |
| 231 | TT | Trinidad and Tobago |
| 232 | TN | Tunisia |
| 233 | TR | Turkey |
| 234 | TM | Turkmenistan |
| 235 | TC | Turks and Caicos Islands |
| 236 | TV | Tuvalu |
| 237 | UG | Uganda |
| 238 | UA | Ukraine |
| 239 | AE | United Arab Emirates |
| 240 | GB | United Kingdom of Great Britain and Northern Ireland |
| 241 | UY | Uruguay |
| 242 | UZ | Uzbekistan |
| 243 | VU | Vanuatu |
| 244 | VE | Venezuela (Bolivarian Republic of) |
| 245 | VN | Viet Nam |
| 246 | WF | Wallis and Futuna |
| 247 | EH | Western Sahara |
| 248 | YE | Yemen |
| 249 | ZM | Zambia |
| 250 | ZW | Zimbabwe |
| id | name |
|---|---|
| 1 | Portal |
| 2 | ApiToken |
| 3 | Terminal |
| 4 | Invoice |
| 5 | QuickPayment |
| 6 | WebComponent |
| 7 | Subscription |
| 8 | MobileApp |
| 9 | TapToPay |
| id | code | description |
|---|---|---|
| 1 | 5561 | Camper, Recreational and Utility Trailer Dealers |
| 2 | 3658 | New Otani Hotels |
| 3 | 3669 | Eldorado Hotel and Casino |
| 4 | 3663 | Hoteles El Presidente |
| 5 | 3660 | Knights Inn |
| 6 | 3670 | Arcade Hotels |
| 7 | 3667 | Luxor Hotel and Casino |
| 8 | 3655 | Scandic Hotels |
| 9 | 3657 | Oberoi Hotels |
| 10 | 3662 | Circus Circus Hotel and Casino |
| 11 | 3654 | Loews Hotels |
| 12 | 3652 | Embassy Hotels |
| 13 | 3664 | Flag Inns |
| 14 | 3661 | Metropole Hotels |
| 15 | 3651 | Imperial London Hotel |
| 16 | 3653 | Penta Hotels |
| 17 | 3666 | Stakis Hotels |
| 18 | 3668 | Maritim Hotels |
| 19 | 3665 | Hampton Inn Hotels |
| 20 | 3656 | Sara Hotels |
| 21 | 3659 | Taj Hotels International |
| 22 | 8050 | Nursing and Personal Care Facilities |
| 23 | 8031 | Osteopathic Physicians |
| 24 | 8099 | Medical Services Health Practitioners - No Elsewhere Classified |
| 25 | 8220 | Colleges, Universities, Professional Schools, and Junior Colleges |
| 26 | 7999 | Recreation Services - Not Elsewhere Classified |
| 27 | 8211 | Elementary and Secondary Schools |
| 28 | 8062 | Hospitals |
| 29 | 8041 | Chiropractors |
| 30 | 8241 | Correspondence Schools |
| 31 | 8049 | Podiatrists and Chiropodists |
| 32 | 8021 | Dentists and Orthodontists |
| 33 | 8011 | Doctors and Physicians - Not Elsewhere Classified |
| 34 | 8043 | Opticians, Optical Goods and Eyeglasses |
| 35 | 8071 | Medical and Dental Laboratories |
| 36 | 7998 | Aquarium, Seaquarium, Dolphinariums |
| 37 | 7997 | Membership Clubs (Sports, Recreation, Athletic), Country Clubs, and Private Golf Courses |
| 38 | 8042 | Optometrists and Ophthalmologists |
| 39 | 8111 | Legal Services and Attorneys |
| 40 | 3161 | All Nippon Airways |
| 41 | 3164 | Norontair |
| 42 | 3171 | Canadian Airlines |
| 43 | 3172 | Nation Air |
| 44 | 3159 | PBA-Provincetwn-Bstn Air |
| 45 | 3175 | Middle East Air |
| 46 | 3174 | JetBlue Airways |
| 47 | 3167 | Aero Continente - AEROCONTINENTE |
| 48 | 3432 | Reserve Rent-a-Car |
| 49 | 5099 | Durable Goods Not Elsewhere Classified (Business to Business MCC) |
| 50 | 5085 | Industrial Supplies Not Elsewhere Classified (Business to Business MCC) |
| 51 | 5139 | Commercial Footwear (Business to Business MCC) |
| 52 | 5137 | Men's, Women's and Children's Uniforms (Business to Business MCC) |
| 53 | 5193 | Florist Suppliers, Nursery Stock & Flowers (Business to Business MCC) |
| 54 | 5122 | Drugs, Drug Proprietary's, and Druggists' Sundries |
| 55 | 5051 | Metal Service Centers and Offices (Business to Business MCC) |
| 56 | 5211 | Lumber & Building Materials Stores |
| 57 | 5200 | Home Supply Warehouse |
| 58 | 5111 | Stationery, Office Supplies, and Printing and Writing Paper |
| 59 | 5172 | Petroleum and Products (Business to Business MCC) |
| 60 | 5131 | Piece Goods, Notions and Other Dry Goods (Business to Business MCC) |
| 61 | 5192 | Books, Periodicals and Newspapers (Business to Business MCC) |
| 62 | 5271 | Mobile Home Dealer |
| 63 | 5169 | Chemicals and Allied Products Not Elsewhere Classified (Business to Business MCC) |
| 64 | 5065 | Electrical Parts and Equipment (Business to Business MCC) |
| 65 | 5074 | Plumbing and Heating Equipment and Supplies (Business to Business MCC) |
| 66 | 5261 | Nurseries and Lawn and Garden Supply Stores |
| 67 | 5251 | Hardware Stores, Equipment Utilities Regulated |
| 68 | 5094 | Precious Stones, Metals, Watches and Jewelry (Business to Business MCC) |
| 69 | 5072 | Hardware, Plumbing, Heat Equipment and Supplies (Business to Business MCC) |
| 70 | 5198 | Paints, Varnishes and Supplies (Business to Business MCC) |
| 71 | 5199 | Non-durable Goods Not Elsewhere Classified (Business to Business MCC) |
| 72 | 5231 | Glass, Paint, and Wallpaper Stores |
| 73 | 3640 | Hyatt Motels |
| 74 | 3632 | The Phoenician |
| 75 | 3638 | Howard Johnson |
| 76 | 3641 | Sofitel Hotels |
| 77 | 3650 | Red Roof Inns |
| 78 | 3629 | Dan Hotels |
| 79 | 3649 | Radisson |
| 80 | 3645 | Queens Moat Houses |
| 81 | 3639 | Mount Charlotte Thistle |
| 82 | 3634 | Swissotel |
| 83 | 3643 | Steigenberger Hotels |
| 84 | 3644 | EconoLodges |
| 85 | 3636 | Sarova Hotels |
| 86 | 3637 | Ramada Inns |
| 87 | 3630 | Extended Stay Deluxe |
| 88 | 3646 | Swallow Hotels |
| 89 | 3628 | Excalibur Hotel and Casino |
| 90 | 3627 | Extended Stay America |
| 91 | 3635 | Reso Hotel |
| 92 | 3647 | Husa Hotels |
| 93 | 3633 | Rank Hotels |
| 94 | 3648 | De Vere Hotels |
| 95 | 3631 | Sleep Inn |
| 96 | 3642 | Novotel |
| 97 | 3626 | Studio Plus |
| 98 | 7991 | Tourist Attractions and Exhibits |
| 99 | 7933 | Bowling Alleys |
| 100 | 7993 | Video Amusement Game Supply |
| 101 | 7941 | Commercial Sports, Professional Sports Clubs, Athletic Fields, and Sports Promoters |
| 102 | 7994 | Video Game Arcades and Establishments |
| 103 | 7992 | Public Golf Courses |
| 104 | 7995 | Betting, including Lottery Tickets, Casino Gaming Chips, Off- Track Betting, and Wagers at Race Track |
| 105 | 7996 | Amusement Parks, Circuses, Carnivals, and Fortune Tellers |
| 106 | 3151 | Air Laire |
| 107 | 3130 | Sunworld International Airways |
| 108 | 3148 | Air Littoral SA |
| 109 | 3146 | Luxair |
| 110 | 3112 | Windward Island |
| 111 | 3156 | Go Fly |
| 112 | 3144 | Virgin Atlantic |
| 113 | 3129 | Surinam Airways |
| 114 | 3125 | Tan Airlines |
| 115 | 3132 | Frontier Airlines |
| 116 | 3141 | Seair Alaska |
| 117 | 3106 | Braathens S.A.F.E. (Norway) |
| 118 | 3117 | Venezolana Int de Aviacion |
| 119 | 3135 | Sudan Airlines |
| 120 | 3131 | VLM Air |
| 121 | 3136 | Qatar Air |
| 122 | 3111 | British Midland |
| 123 | 3127 | Taca International |
| 124 | 4723 | Package Tour Operators (Germany Only) |
| 125 | 4815 | Monthly Summary Telephone Charges |
| 126 | 4829 | Quasi Cash - Money Transfer |
| 127 | 4582 | Airports, Flying Fields, and Airport Terminals |
| 128 | 4899 | Cable, Satellite, and Other Pay Television and Radio Services |
| 129 | 4457 | Boat Rentals and Leasing |
| 130 | 4511 | Airlines and Air Carriers |
| 131 | 4761 | Telemarketing of Travel Related Services and Vitamins |
| 132 | 4813 | Special Telecom Merchant |
| 133 | 5044 | Photographic, Photocopy, Microfilm Equipment and Supplies (Business to Business MCC) |
| 134 | 4468 | Marinas, Marine Service, and Supplies |
| 135 | 4789 | Transportation Services-not elsewhere classified |
| 136 | 5013 | Motor Vehicle Supplies and New Parts (Business to Business MCC) |
| 137 | 5047 | Dental/Laboratory/Medical/Ophthalmic Hospital Equipment and Supplies |
| 138 | 5046 | Commercial Equipment Not Elsewhere Classified (Business to Business MCC) |
| 139 | 5021 | Office Furniture (Business to Business MCC) |
| 140 | 5039 | Construction Materials Not Elsewhere Classified (Business to Business MCC) |
| 141 | 4812 | Telecommunication Equipment and Telephone Sales |
| 142 | 5045 | Computers, Computer Peripheral Equipment, and Software |
| 143 | 4784 | Bridge and Road Fees, Tolls |
| 144 | 4900 | Utilities-Electric, Gas, Water, and Sanitary |
| 145 | 4722 | Travel Agencies |
| 146 | 4814 | Telecommunication Services, Including Local and Long Distance Calls, Credit Card Calls, Call Through Use of Magnetic-Strip-Reading Telephones, and Fax Services |
| 147 | 4821 | Telegraph Services |
| 148 | 4816 | Computer Network/Information Services and other Online Services such as electronic bulletin board, e-mail, web site hosting services, or Internet access |
| 149 | 3618 | Great Wolf |
| 150 | 3609 | Gaylord Palms |
| 151 | 3612 | Movenpick Hotels |
| 152 | 3611 | C MON INN |
| 153 | 3624 | Lady Luck Hotel and Casino |
| 154 | 3608 | Gaylord Opryland |
| 155 | 3615 | Travelodge Motels |
| 156 | 3623 | Dorint Hotels |
| 157 | 3610 | Gaylord Texan |
| 158 | 3620 | Binion's Horseshoe Club |
| 159 | 3617 | America's Best Value Inn |
| 160 | 3621 | Extended Stay |
| 161 | 3622 | Merlin Hotel |
| 162 | 3625 | Hotel Universale |
| 163 | 3619 | Aloft |
| 164 | 3607 | Fountainebleau Resort |
| 165 | 3613 | Microtel Inns & Suites |
| 166 | 3614 | Americinn |
| 167 | 3087 | Metro Airlines |
| 168 | 3084 | Eva Airlines |
| 169 | 3099 | Cathay Pacific |
| 170 | 3102 | Iberia |
| 171 | 3103 | Garuda (Indonesia) |
| 172 | 3094 | Zambia Airways |
| 173 | 3090 | Uni Airways |
| 174 | 3085 | Midwest Express Airlines, Inc |
| 175 | 3089 | Tans Saero |
| 176 | 3105 | Piedmont |
| 177 | 3098 | Asiana Airlines |
| 178 | 3096 | Air Zimbabwe |
| 179 | 3097 | Spanair (abbreviation: SPANAIR) |
| 180 | 3100 | Malaysian Airline Sys |
| 181 | 7629 | Electrical and Small Appliance Repair Shops |
| 182 | 7692 | Welding Services |
| 183 | 7549 | Towing Services |
| 184 | 7922 | Theatrical Producers (except Motion Pictures) and Ticket Agencies |
| 185 | 7778 | Citishare Cash Advance |
| 186 | 7542 | Car Washes |
| 187 | 7801 | Government-Licensed Casinos (Online Gambling) |
| 188 | 7829 | Motion Picture & Video Tape Production and Distribution (Business to Business MCC) |
| 189 | 7623 | Air Conditioning and Refrigeration Repair Shops |
| 190 | 7800 | Government-Owned Lotteries |
| 191 | 7932 | Billiards & Pool Establishments |
| 192 | 7841 | DVD/Video Tape Rental Stores |
| 193 | 7929 | Bands, Orchestras & Misc Entertainment |
| 194 | 7911 | Dance Halls, Studios & Schools |
| 195 | 7832 | Motion Picture Theater |
| 196 | 7641 | Furniture - Reupholster, Repair, and Refinishing |
| 197 | 7802 | Government-Licensed Horse/Dog Racing |
| 198 | 7622 | Electronic Repair Shops |
| 199 | 7631 | Watch, Clock, and Jewelry Repair Shops |
| 200 | 7699 | Miscellaneous Repair Shops and Related Services |
| 201 | 4215 | Courier Services-Air and Ground, and Freight Forwarders |
| 202 | 3825 | Vdara |
| 203 | 4011 | Railroads |
| 204 | 3829 | Country Inn by Carlson |
| 205 | 3821 | Caribe Royale |
| 206 | 4121 | Taxicabs and Limousines |
| 207 | 3828 | Cosmopolitan of Las Vegas |
| 208 | 4112 | Passenger Rail (train) |
| 209 | 4111 | Local and Suburban Commuter Passenger Transportation, including Ferries |
| 210 | 3820 | Jumeirah Essex House |
| 211 | 4411 | Steamship and Cruise Lines |
| 212 | 4119 | Ambulance Services |
| 213 | 3827 | Galt House |
| 214 | 3822 | Crossland |
| 215 | 3823 | Grand Sierra Resort |
| 216 | 3826 | Autograph |
| 217 | 3824 | Aria |
| 218 | 3830 | Park Plaza Hotel |
| 219 | 4131 | Bus Lines, includes Charters/Tour Buses |
| 220 | 4225 | Public Warehousing-Farm products, Refrigerated Goods, Household Goods, and Storage |
| 221 | 4214 | Motor Freight Carriers and Trucking-Local and Long Distance, Moving & Storage Companies, and Local Delivery |
| 222 | 3819 | Oxford Suites |
| 223 | 3831 | Waldorf |
| 224 | 7230 | Salon, Barber, Beauty, and Nail Salon |
| 225 | 3606 | Jefferson Hotel |
| 226 | 3601 | Trade Winds Resorts |
| 227 | 3595 | Hospitality Inns |
| 228 | 3599 | Pannonia Hotels |
| 229 | 3597 | Riverside Resort and Casino |
| 230 | 3596 | Wynn Las Vegas |
| 231 | 3593 | Cunard Hotels |
| 232 | 3604 | Hilton Garden Inn |
| 233 | 3594 | Arizona Biltmore |
| 234 | 3602 | Hudson Hotel |
| 235 | 3603 | Noah's Hotel |
| 236 | 3600 | Saddlebrook Resort - Tampa |
| 237 | 3598 | Regent International Hotels |
| 238 | 3605 | Jurys Doyle Hotel Group |
| 239 | 3083 | Air Afrique |
| 240 | 3078 | China Airlines |
| 241 | 3077 | Thai Airways |
| 242 | 3073 | Air Cal |
| 243 | 3076 | Aeromexico |
| 244 | 3075 | Singapore Airlines |
| 245 | 3070 | Pacific Southwest Airlines (PSA) |
| 246 | 3069 | Sun Country Air |
| 247 | 3072 | CEBU PAC |
| 248 | 3082 | Korean Airlines |
| 249 | 3071 | Air British Columbia |
| 250 | 3079 | Jetstar Airways - Jetstar |
| 251 | 7375 | Information Retrieval Services (Business to Business MCC) |
| 252 | 7524 | Express Payment Service Mechants - Parking Lots and Garages |
| 253 | 7361 | Employment Agencies and Temporary Help Services |
| 254 | 7531 | Automotive Top & Body Shops |
| 255 | 7392 | Management, Consulting, and Public Relations Services |
| 256 | 7535 | Automotive Paint Shops |
| 257 | 7395 | Photofinishing Laboratories and Photo Developing |
| 258 | 7519 | Motor Home and Recreational Vehicle Rentals |
| 259 | 7339 | Stenographic Service |
| 260 | 7372 | Computer Programming, Data Processing, and Integrated Systems Design Services |
| 261 | 7513 | Truck and Utility Trailer Rentals |
| 262 | 7511 | Truck Stops |
| 263 | 7379 | Computer Maintenance, Repair and Services (Business to Business MCC) |
| 264 | 7534 | Tire Retreading & Repair |
| 265 | 7338 | Quick Copy, Reproduction Service |
| 266 | 7538 | Automotive Service Shops (Non-Dealer) |
| 267 | 7349 | Cleaning, Maintenance & Janitorial Services |
| 268 | 7523 | Parking Lots and Garages |
| 269 | 7399 | Business Services |
| 270 | 7512 | Automobile Rental Agency |
| 271 | 7393 | Detective Agencies, Protective Agencies, and Security Services, including Armored Cars and Guard Dogs |
| 272 | 7342 | Exterminating and Disinfecting Services |
| 273 | 7394 | Equipment, Tool, Furniture, and Appliance Rental and Leasing |
| 274 | 3429 | Insurance Rent-a-Car |
| 275 | 3431 | Replacement Rent-a-Car |
| 276 | 3427 | Avon Rent-a-Car |
| 277 | 3425 | Automate Rent-a-Car |
| 278 | 3430 | Major Rent-a-Car |
| 279 | 3412 | A-1 R-A-C |
| 280 | 3420 | ANSA International |
| 281 | 3409 | General Rent-a-Car |
| 282 | 3421 | Allstate Rent-a-Car |
| 283 | 3423 | Avcar Rent-a-Car |
| 284 | 3428 | Carey Rent-a-Car |
| 285 | 3405 | Enterprise R-A-C |
| 286 | 3797 | Atlantic City Hilton |
| 287 | 3788 | Ala Moana Hotel / Ala Moana Hotels |
| 288 | 3814 | The Roosevelt Hotel NY |
| 289 | 3813 | Hotel Indigo |
| 290 | 3802 | The Palace Hotel |
| 291 | 3818 | Mainstay Suites |
| 292 | 3791 | Staybridge Suites |
| 293 | 3796 | Peppermill Hotel Casino |
| 294 | 3789 | Smugglers' Notch Resort |
| 295 | 3810 | La Costa Resort |
| 296 | 3801 | Wilderness Hotel and Golf Resort |
| 297 | 3793 | The Flamingo Hotels |
| 298 | 3807 | Element |
| 299 | 3799 | Hale Koa Hotel |
| 300 | 3790 | Raffles Hotels |
| 301 | 3812 | Hyatt Place |
| 302 | 3817 | Affinia |
| 303 | 3794 | Grand Casino Hotels |
| 304 | 3795 | Paris Las Vegas Hotel |
| 305 | 3811 | Premier Travel Inn |
| 306 | 3800 | Homestead |
| 307 | 3815 | Holiday Inn Nickelodeon |
| 308 | 3808 | LXR |
| 309 | 3792 | Claridge Casino Hotel |
| 310 | 3798 | Embassy Vacation Resort |
| 311 | 3816 | Home2 Suites |
| 312 | 3588 | Helmsley Hotels |
| 313 | 3584 | Princess Hotels International |
| 314 | 3589 | Doral Golf Resort |
| 315 | 3586 | Sokos Hotels |
| 316 | 3587 | Doral Hotels |
| 317 | 3590 | Fairmont Hotel |
| 318 | 3585 | Hungar Hotels |
| 319 | 3591 | Sonesta Hotels |
| 320 | 3592 | Omni Hotels |
| 321 | 3068 | AIR STANA |
| 322 | 3064 | Adria Airways |
| 323 | 3058 | Delta |
| 324 | 3054 | Ladeco (Chile) |
| 325 | 3055 | LAB (Bolivia) |
| 326 | 3057 | Virgin America – VIR AMER |
| 327 | 3063 | US Airways |
| 328 | 3062 | Hapag-Lloyd Express - HLX |
| 329 | 3060 | NWA Air |
| 330 | 3052 | LANAIR |
| 331 | 3053 | AVIACO (Spain) |
| 332 | 3066 | Southwest |
| 333 | 3056 | JetAir |
| 334 | 3059 | DBA Airlines-DBA AIR |
| 335 | 3065 | Airinter (AirInternational) |
| 336 | 3061 | Continental |
| 337 | 7299 | Miscellaneous Personal Services - Not Elsewhere Classified |
| 338 | 7332 | Blueprinting and Photocopying Services |
| 339 | 7333 | Commercial Photography, Art, and Graphics |
| 340 | 7311 | Advertising Services |
| 341 | 7298 | Health and Beauty Spas |
| 342 | 7276 | Tax Preparation Services |
| 343 | 7297 | Massage Parlors |
| 344 | 7321 | Consumer Credit Reporting Agencies |
| 345 | 7277 | Counseling Services - Debt, Marriage, and Personal |
| 346 | 7296 | Clothing Rental - Costumes, Uniforms and Formal Wear |
| 347 | 7278 | Buying and Shopping Services and Clubs |
| 348 | 3395 | Thrify Car Rental |
| 349 | 3398 | Econo Car R-A-C |
| 350 | 3389 | Avis R-A-C |
| 351 | 3391 | Europe by Car |
| 352 | 3386 | Showcase Rental Cars |
| 353 | 3396 | Tilden R-A-C |
| 354 | 3394 | Kemwell Group R-A-C |
| 355 | 3400 | Auto Host Car Rentals |
| 356 | 3387 | Alamo Rent a Car |
| 357 | 3385 | Tropical R-A-C |
| 358 | 3388 | Merchants Rent-A-Car, Inc |
| 359 | 3381 | Europ Car |
| 360 | 3390 | Dollar R-A-C |
| 361 | 3393 | National Car Rental |
| 362 | 3772 | Nemacolin Woodlands |
| 363 | 3781 | Patricia Grand Resort Hotels |
| 364 | 3786 | Ohana Hotel of Hawaii |
| 365 | 3775 | Sands Resort |
| 366 | 3778 | Four Points Hotels |
| 367 | 3776 | Nevele Grande Resort and Country Club |
| 368 | 3782 | Rosen Hotels & Resort |
| 369 | 3774 | New York-New York Hotel and Casino |
| 370 | 3767 | Main Street Hotel and Casino |
| 371 | 3777 | Mandalay Bay Resort |
| 372 | 3770 | SpringHill Suites |
| 373 | 3783 | Town and Country Resort and Convention Center |
| 374 | 3784 | First Hospitality Hotel |
| 375 | 3773 | The Venetian Resort Hotel and Casino |
| 376 | 3787 | Caribe Royale Resort Suites & Villas |
| 377 | 3785 | Outrigger Hotels and Resorts |
| 378 | 3780 | Disney Resorts |
| 379 | 3779 | W Hotels |
| 380 | 3765 | Bellagio |
| 381 | 3769 | Stratosphere Hotel and Casino |
| 382 | 3766 | Fremont Hotel and Casino |
| 383 | 3768 | Silver Star Hotel and Casino |
| 384 | 3771 | Caesar's Resort |
| 385 | 3583 | Radisson BLU |
| 386 | 3578 | Frankenmuth Bavarian |
| 387 | 3580 | Hotel Del Coronado |
| 388 | 3575 | Vagabond Hotels |
| 389 | 3576 | La Quinta Resort |
| 390 | 3573 | Sandman Hotels |
| 391 | 3582 | California Hotel and Casino |
| 392 | 3574 | Venture Inn |
| 393 | 3577 | Mandarin Oriental Hotel |
| 394 | 3581 | Delta Hotels |
| 395 | 3579 | Hotel Mercure |
| 396 | 3044 | Air Lanka |
| 397 | 3042 | FinnAir |
| 398 | 3049 | Tunis Air |
| 399 | 3046 | Cruzeiro do Sul (Bra) |
| 400 | 3039 | Avianca |
| 401 | 3037 | EgyptAir |
| 402 | 3041 | Balkan-Bulgarian |
| 403 | 3043 | Aer Lingus |
| 404 | 3051 | Austrian Airlines |
| 405 | 3035 | TAP (Portugal) |
| 406 | 3033 | Ansett Airlines |
| 407 | 3045 | Nigeria Airways |
| 408 | 3048 | Royal Air Maroc |
| 409 | 3034 | ETIHADAIR |
| 410 | 3040 | GulfAir (Bahrain) |
| 411 | 3050 | Icelandair |
| 412 | 3038 | Kuwait Airways |
| 413 | 3047 | THY (Turkey) |
| 414 | 3036 | VASP (Brazil) |
| 415 | 7210 | Laundry, Cleaning, and Garment Services |
| 416 | 7261 | Funeral Services and Crematories |
| 417 | 7251 | Shoe Repair Shops, Shoe Shine Parlors, and Hat Cleaning Shops |
| 418 | 6535 | Value Purchase - Member Financial Institution |
| 419 | 7012 | Timeshares |
| 420 | 6533 | Payment Transaction - Merchant |
| 421 | 6537 | MoneySend Intercountry |
| 422 | 6540 | POI Funding Transactions (Excluding MoneySend) |
| 423 | 7032 | Sporting and Recreational Camps |
| 424 | 7211 | Laundry Services - Family and Commercial |
| 425 | 6534 | Money Transfer - Member Financial Institution |
| 426 | 7273 | Dating Services |
| 427 | 6531 | Payment Service Provider |
| 428 | 7011 | Lodging - Hotels, Motels, and Resorts |
| 429 | 7217 | Carpet and Upholstery Cleaning |
| 430 | 7033 | Trailer Parks and Campgrounds |
| 431 | 7216 | Dry Cleaners |
| 432 | 7221 | Photographic Studios |
| 433 | 6538 | MoneySend Funding |
| 434 | 6536 | MoneySend Intracountry |
| 435 | 6532 | Payment Transaction - Member |
| 436 | 3353 | Brooks Rent a Car |
| 437 | 3368 | Holiday R-A-C |
| 438 | 3380 | Triangle Rent a Car |
| 439 | 3364 | Agency Rent a Car |
| 440 | 3376 | Ajax R-A-C |
| 441 | 3361 | Airways Rent a Car |
| 442 | 3354 | Action Auto Rental |
| 443 | 3352 | American International |
| 444 | 3355 | SIXT Car Rental |
| 445 | 3359 | Payless Car Rental |
| 446 | 3362 | Altra Auto Rental |
| 447 | 3374 | Accent Rent-A-Car |
| 448 | 3370 | Rent-a-Wreck |
| 449 | 3366 | Budget Rent a Car |
| 450 | 3360 | Snappy Car Rental |
| 451 | 3357 | Hertz |
| 452 | 3351 | Affiliated Auto Rental |
| 453 | 3758 | Kahala Mandarion Oriental Hotel |
| 454 | 3751 | Homewood Suites |
| 455 | 3760 | Halekulani Hotel/Waikiki Parc |
| 456 | 3738 | Tropicana Resort & Casino |
| 457 | 3753 | Greenbriar Resorts |
| 458 | 3741 | Millennium Hotel |
| 459 | 3737 | Riviera Hotel and Casino |
| 460 | 3748 | Wellesley Inns |
| 461 | 3740 | Towneplace Suites |
| 462 | 3749 | The Beverly Hills Hotel |
| 463 | 3762 | Whisky Pete's Hotel and Casino |
| 464 | 3746 | The Eliot Hotel |
| 465 | 3761 | Primadonna Hotel and Casino |
| 466 | 3759 | The Orchid at Mauna Lani |
| 467 | 3739 | Woodside Hotels & Resorts |
| 468 | 3750 | Crown Plaza Hotels |
| 469 | 3752 | Peabody Hotels |
| 470 | 3764 | Beau Rivage Hotel and Casino |
| 471 | 3755 | The Homestead |
| 472 | 3747 | ClubCorp/ClubResorts |
| 473 | 3754 | Amelia Island Plantation |
| 474 | 3736 | Colorado Belle/Edgewater Resort |
| 475 | 3763 | Chateau Elan Winery and Resort |
| 476 | 3745 | St. Regis Hotel |
| 477 | 3757 | Canyon Ranch |
| 478 | 3744 | Carefree Resorts |
| 479 | 3560 | Aladdin Resort and Casino |
| 480 | 3568 | Ladbroke Hotels |
| 481 | 3567 | Soho Grand Hotel |
| 482 | 3572 | Miyako Hotel |
| 483 | 3562 | Comfort Inns |
| 484 | 3564 | Sam's Town Hotel and Casino |
| 485 | 3561 | Golden Nugget |
| 486 | 3570 | Forum Hotels |
| 487 | 3566 | Garden Place Hotel |
| 488 | 3571 | Grand Wailea Resort |
| 489 | 3563 | Journey's End Motels |
| 490 | 3565 | Relax Inns |
| 491 | 3569 | Tribeca Grand Hotel |
| 492 | 3031 | Olympic Airways |
| 493 | 3018 | Varig (Brazil) |
| 494 | 3029 | SN Brussels Airlines - SN BRUSSELS |
| 495 | 3025 | Air New Zealand Ltd. |
| 496 | 3015 | SWISS |
| 497 | 3016 | SAS |
| 498 | 3021 | Air Algerie |
| 499 | 3022 | PAL AIR |
| 500 | 3028 | Air Malta |
| 501 | 3024 | Pakistan International |
| 502 | 3032 | El Al |
| 503 | 3026 | Emirates Airlines |
| 504 | 3017 | South African Airway |
| 505 | 3030 | Aerolineas Argentinas |
| 506 | 3027 | UTA/InterAir |
| 507 | 3020 | Air India |
| 508 | 3023 | Mexicana |
| 509 | 6300 | Insurance Sales and Underwriting |
| 510 | 5992 | Florists |
| 511 | 6051 | Visa - Non-Financial Institutions - Foreign Currency, Money Orders(not wire Transfer), & Travelers Cheques |
| 512 | 5993 | Cigar Stores & Stands |
| 513 | 5983 | Fuel Dealers--Fuel Oil, Wood, Coal, and Liquefied Petroleum |
| 514 | 6381 | Insurance - Premiums |
| 515 | 5977 | Cosmetic Stores |
| 516 | 6530 | Remote Stored Value Load - Merchant |
| 517 | 5998 | Tent and Awning Stores |
| 518 | 5999 | Miscellaneous & Specialty Retail Stores |
| 519 | 6529 | Remote Stored Value Load - Member Financial Institution |
| 520 | 6010 | Financial Institutions--Manual Cash Disbursements |
| 521 | 6513 | Real Estate Agents and Managers - Rentals; Property Management |
| 522 | 5978 | Typewriter Stores--Sales, Service, and Rentals |
| 523 | 6211 | Securities - Brokers and Dealers |
| 524 | 6050 | Quasi Cash - Member Financial Institution |
| 525 | 5996 | Swimming Pools--Sales, Supplies, and Services |
| 526 | 6012 | Quasi Cash - Financial Institution - Merchandise and Services |
| 527 | 6011 | Financial Institutions--Automated Cash Disbursements |
| 528 | 5994 | News Dealers & Newsstands |
| 529 | 5995 | Pet Shops, Pet Food, and Supplies |
| 530 | 5997 | Electric Razor Stores Sales & Services |
| 531 | 3277 | Air Madagascar |
| 532 | 3298 | Air Mauritius |
| 533 | 3286 | Aero Nicaraguensis |
| 534 | 3296 | Air Berlin-AIRBERLIN |
| 535 | 3287 | Aero Coach Aviation |
| 536 | 3282 | Air Djibouti |
| 537 | 3279 | Air LA |
| 538 | 3276 | Air Midwest |
| 539 | 3295 | Kenya Airways |
| 540 | 3293 | Ecuatoriana |
| 541 | 3292 | Cyprus Airways |
| 542 | 3285 | AeroPeru |
| 543 | 3275 | Air Nevada |
| 544 | 3294 | Ethiopian Airlines |
| 545 | 3280 | Air Jamaica |
| 546 | 3291 | Ariana Afghan |
| 547 | 3299 | Wideroe's Flyveselskap |
| 548 | 3297 | Tarom Romanian Air Transport |
| 549 | 3729 | John Ascuaga's Nugget |
| 550 | 3734 | Harvey/Bristol Hotels |
| 551 | 3730 | MGM Grand Hotel |
| 552 | 3723 | Rica Hotels |
| 553 | 3728 | Bally's Hotel and Casino |
| 554 | 3725 | SeaPines Plantation |
| 555 | 3735 | Master Economy Inns |
| 556 | 3732 | Opryland Hotel |
| 557 | 3731 | Harrah's Hotels and Casinos |
| 558 | 3721 | Hilton Conrad Hotels |
| 559 | 3722 | Wyndham Hotels |
| 560 | 3726 | Rio Suites |
| 561 | 3724 | Inter Nor Hotels |
| 562 | 3727 | Broadmoor Hotel |
| 563 | 3556 | Barton Creek Resort |
| 564 | 3555 | Treasure Island Hotel and Casino |
| 565 | 3552 | Coast Hotel |
| 566 | 3553 | Park Inn by Radisson |
| 567 | 3546 | Hotel Sierra |
| 568 | 3551 | Mirage Hotel and Casino |
| 569 | 3542 | Royal Hotels |
| 570 | 3545 | Shangri-La International |
| 571 | 3549 | Auberge des Governeurs |
| 572 | 3558 | Jolly Hotels |
| 573 | 3543 | Four Seasons |
| 574 | 3559 | Candlewood Suites |
| 575 | 3544 | Cigna Hotels |
| 576 | 3554 | Pinehurst Resort |
| 577 | 3557 | Manhattan East Suite Hotels |
| 578 | 3548 | Hotels Melia |
| 579 | 3550 | Regal 8 Inns |
| 580 | 3000 | United Airlines |
| 581 | 3012 | Qantas |
| 582 | 3008 | Lufthansa |
| 583 | 3006 | Japan Air Lines |
| 584 | 3007 | Air France |
| 585 | 3002 | Pan American |
| 586 | 3001 | American Airlines |
| 587 | 3009 | Air Canada |
| 588 | 3004 | Dragon Airlines |
| 589 | 3011 | AeroFlot |
| 590 | 3010 | KLM |
| 591 | 3014 | Saudi Arabian Airlines |
| 592 | 2842 | Specialty Cleaning, Polishing and Sanitation Preparations (Business to Business MCC) |
| 593 | 3013 | Alitalia |
| 594 | 3005 | British Airways |
| 595 | 3003 | Eurofly Airlines |
| 596 | 5946 | Camera and Photographic Supply Stores |
| 597 | 5963 | Direct Selling Establishments/Door to Door Sales |
| 598 | 5965 | Combined Catalog and Retail Merchant |
| 599 | 5975 | Hearing Aids--Sales, Service, and Supplies |
| 600 | 5932 | Antique Shop |
| 601 | 5949 | Sewing, Needlework, Fabric, and Piece Good Stores |
| 602 | 5968 | Continuity/Subscription Merchants |
| 603 | 5961 | Mail Order |
| 604 | 5942 | Book Stores |
| 605 | 5967 | Direct Marketing -- Inbound Telemarketing Merchants |
| 606 | 5940 | Bicycle Shop-Sales and Services |
| 607 | 5944 | Jewelry, Watch, Clock, and Silverware Stores |
| 608 | 5973 | Religious Goods Stores |
| 609 | 5976 | Orthopedic Goods and Prosthetic Devices |
| 610 | 5962 | Direct Marketing -- Travel Related Arrangement Services |
| 611 | 5972 | Stamp and Coin Stores |
| 612 | 5941 | Sporting Goods Stores |
| 613 | 5947 | Gift, Card, Novelty, and Souvenir Stores |
| 614 | 5960 | Direct Marketing Insurance Services |
| 615 | 5935 | Wrecking and Salvage Yards |
| 616 | 5937 | Antique Reproduction Stores |
| 617 | 5950 | Glassware and Crystal Stores |
| 618 | 5966 | Outbound Telemarketing Merchant |
| 619 | 5969 | Direct Marketing/Direct Marketers--Not Elsewhere Classified |
| 620 | 5933 | Pawn Shop |
| 621 | 5945 | Hobby, Toy and Game Stores |
| 622 | 5970 | Artist Supply and Craft Stores |
| 623 | 5943 | Stationery, Office and School Supply Stores |
| 624 | 5948 | Luggage and Leather Goods Stores |
| 625 | 5971 | Art Dealers and Galleries |
| 626 | 5964 | Catalog Merchant |
| 627 | 3247 | Gol Airlines - GOL |
| 628 | 3241 | Aviateca (Guatemala) |
| 629 | 3267 | Air Panama International |
| 630 | 3260 | Spirit Airlines - SPIRIT |
| 631 | 3245 | Easy Jet - EASYJET |
| 632 | 3243 | Austrian Air Service |
| 633 | 3246 | Ryan Air - RYANAIR |
| 634 | 3240 | Bahamasair |
| 635 | 3268 | Air Pacific |
| 636 | 3261 | Air China |
| 637 | 3256 | Alaska Airlines Inc. |
| 638 | 3252 | ALM-Antilean Airlines |
| 639 | 3248 | Tam Airlines - TAM |
| 640 | 3263 | Aero Servicio Carabobo |
| 641 | 3266 | Air Seychelles |
| 642 | 3242 | Avensa |
| 643 | 3239 | Bar Harbor Airlines |
| 644 | 3709 | Super 8 Motels |
| 645 | 3707 | Shoney's Inn |
| 646 | 3714 | Four Seasons Hotels-Austr |
| 647 | 3708 | Virgin River Hotel and Casino |
| 648 | 3717 | City Lodge Hotels |
| 649 | 3716 | Carlton Hotels |
| 650 | 3706 | Shilo Inn |
| 651 | 3712 | Buffalo Bill's Hotel and Casino |
| 652 | 3720 | Southern Sun Hotels |
| 653 | 3704 | Royce Hotels |
| 654 | 3713 | Quality Pacific Hotel |
| 655 | 3705 | Sandman Inn |
| 656 | 3711 | Flag Inns (Australia) |
| 657 | 3719 | Protea Hotels |
| 658 | 3710 | The Ritz Carlton Hotels |
| 659 | 3718 | Karos Hotels |
| 660 | 3715 | Fairfield Inn |
| 661 | 3530 | Renaissance Hotels |
| 662 | 3540 | Iberotel Hotels |
| 663 | 3527 | Downtowner Passport |
| 664 | 3534 | Southern Pacific |
| 665 | 3524 | WelcomGroup Hotels |
| 666 | 3537 | ANA Hotels |
| 667 | 3533 | Hotel Ibis |
| 668 | 3531 | Kauai Coconut Beach Resort |
| 669 | 3538 | Concorde Hotels |
| 670 | 3541 | Hotel Okura |
| 671 | 3536 | AMFAC Hotels |
| 672 | 3529 | CP (Canadian Pacific) |
| 673 | 3526 | Prince Hotels |
| 674 | 3532 | Royal Kona Resort |
| 675 | 3535 | Hilton International |
| 676 | 3539 | Summerfield Suites Hotel |
| 677 | 3528 | Red Lion Inns |
| 678 | 3525 | Dunfey Hotels |
| 679 | 0763 | Agricultural Cooperatives |
| 680 | 1740 | Masonry, Stonework, Tile Setting, Plastering, Insulation Contractors |
| 681 | 0780 | Landscaping and Horticultural Services |
| 682 | 1750 | Carpentry |
| 683 | 1711 | Heating, Plumbing, Air Conditioning Contractors |
| 684 | 2791 | Typesetting, Plate Making and Related Services (Business to Business MCC) |
| 685 | 1731 | Electrical Contractors |
| 686 | 1761 | Roof, Siding, and Sheet Metal Work Contractors |
| 687 | 2741 | Miscellaneous Publishing and Printing Services |
| 688 | 1799 | Special Trade Contractor - Not Elsewhere Classified |
| 689 | 1771 | Contractors, Concrete |
| 690 | 0742 | Veterinary Services |
| 691 | 1520 | General Contractor/Residential Building |
| 692 | 5722 | Household Appliance Stores |
| 693 | 5718 | Fireplaces, Fireplace Screens and Accessories Stores |
| 694 | 5719 | Miscellaneous Home Furnishing Specialty Stores |
| 695 | 5921 | Package Stores--Beer, Wine, and Liquor |
| 696 | 5817 | Digital Goods – Applications (Excludes Games) |
| 697 | 5816 | Digital Goods – Games |
| 698 | 5812 | Eating Places and Restaurants |
| 699 | 5912 | Drug Stores and Pharmacies |
| 700 | 5732 | Electronics Stores |
| 701 | 5813 | Drinking Places (Alcoholic Beverages) - Bars, Taverns, Nightclubs, Cocktail Lounges, and Discotheques |
| 702 | 5735 | Record Stores |
| 703 | 5734 | Computer Software Stores |
| 704 | 5713 | Floor coverings, Rugs |
| 705 | 5814 | Quick Payment Service-Fast Food Restaurants |
| 706 | 5733 | Music Stores-Musical Instruments, Pianos, and Sheet Music |
| 707 | 5931 | Used Merchandise and Secondhand Stores |
| 708 | 5811 | Caterers - Prepare & Delivery |
| 709 | 5818 | Large Digital Goods Merchant |
| 710 | 5714 | Drapery, Window Covering, and Upholstery Stores |
| 711 | 5815 | Digital Goods – Media, Books, Movies, Music |
| 712 | 3229 | SAETA |
| 713 | 3217 | CSA-Ceskoslovenske Aeroln |
| 714 | 3231 | SAHSA |
| 715 | 3228 | Cayman Airways |
| 716 | 3226 | Skyways_ Air- SKYWAYS |
| 717 | 3222 | Command Airways |
| 718 | 3220 | Compania Faucett |
| 719 | 3213 | Malmo Aviation - MALMO AV |
| 720 | 3211 | Norwegian Air Shuttle - NORWEGIANAIR |
| 721 | 3219 | Copa |
| 722 | 3212 | Dominicana de Aviacion |
| 723 | 3206 | China Eastern Airlines (Abbr: China East Air) |
| 724 | 3223 | Comair |
| 725 | 3236 | Air Arabia Airlines - Air Arab |
| 726 | 3204 | Freedom Airlines |
| 727 | 3200 | Guyana Airways |
| 728 | 3221 | Transportes Aeros Mil |
| 729 | 3234 | CARIBAIR |
| 730 | 3207 | Empresa Ecuatoriana |
| 731 | 3691 | Dillon Inn |
| 732 | 3700 | Motel 6 |
| 733 | 3703 | Residence Inn |
| 734 | 3689 | Consort Hotels |
| 735 | 3694 | Economy Inns of America |
| 736 | 3693 | Drury Inn |
| 737 | 3699 | Midway Motor Lodge |
| 738 | 3698 | Harley Hotels |
| 739 | 3702 | The Registry Hotels |
| 740 | 3697 | Fairfield Hotels |
| 741 | 3701 | La Mansion Del Rio |
| 742 | 3695 | Embassy Suites |
| 743 | 3690 | Courtyard Inns |
| 744 | 3692 | Doubletree |
| 745 | 3696 | Excel Inn |
| 746 | 6399 | Insurance - Not Elsewhere Classified |
| 747 | 9222 | Fines |
| 748 | 9753 | Consumer Electronics/Furniture Store |
| 749 | 9752 | U.K. Petrol Stations, Electronic Hot File |
| 750 | 9311 | Tax Payments |
| 751 | 9399 | Government Services - Not Elsewhere Classified |
| 752 | 9751 | U.K. Supermarkets, Electronic Hot File |
| 753 | 5262 | Marketplaces |
| 754 | 8931 | Accounting, Auditing, and Bookkeeping Services |
| 755 | 8999 | Professional Services - Not Elsewhere Classified |
| 756 | 2047 | Dog and Cat Food Mfg |
| 757 | 9754 | Quasi Cash - Gambling-Horse Racing, Dog Racing, State Lotteries |
| 758 | 9701 | Visa Credential Server |
| 759 | 9401 | i-Purchasing |
| 760 | 9950 | Intra-Company Purchases |
| 761 | 9700 | Automated Referral Service |
| 762 | 9223 | Bail & Bond Payments |
| 763 | 9211 | Court Costs, including Alimony and Child Support |
| 764 | 9702 | GCAS Emergency Services |
| 765 | 9402 | Postal Services |
| 766 | 9405 | U.S. Fed Government Agencies |
| 767 | 3516 | LaQuinta Motor Inns |
| 768 | 3511 | Arabella Hotels |
| 769 | 3519 | Pullman International Hotels |
| 770 | 3518 | Sol Hotels |
| 771 | 3510 | Days Inn Colonial Resort |
| 772 | 3522 | Tokyo Group |
| 773 | 3508 | Quality Inns |
| 774 | 3509 | Marriott |
| 775 | 3520 | Meridien Hotels |
| 776 | 3523 | Peninsula Hotels |
| 777 | 3512 | Intercontinental Hotels |
| 778 | 3521 | Royal Lahaina Resort |
| 779 | 3506 | Golden Tulip Hotels |
| 780 | 3517 | Americana Hotels |
| 781 | 3514 | Amerisuites |
| 782 | 3513 | Westin |
| 783 | 3515 | Rodeway Inn |
| 784 | 3507 | Friendship Inns |
| 785 | 5592 | Motor Home Dealers |
| 786 | 5681 | Furriers & Fur Shops |
| 787 | 5598 | Snowmobile Dealers |
| 788 | 5611 | Men's & Boys' Clothing and Accessory Stores |
| 789 | 5651 | Family Clothing Stores |
| 790 | 5699 | Miscellaneous Apparel and Accessory Stores |
| 791 | 5697 | Tailors, Seamstresses, Mending, Alterations |
| 792 | 5599 | Miscellaneous Automotive, Aircraft, and Farm Equipment Dealers --Not Elsewhere Classified |
| 793 | 5712 | Furniture, Home Furnishings, and Equipment Stores, except Appliances |
| 794 | 5641 | Children's and Infants' Wear Stores |
| 795 | 5655 | Sports and Riding Apparel Stores |
| 796 | 5631 | Women's Accessory and Specialty Stores |
| 797 | 5698 | Wig & Toupee Shops |
| 798 | 5661 | Shoe Stores |
| 799 | 5621 | Women's Ready-to-Wear Stores |
| 800 | 5691 | Men's and Women's Clothing Stores |
| 801 | 3198 | Harbor Airlines |
| 802 | 3180 | Westjet Airlines-WESTJET |
| 803 | 3178 | Mesa Air |
| 804 | 3196 | Hawaiian Air |
| 805 | 3185 | LAV (Venezuela) |
| 806 | 3177 | AirTran Airways |
| 807 | 3190 | Jugoslav Air |
| 808 | 3181 | Malev Hungarian Airlines |
| 809 | 3183 | Oman Aviation - OMAN AIR |
| 810 | 3186 | LAP (Paraguay) |
| 811 | 3187 | LACSA (Costa Rica) |
| 812 | 3191 | Island Airlines |
| 813 | 3193 | Indian Airlines |
| 814 | 3188 | Virgin Express - VIR EXP |
| 815 | 3199 | Servicios Aereos Militares |
| 816 | 3195 | Holiday Airlines |
| 817 | 3182 | LOT (Poland) |
| 818 | 3184 | LIAT |
| 819 | 3197 | Havasu Airlines |
| 820 | 3685 | Budgetel Hotels |
| 821 | 3682 | Sahara Hotel and Casino |
| 822 | 3671 | Arctia Hotels |
| 823 | 3676 | Monte Carlo Hotel and Casino |
| 824 | 3675 | Interhotel CEDOK |
| 825 | 3678 | Cumulus Hotels |
| 826 | 3673 | IBUSZ Hotels |
| 827 | 3680 | Hoteis Othan |
| 828 | 3688 | Compri Hotels |
| 829 | 3681 | Adams Mark Hotels |
| 830 | 3674 | Rantasipi Hotels |
| 831 | 3684 | Budget Hosts Inns |
| 832 | 3679 | Silver Legacy Hotel and Casino |
| 833 | 3683 | Bradbury Suites |
| 834 | 3686 | Suisse Chalet |
| 835 | 3677 | Climat de France Hotels |
| 836 | 3672 | Campanile Hotels |
| 837 | 3687 | Clarion Hotels |
| 838 | 8299 | Schools and Educational Services - Not Elsewhere Classified |
| 839 | 8641 | Civic, Social, and Fraternal Associations |
| 840 | 8398 | Charitable and Social Service Organizations |
| 841 | 8699 | Membership Organizations - Not Elsewhere Classified |
| 842 | 8675 | Automobile Associations |
| 843 | 8651 | Political Organizations |
| 844 | 8734 | Testing Laboratories (Not Medical) - (Business to Business MCC) |
| 845 | 8661 | Religious Organizations |
| 846 | 8249 | Trade and Vocational Schools |
| 847 | 8244 | Business and Secretarial Schools |
| 848 | 8351 | Child Care Services |
| 849 | 8911 | Architectural, Engineering, and Surveying Services |
| 850 | 3439 | Millville Rent-a-Car |
| 851 | 3441 | Advantage Rent A Car |
| 852 | 3505 | Forte Hotels |
| 853 | 3433 | Ugly Duckling R-A-C |
| 854 | 3435 | Value Rent-a-Car |
| 855 | 3504 | Hilton |
| 856 | 3502 | Best Western Hotels |
| 857 | 3501 | Holiday Inns |
| 858 | 3503 | Sheraton |
| 859 | 3438 | Interenet Rent-a-Car |
| 860 | 3434 | USA Rent-a-Car |
| 861 | 3436 | Autohansa Rent-a-Car |
| 862 | 5310 | Discount Store |
| 863 | 5551 | Boat Dealers |
| 864 | 5531 | Auto and Home Supply Stores |
| 865 | 5541 | Service Stations (with or without Ancillary Services) |
| 866 | 5311 | Department Stores |
| 867 | 5331 | Variety Stores |
| 868 | 5533 | Automotive Parts and Accessories Stores |
| 869 | 5411 | Grocery Stores and Supermarkets |
| 870 | 5571 | Motorcycle Dealers |
| 871 | 5441 | Candy, Nut, and Confectionary Stores |
| 872 | 5462 | Bakeries |
| 873 | 5309 | Duty Free Stores |
| 874 | 5511 | Car and Truck Dealers (New and Used)- Sales, Service, Repairs, Parts, and Leasing |
| 875 | 5300 | Wholesale Club with or without membership fee |
| 876 | 5521 | Car and Truck Dealers (Used)- Sales, Service, Repairs, Parts, and Leasing |
| 877 | 5399 | Miscellaneous General Merchandise |
| 878 | 5422 | Freezer & Locker Meat Provisions |
| 879 | 5532 | Automotive Tire Stores |
| 880 | 5542 | Automated Fuel Dispensers |
| 881 | 5451 | Dairy Product Stores |
| 882 | 5499 | Miscellaneous Food Stores-Convenience Stores and Specialty Markets |
| 883 | 7322 | Collection Agency |
| id | name |
|---|---|
| 1 | Card |
| 2 | ElectronicCheck |
| id | name |
|---|---|
| 1 | Active |
| 2 | Inactive |
| id | name |
|---|---|
| 1 | TSYS |
| 2 | EFT |
| id | countryId | code | name |
|---|---|---|---|
| 1 | 1 | AL | Alabama |
| 2 | 1 | AK | Alaska |
| 3 | 1 | AR | Arkansas |
| 4 | 1 | AZ | Arizona |
| 5 | 1 | CA | California |
| 6 | 1 | CO | Colorado |
| 7 | 1 | CT | Connecticut |
| 8 | 1 | DC | D.C. |
| 9 | 1 | DE | Delaware |
| 10 | 1 | FL | Florida |
| 11 | 1 | GA | Georgia |
| 12 | 1 | HI | Hawaii |
| 13 | 1 | IA | Iowa |
| 14 | 1 | ID | Idaho |
| 15 | 1 | IL | Illinois |
| 16 | 1 | IN | Indiana |
| 17 | 1 | KS | Kansas |
| 18 | 1 | KY | Kentucky |
| 19 | 1 | LA | Louisiana |
| 20 | 1 | MA | Massachusetts |
| 21 | 1 | MD | Maryland |
| 22 | 1 | ME | Maine |
| 23 | 1 | MI | Michigan |
| 24 | 1 | MN | Minnesota |
| 25 | 1 | MO | Missouri |
| 26 | 1 | MS | Mississippi |
| 27 | 1 | MT | Montana |
| 28 | 1 | NC | North Carolina |
| 29 | 1 | ND | North Dakota |
| 30 | 1 | NE | Nebraska |
| 31 | 1 | NH | New Hampshire |
| 32 | 1 | NJ | New Jersey |
| 33 | 1 | NM | New Mexico |
| 34 | 1 | NV | Nevada |
| 35 | 1 | NY | New York |
| 36 | 1 | OK | Oklahoma |
| 37 | 1 | OH | Ohio |
| 38 | 1 | OR | Oregon |
| 39 | 1 | PA | Pennsylvania |
| 40 | 1 | RI | Rhode Island |
| 41 | 1 | SC | South Carolina |
| 42 | 1 | SD | South Dakota |
| 43 | 1 | TN | Tennessee |
| 44 | 1 | TX | Texas |
| 45 | 1 | UT | Utah |
| 46 | 1 | VA | Virginia |
| 47 | 1 | VT | Vermont |
| 48 | 1 | WA | Washington |
| 49 | 1 | WI | Wisconsin |
| 50 | 1 | WV | West Virginia |
| 51 | 1 | WY | Wyoming |
| id | name |
|---|---|
| 1 | Created |
| 2 | Cancelled |
| 3 | Completed |
| 4 | Failed |
| Status Code | Status | Description | Available actions |
|---|---|---|---|
| 1 | Authorized | Transaction status after an approved pre-authorization request |
Capture, Void |
| 2 | Captured | Transaction status after aproved sale or capture request |
Void |
| 3 | Voided | Transaction status after merchant voids an authorized request or refunds a captured (not settled) request |
N/A |
| 4 | Refunded | Transaction status after merchant refunds a settled request |
N/A |
| 5 | Verified | NA | N/A |
| 6 | Settled | Transaction status after successful settlement request. All captured transactions should have status changed to settled |
Refund |
| 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 |
| 8 | Informational | NA | N/A |
| 21 | Scheduled | NA | N/A |
| 24 | Pending | Transaction status while changing status. This is a temporary status | N/A |
| 91 | Declined | Transaction status after a denied pre-authorization, sale or capture request |
N/A |
| 92 | Failed | Transaction status after a failure at any type of request | N/A |
| 92 | Expired | Transaction status after 7 days in authorized status (merchant has not captured within this time) |
N/A |
The ACH (automated clearing house) transactions endpoints allow creating and managing ACH payments.
These operations support initiating ACH debit and credit transactions, retrieving transaction details, and monitoring transaction status throughout processing. They also provide controls for managing transactions before settlement, such as placing transactions on hold, releasing holds, voiding pending transactions, or issuing refunds as needed.
The following is a typical Aurora ACH workflow.
Authorizing the Payment
The customer authorizes the ACH payment.
This includes obtaining obtain NACHA-compliant authorization.
NACHA (National Automated Clearing House Association) is the organization that governs the ACH payment network in the United States.
It sets the rules and standards for ACH payments.
The customer provides the SEC (standard entry class) code for the payment method. This establishes the form of payment. It can be one of the following:
And their personal information:
Creating the Payment
The method can include either a credit or debit transaction:
POST /pay-api/v1/transactions/ach/payment/credit
POST /pay-api/v1/transactions/ach/payment
Submitting the Payment
Creating the ACH (automated clearing house) transaction also submits the request for processing.
Aurora aggregates transactions and sends them to the ODFI (originating bank) in an ACH (automated clearing house) transaction batch. ACH (automated clearing house) transactions are typically not processed individually but rather in as a batch of transactions. That processing is done by the ACH network and batches may take up to two days to clear. Therefore, there may be a delay in processing ACH (automated clearing house) transaction requests. An individual ACH (automated clearing house) transaction may be requested for same day processing. Settlement in those cases may occur within hours. Check with the originating bank for specific policies and fees.
Statusing the Payment
Individual requests will always have an available status that can be checked.
These will be noted with the Aurora transaction creator type identifier.
A status check may be submitted at any time.
Check the response field status or statusId.
POST {{baseURL}}/pay-api/v1/transactions/{{transactionId}}
A webhook can also be used.
A webhook allows one system to automatically send real-time data to another system when a specific event happens.
This is an alternative to manually polling the request.
Instead, the webhook can be set to check the status of an ACH (automated clearing house) transaction.
When the status changes, or reaches a specified status, such as settled, a notification can be sent to the customer.
Holding or Cancelling the Payment
After the ACH (automated clearing house) transaction request has been successfully submitted, the transaction by the put on hold or cancelled.
A transaction on hold means the request will not be processed.
That transaction must either be released to continue processing or cancelled.
POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/hold
POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/unhold
A transaction that is cancelled will be withdrawn from further processing.
An ACH (automated clearing house) transaction request cannot be cancelled after it has been submitted to the ACH network.
This is indicated by it's pending status.
POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/void
Settling the Payment
If the ACH (automated clearing house) transaction request is successful, it returns with a status of settled.
The merchant receives funds in their settlement account.
The ACH (automated clearing house) transaction is completed.
Unsuccessfully Completing the Payment
Banks can reject the payment with ACH return codes.
Check the ACH return code for the specific reason.
Refunding the Payment
Refunds may be issued.
The ACH (automated clearing house) transaction request must have successfully been resolved and settled.
POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/refund
POST {{baseURL}}/pay-api/v1/transactions/ach/payment/credit
This endpoint creates a credit ACH (automated clearing house) transaction to transfer funds from the merchant to the customer.
It specifically transfers money from the sender’s bank account to the recipient’s account. This is used in credit operations, such as payouts or refunds without reference. A refund without reference (also called unreferenced refunds) are refunds issued without linking it back to original receipt.
The endpoint call:
POST {{baseURL}}/pay-api/v1/transactions/ach/payment/credit
The endpoint request body:
{
"paymentProcessorId": "4acafddf-68a7-4aeb-9778-87582d121307",
"paymentMethodId": "55419052-670c-497b-a53d-43d21ef45e14",
"amount": 123.45,
"secCode": 3,
"RequesterIpAddress": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}
See Also:
To create an ACH debit transaction, see POST /pay-api/v1/transactions/ach/payment
| amount required | number <double> Specifies the payment amount. Example: 129.99 | |||||||||||||||
| paymentProcessorId required | string <uuid> Specifies the ACHQ (ACH check) payment processor identifier. Example: f4e41489-aea6-4279-b6f1-e1f9bffd5358 | |||||||||||||||
| secCode required | integer <int32> (PaymentGateway.Contracts.Enums.Ach.AchSECCode) Default: 1
Allowed values:
Example: 1 | |||||||||||||||
| requesterIPaddress required | string [ 1 .. 45 ] characters Specifies the IP address of the end user. This is an IPv4 or IPv6 address. This may be the customer, operator, or application responsible for submitting the transaction. Examples: | |||||||||||||||
| paymentMethodId required | string or null <uuid> (ach_paymentmethodid) Indentifies the customer payment method identifier. Example: b6df8625-cd25-4123-b345-638aa7b5d011 | |||||||||||||||
| customerId | string or null <uuid> (ach_customerid) Specifies the customer identifier. Example: 87d8e330-2878-4742-a86f-dbbb3bf522ac | |||||||||||||||
| isFasterProcessing | boolean (ach_isfasterprocessing) Default: false Specifies ACH (automated clearing house) transaction has same day processing enabled. Must be empty or null for card subscriptions. If Example: false | |||||||||||||||
| routingNumber | string or null (ach_routingnumber) Specifies the payment target's bank routing number. Example: 026009593 | |||||||||||||||
| accountNumber | string or null (ach_accountnumber) Specifies the payment target's bank account number. Example: 5413591081013511 | |||||||||||||||
| taxId | string or null (ach_taxid) Specifies the customer's tax identifier (TIN). Example: 98-7654321 | |||||||||||||||
| accountType | integer <int32> (PaymentGateway.Contracts.Enums.AccountType) Identifies the account type. Possible values:
Example: 1 | |||||||||||||||
| accountHolderType | integer <int32> (PaymentGateway.Contracts.Enums.AccountHolderType) Identifies the account holder type. Possible values:
Example: 1 | |||||||||||||||
object (PaymentGateway.Contracts.Transactions.AddressDto) Specifies an object defining the address. | ||||||||||||||||
| ||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AddressDto) Specifies an object defining the address. | ||||||||||||||||
| ||||||||||||||||
object (PaymentGateway.Contracts.Transactions.ContactInfoDto) This group contains the customer's contact details. | ||||||||||||||||
| ||||||||||||||||
| transactionId | string <uuid> (ach_transactionid) Indicates the transaction identifier. Example: bf5a1dc7-57b7-4fec-ab09-52c47c1acaff |
| typeId | integer <int32> (ach_typeid) Indicates the Aurora ACH (automated clearing house) transaction type code. Example: 6 |
| type | string or null (ach_type) Indicates the Aurora ACH transaction type. Example: CardAuthentication |
| statusId | integer <int32> (ach_statusid) Indicates the Aurora ACH transaction status code. Example: 1 |
| status | string or null (ach_status) Indicates the Aurora ACH transaction status type. Example: Authorized |
| responseDescription | string or null (ach_responsedescription) Indicates a free-formed description regarding the transaction. Example: Command Successful. Approved. |
| responseCode | string or null (ach_responsecode) Indicates a response code regarding the transaction. Example: 000 |
| processedAmount | number <double> Indicates the transaction amount (in USD). Example: 3500.00 |
{- "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
}Valid parameters. Approved
{- "processedAmount": 0,
- "transactionId": "5758166f-3608-4625-8dd6-04124a633581",
- "typeId": 12,
- "type": "AchRefund",
- "statusId": 23,
- "status": "ChargedBack",
- "responseDescription": "Command Successful. Approved.",
- "responseCode": "000"
}POST {{baseURL}}/pay-api/v1/transactions/ach/payment
This endpoint creates an ACH (automated clearing house) transaction to transfer funds from the customer to the merchant.
It specifically transfers money from the customer’s bank account to the merchant’s account.
The endpoint call:
POST {{baseURL}}/pay-api/v1/transactions/ach/payment
The endpoint request body:
{
"paymentProcessorId": "7a913ba9-724b-4020-8ef1-d3375291f59e",
"RequesterIpAddress": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"amount": 54.87,
"secCode": 1,
"accountHolderType": 1,
"accountNumber": "123456789",
"routingNumber": "123123123",
"accountType": 1,
"billingAddress":
{
"city": "New York",
"countryId": 1,
"line1": "1234 Hudson Avenue",
"postalCode": "10001",
"stateName": NY,
"stateId": 25
},
"contactInfo":
{
"firstName": "Alex",
"lastName": "Morgan",
"companyName": "Positive",
"email": "a.morgan@example.com",
"mobilePhoneNumber": '+14155554618'
}
}
See Also:
To create an ACH credit transaction, see GET /pay-api/v1/transactions/ach/payment/credit
| amount required | number <double> Specifies the payment amount. Example: 129.99 | |||||||||||||||
| paymentProcessorId required | string <uuid> Specifies the ACHQ (ACH check) payment processor identifier. Example: f4e41489-aea6-4279-b6f1-e1f9bffd5358 | |||||||||||||||
| secCode required | integer <int32> (PaymentGateway.Contracts.Enums.Ach.AchSECCode) Default: 1
Allowed values:
Example: 1 | |||||||||||||||
| requesterIPaddress required | string [ 1 .. 45 ] characters Specifies the IP address of the end user. This is an IPv4 or IPv6 address. This may be the customer, operator, or application responsible for submitting the transaction. Examples: | |||||||||||||||
| paymentMethodId | string or null <uuid> Specifies the customer payment method identifier. Providing this value indicates the transaction uses a stored bank account. If this value is included,customerId must also be included.
Example: b6df8625-cd25-4123-b345-638aa7b5d011 | |||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. Providing this value indicates the transaction uses a stored bank account. This value is required ifpaymentMethodId is provided.
Providing this value without also providing paymentMethodId indicates the transaction does not use a stored bank account.
In this case, a new customer will automatically be generated.
Example: 87d8e330-2878-4742-a86f-dbbb3bf522ac | |||||||||||||||
| routingNumber | string or null Specifies the payment target's bank routing number. This value is required when the transaction is not using using a stored bank account.Example: 026009593 | |||||||||||||||
| accountNumber | any or null Specifies the payment target's bank account number. This value is required when the transaction is not using using a stored bank account.Example: 5413591081013511 | |||||||||||||||
| accountType | integer <int32> Identifies the account type. This value is required when the transaction is not using using a stored bank account.Possible values:
Example: 1 | |||||||||||||||
| accountHolderType | integer <int32> Identifies the account holder type. This value is required when the transaction not using using a stored bank account.Possible values:
Example: 1 | |||||||||||||||
object
This object is required when the transaction is not using using a stored bank account.
| ||||||||||||||||
| ||||||||||||||||
object
This object is required when the transaction is not using using a stored bank account.
| ||||||||||||||||
| ||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AddressDto) Specifies an object defining the address. | ||||||||||||||||
| ||||||||||||||||
| isFasterProcessing | boolean (ach_isfasterprocessing) Default: false Specifies ACH (automated clearing house) transaction has same day processing enabled. Must be empty or null for card subscriptions. If Example: false | |||||||||||||||
| taxId | string or null (ach_taxid) Specifies the customer's tax identifier (TIN). Example: 98-7654321 | |||||||||||||||
| transactionId | string <uuid> (ach_transactionid) Indicates the transaction identifier. Example: bf5a1dc7-57b7-4fec-ab09-52c47c1acaff |
| typeId | integer <int32> (ach_typeid) Indicates the Aurora ACH (automated clearing house) transaction type code. Example: 6 |
| type | string or null (ach_type) Indicates the Aurora ACH transaction type. Example: CardAuthentication |
| statusId | integer <int32> (ach_statusid) Indicates the Aurora ACH transaction status code. Example: 1 |
| status | string or null (ach_status) Indicates the Aurora ACH transaction status type. Example: Authorized |
| responseDescription | string or null (ach_responsedescription) Indicates a free-formed description regarding the transaction. Example: Command Successful. Approved. |
| responseCode | string or null (ach_responsecode) Indicates a response code regarding the transaction. Example: 000 |
| processedAmount | number <double> Indicates the transaction amount (in USD). Example: 3500.00 |
{- "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
}Valid parameters. Approved
{- "processedAmount": 0,
- "transactionId": "b3edb5a8-e235-4ef7-9003-2343b43c5c41",
- "typeId": 11,
- "type": "AchDebit",
- "statusId": 21,
- "status": "Scheduled",
- "responseDescription": "Command Successful. Approved.",
- "responseCode": "000"
}POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/void
This endpoint voids or cancels an ACH (automated clearing house) transaction payment before it is processed or submitted to the ACH network.
After the transaction payment is submitted to the ACH network, it cannot be voided.
See Also:
To refund a settled ACH transaction, see POST /pay-api/v1/transactions/ach/{{transactionId}}/refund
To place a hold on an ACH transaction, see POST /pay-api/v1/transactions/ach/{{transactionId}}/hold
| transactionId required | string <uuid> Example: 004db5a8-a153-4334-a0b4-1aa22fbffb3e Specifies the ACH (automated clearing house) transaction identifier. This value is returned as
Example: 004db5a8-a153-4334-a0b4-1aa22fbffb3e |
| transactionId | string <uuid> (ach_transactionid) Indicates the transaction identifier. Example: bf5a1dc7-57b7-4fec-ab09-52c47c1acaff |
| typeId | integer <int32> (ach_typeid) Indicates the Aurora ACH (automated clearing house) transaction type code. Example: 6 |
| type | string or null (ach_type) Indicates the Aurora ACH transaction type. Example: CardAuthentication |
| statusId | integer <int32> (ach_statusid) Indicates the Aurora ACH transaction status code. Example: 1 |
| status | string or null (ach_status) Indicates the Aurora ACH transaction status type. Example: Authorized |
| responseDescription | string or null (ach_responsedescription) Indicates a free-formed description regarding the transaction. Example: Command Successful. Approved. |
| responseCode | string or null (ach_responsecode) Indicates a response code regarding the transaction. Example: 000 |
| processedAmount | number <double> Indicates the transaction amount (in USD). Example: 3500.00 |
Valid parameters. Approved
{- "processedAmount": 0,
- "transactionId": "4300da2c-8a00-48c2-bb9b-d84cf6313b7c",
- "typeId": 15,
- "type": "AchDebit",
- "statusId": 22,
- "status": "Cancelled",
- "responseDescription": "Command Successful. Approved.",
- "responseCode": "000"
}POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/hold
This endpoint places an ACH (automated clearing house) transaction payment on hold.
This is temporarily paused in processing. It is prevented from being processed or submitted to the ACH network until it is released.
See Also:
To release an ACH transaction payment hold, see POST /pay-api/v1/transactions/ach/{{transactionId}}/unhold.
To void or cancel an ACH transaction that has not been settled, see POST /pay-api/v1/transactions/ach/{{transactionId}}/void
| transactionId required | string <uuid> Example: 004db5a8-a153-4334-a0b4-1aa22fbffb3e Specifies the ACH (automated clearing house) transaction identifier. This value is returned as
Example: 004db5a8-a153-4334-a0b4-1aa22fbffb3e |
| transactionId | string <uuid> (ach_transactionid) Indicates the transaction identifier. Example: bf5a1dc7-57b7-4fec-ab09-52c47c1acaff |
| typeId | integer <int32> (ach_typeid) Indicates the Aurora ACH (automated clearing house) transaction type code. Example: 6 |
| type | string or null (ach_type) Indicates the Aurora ACH transaction type. Example: CardAuthentication |
| statusId | integer <int32> (ach_statusid) Indicates the Aurora ACH transaction status code. Example: 1 |
| status | string or null (ach_status) Indicates the Aurora ACH transaction status type. Example: Authorized |
| responseDescription | string or null (ach_responsedescription) Indicates a free-formed description regarding the transaction. Example: Command Successful. Approved. |
| responseCode | string or null (ach_responsecode) Indicates a response code regarding the transaction. Example: 000 |
{- "transactionId": "857757f3-9d2b-4204-abe6-c9d95bd41ec0",
- "typeId": 13,
- "type": "AchHold",
- "statusId": 26,
- "status": "Held",
- "responseDescription": null,
- "responseCode": null
}POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/unhold
This endpoint removes an ACH (automated clearing house) transaction payment that is on hold.
The ACH transaction resumes being processed and is submitted to the ACH network.
See Also:
To place an ACH transaction payment on hold, see POST //pay-api/v1/transactions/ach/{{transactionId}}/hold
| transactionId required | string <uuid> Example: 004db5a8-a153-4334-a0b4-1aa22fbffb3e Specifies the ACH (automated clearing house) transaction identifier. This value is returned as
Example: 004db5a8-a153-4334-a0b4-1aa22fbffb3e |
| transactionId | string <uuid> (ach_transactionid) Indicates the transaction identifier. Example: bf5a1dc7-57b7-4fec-ab09-52c47c1acaff |
| typeId | integer <int32> (ach_typeid) Indicates the Aurora ACH (automated clearing house) transaction type code. Example: 6 |
| type | string or null (ach_type) Indicates the Aurora ACH transaction type. Example: CardAuthentication |
| statusId | integer <int32> (ach_statusid) Indicates the Aurora ACH transaction status code. Example: 1 |
| status | string or null (ach_status) Indicates the Aurora ACH transaction status type. Example: Authorized |
| responseDescription | string or null (ach_responsedescription) Indicates a free-formed description regarding the transaction. Example: Command Successful. Approved. |
| responseCode | string or null (ach_responsecode) Indicates a response code regarding the transaction. Example: 000 |
{- "transactionId": "65ab0547-8891-4719-956b-39fecaf41037",
- "typeId": 14,
- "type": "AchUnHold",
- "statusId": 21,
- "status": "Scheduled",
- "responseDescription": null,
- "responseCode": null
}POST {{baseURL}}/pay-int-api/categories
Category Name must be unique in the merchant account.
| x-api-version | string |
The category creation request.
| name | string or null Sets the name of the category. |
| defaultUnitTypeId | integer or null <int32> Sets the default unit type identifier for the category. |
| id | string <uuid> The identifier of the created category. |
{- "name": "string",
- "defaultUnitTypeId": 0
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}GET {{baseURL}}/pay-int-api/categories
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| search | string Gets or sets the search query to filter categories. |
| x-api-version | string |
Array of objects or null (PaymentIntegrations.Contracts.Categories.Get.GetCategoriesResponseDto) | |||||||||
Array
| |||||||||
| total | integer <int32> | ||||||||
{- "items": [
- {
- "name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "defaultUnitTypeId": 0,
- "itemCount": 0
}
], - "total": 0
}DELETE {{baseURL}}/pay-int-api/categories/{{categoryId}}
This category will not be available in the catalog.
Items linked to this category will still be in the catalog with empty category.
| categoryId required | string <uuid> The ID of the category to delete. |
| x-api-version | string |
{- "details": null,
- "statusCode": 500,
- "source": "<Service>",
- "exceptionType": "Exceptions.IntegrationException",
- "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69",
- "entityId": null,
- "errorCode": null
}PUT {{baseURL}}/pay-int-api/categories/{{categoryId}}
The category name must be unique in the merchant account.
| categoryId required | string <uuid> The ID of the category to update. |
| x-api-version | string |
The category update request.
| name | string or null Gets or sets the new name of the category. |
| defaultUnitTypeId | integer or null <int32> Gets or sets the default unit type identifier for the category, if it needs to be updated. |
{- "name": "string",
- "defaultUnitTypeId": 0
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81",
- "entityId": null,
- "errorCode": null
}GET {{baseURL}}/pay-api/v1/configurations/payments
This endpoint returns a list of payment configurations.
| zeroCostProcessingOptionId | integer <int32> (PaymentGateway.Contracts.Enums.ZeroCostProcessingOption)
Possible values:
Example: 3 | ||||||||||||||||||||||||||||||||
| zeroCostProcessingOption | string or null Zero cost processing option name. Possible values:
Example: DualPricing | ||||||||||||||||||||||||||||||||
| defaultTipsOptions | Array of numbers or null <double> [ items <double > [ 0 .. 3 ] items ] Identifies an array of default, or preselected, tip options. These values could be displayed on a receipt as preselected tip value options. The client's app and UX needs to support that display. They are presented as a percent alongside the actual money amount. The intent is to present these values from which clients can quickly select a tip amount. They are suggestions presented only as a convenience to the client. The client should able to select any value, a custom value, or no value These values are configured by the merchant. Example: [10, 12.0, 15.25, 20.5] | ||||||||||||||||||||||||||||||||
| isTipsEnabled | boolean Indicates tips are enabled. If Tips are enabled or disabled in the Merchant portal (https://auth.arise.risewithaurora.com). Example: true | ||||||||||||||||||||||||||||||||
| defaultSurchargeRate | number or null <double> Identifies the default surcharge rate. This value is configured by the merchant. Example: 3.5 | ||||||||||||||||||||||||||||||||
| defaultCashDiscountRate | number or null <double> Identifies the default cash discount rate. This value is configured by the merchant. Example: 3.5 | ||||||||||||||||||||||||||||||||
| defaultDualPricingRate | number or null <double> Identifies the default dual pricing rate. Dual pricing is when the merchant displays two prices for the same product. For example, for cash or credit card. The dual pricing rate is the additional charge for the other price, such as with a credit card. This value is configured by the merchant. Example: 3.5 | ||||||||||||||||||||||||||||||||
Array of objects or null (PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.EnumDto)
| |||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||
Array of objects or null
| |||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||
Array of objects or null Indicates available transactions types. | |||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||
Array of objects or null (PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.PaymentProcessorDto)
| |||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.AvsOptions) | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
| isCustomerCardSavingByTerminalEnabled | boolean Indicates the terminal saves the customer's card after the transaction is processed. If Example: true | ||||||||||||||||||||||||||||||||
| companyName | string or null Indicates the customer's company name. Example: Peppared Street Cafe | ||||||||||||||||||||||||||||||||
| mccCode | string or null Indicates the MCC (merchant category code). Example: 28 | ||||||||||||||||||||||||||||||||
| mccCodeDescription | string or null Indicates the merchant category code description. Example: Hospitals | ||||||||||||||||||||||||||||||||
| currencyId | integer <int32> Indicates the currency identifier. Possible values can be found in Example: 1 (for USD) | ||||||||||||||||||||||||||||||||
| currencyIsoCode | string or null Indicates the currency (in ISO 4217 alpha-3 currency code format). Example: USD | ||||||||||||||||||||||||||||||||
| maxTransactionAmount | number or null <double> Indicates the maximum transaction amount limit. Example: 32000 | ||||||||||||||||||||||||||||||||
{- "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
}GET {{baseURL}}/pay-api/v1/configurations/contact-infos
This endpoint returns the merchant's detailed information.
The list includes contact information records for the merchant, such as address, phone number, and credit cards. This information can be integrated with other endpoints of the application, such as the invoice creation functionality.
Array of objects or null (PaymentGateway.Contracts.Configurations.MerchantContactInfos.GetMerchantContactInfosResponse.ContactInfo) A list of contact information entries associated with the merchant. | |||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||
{- "contactInfos": [
- {
- "id": "24d5e6f7-8a9b-4c0d-1e2f-3a4b5c6d7e03",
- "addressName": "Main Office",
- "addressLine1": "322 Unicorn Boulevard",
- "addressLine2": "Office 3",
- "city": "Chicago",
- "zip": "60612",
- "countryId": 1,
- "stateId": 4,
- "stateName": "TX",
- "email": "string",
- "businessPhoneNumber": "+14155552309",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "isMainAddress": true,
- "isDefaultAddress": true
}
]
}POST {{baseURL}}/pay-api/v1/customers
This endpoint creates a customer.
The return field id is the customerId, also referred to as the customer identifier.
Use this value to specify this customer in other endpoints.
See Also:
To search for a customer, see GET /pay-api/v1/customers
To find a customer by identifier, see GET /pay-api/v1/customers/{{customerId}}
To update a customer's information, see PUT /pay-api/v1/customers/{{customerId}}
| firstName required | string Specifies the customer's first name. Example: Alexandro | ||||||||||||||||||||||||||||||
| lastName required | string Indicates the customer's last name. Example: Peppared | ||||||||||||||||||||||||||||||
| companyName | string or null Indicates the customer's company name. Example: Peppared Street Cafe | ||||||||||||||||||||||||||||||
string or null Indicates the customer's email. Example: peppared@example.com | |||||||||||||||||||||||||||||||
| mobilePhoneNumber | string or null <E.164> <= 20 characters ^(null|\+\d{1,20})$ Indicates the customer's mobile phone number. Example: +14155552309 | ||||||||||||||||||||||||||||||
| isMobileNumberSmsNotificationsEnabled | boolean Indicates the customer's SMS notification is enabled. If Example: true | ||||||||||||||||||||||||||||||
| useBillingAsShippingAddress | boolean Indicates to use the billing address as the shipping address. If Example: true | ||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.AddressDto) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.AddressDto) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Array of objects or null (PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.PaymentMethodCardDto) Payment methods | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects or null (PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.PaymentMethodAchAccountDto) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
| id | string <uuid> Indicates the customerId or the customer identifier. Example: 965865ef-b17d-4153-b952-d8902e584f7d |
{- "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
}{- "id": "965865ef-b17d-4153-b952-d8902e584f7d"
}GET {{baseURL}}/pay-api/v1/customers
This endpoint searches the partner's customers.
The search can specify filters to better target intended customers.
See Also:
To find a customer by identifier, see GET /pay-api/v1/customers/{{customerId}}
To create a customer, see POST /pay-api/v1/customers
To delete a customer, see DELETE /pay-api/v1/customers/{{customerId}}
To update a customer's information, see PUT /pay-api/v1/customers/{{customerId}}
| search | string Specifies the search string. The 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 firstName Example: Conners Electric |
| customerIds | string <uuid> Example: customerIds=c4b210e9-be39-4ebc-8195-0c422de87f90 Specifies a single customer's identifier. |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| dateFrom | string <date-time> Example: dateFrom=2025-01-27T12:05:54.322587+05:30 Specifies returning items on or after this date (in an ISO 8601 date-time format). If Examples: |
| dateTo | string <date-time> Example: dateTo=2025-01-27T12:05:54.322587+05:30 Specifies returning items on or to this date (in an ISO 8601 date-time format). If Examples: |
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
Array of objects or null (PaymentGateway.Contracts.Customers.Common.CustomerItemDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| total | integer <int32> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "items": [
- {
- "id": "019bf058-960f-72a0-8194-6d554c7d6004",
- "createdOn": "2025-01-27T12:05:54.322587+05:30",
- "modifiedOn": "2025-01-27T12:05:54.322587+05:30",
- "lastTransactionDate": "2025-01-27T12:05:54.322587+05:30",
- "lastTransactionAmount": 0.1,
- "activeSubscriptionsAmount": 0.1,
- "contactName": "Example: Alexandro Peppared",
- "firstName": "string",
- "lastName": "string",
- "companyName": "Peppared Street Cafe",
- "email": "peppared@example.com",
- "mobilePhoneNumber": "+14155552309",
- "isMobileNumberSmsNotificationsEnabled": true,
- "billingAddress": {
- "addressLine1": "21 E. Main Street",
- "addressLine2": "Office 3",
- "city": "Chicago",
- "zip": "60612",
- "stateName": "string",
- "state": {
- "id": 0,
- "code": "TX",
- "name": "string"
}, - "country": {
- "id": 0,
- "isoCode": "string",
- "name": "string"
}
}, - "paymentMethodsCount": 0
}
], - "total": 0
}GET {{baseURL}}/pay-api/v1/customers/{{customerId}}
This endpoint searches for the specified customer.
See Also:
To search for a customer, see GET /pay-api/v1/customers
To update a customer's information, see PUT /pay-api/v1/customers/{{customerId}}
To create a customer, see POST /pay-api/v1/customers
To delete a customer, see DELETE /pay-api/v1/customers/{{customerId}}
| customerId required | string <uuid> Example: c4b210e9-be39-4ebc-8195-0c422de87f90 Specifies the customerId, also known as the customer identifier. Example: c4b210e9-be39-4ebc-8195-0c422de87f90 |
| id | string <uuid> Customer Id | |||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantId | string <uuid> Merchant Id | |||||||||||||||||||||||||||||||||||||||||||||||||||
| firstName | string or null Indicates the customer's first name. Example: Alexandro | |||||||||||||||||||||||||||||||||||||||||||||||||||
| lastName | string Indicates the customer's last name. Example: Peppared | |||||||||||||||||||||||||||||||||||||||||||||||||||
| companyName | string or null Indicates the customer's company name. Example: Peppared Street Cafe | |||||||||||||||||||||||||||||||||||||||||||||||||||
string or null Indicates the customer's email. Example: peppared@example.com | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| mobilePhoneNumber | string or null <E.164> <= 20 characters ^(null|\+\d{1,20})$ Indicates the customer's mobile phone number. Example: +14155552309 | |||||||||||||||||||||||||||||||||||||||||||||||||||
| isMobileNumberSmsNotificationsEnabled | boolean Indicates the customer's SMS notification is enabled. If Example: true | |||||||||||||||||||||||||||||||||||||||||||||||||||
| useBillingAsShippingAddress | boolean Indicates to use the billing address as the shipping address. If Example: true | |||||||||||||||||||||||||||||||||||||||||||||||||||
| defaultPaymentMethodId | string or null <uuid> Default payment method Id | |||||||||||||||||||||||||||||||||||||||||||||||||||
| defaultAchPaymentMethodId | string or null <uuid> Default payment method identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||
| createdOn | string <date-time> Indicates the date the customer was created on (in an ISO 8601 date-time format). Examples: | |||||||||||||||||||||||||||||||||||||||||||||||||||
| modifiedOn | string <date-time> Indicates the date the customer information was last modified on (in an ISO 8601 date-time format). Examples: | |||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Customers.Common.AddressDto) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Customers.Common.AddressDto) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
| lastTransactionDate | string or null <date-time> Indicates the the Last transaction date (in an ISO 8601 date-time format). Examples: | |||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionsCount | integer <int32> Transactions count | |||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionsVolume | number <double> Transactions volume | |||||||||||||||||||||||||||||||||||||||||||||||||||
| lastTransactionAmount | number or null <double> Last transaction amount | |||||||||||||||||||||||||||||||||||||||||||||||||||
| numberOfSubscriptions | integer <int32> Count of active subscriptions | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects or null (PaymentGateway.Contracts.Customers.Get.GetCustomerResponseDto.PaymentMethodCardDto) Payment methods | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects or null (PaymentGateway.Contracts.Customers.Get.GetCustomerResponseDto.PaymentMethodAchAccountDto) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "firstName": "string",
- "lastName": "Peppared",
- "companyName": "Example: Peppared Street Cafe",
- "email": "peppared@example.com",
- "mobilePhoneNumber": "+14155552309",
- "isMobileNumberSmsNotificationsEnabled": true,
- "useBillingAsShippingAddress": true,
- "defaultPaymentMethodId": "10098869-575b-49ae-a0bc-197f04f0018a",
- "defaultAchPaymentMethodId": "d193eb46-976d-4274-b4e4-18dbd12acd3a",
- "createdOn": "2025-01-27T12:05:54.322587+05:30",
- "modifiedOn": "2025-01-27T12:05:54.322587+05:30",
- "billingAddress": {
- "addressLine1": "21 E. Main Street",
- "addressLine2": "Office 3",
- "city": "Chicago",
- "zip": "60612",
- "stateName": "string",
- "state": {
- "id": 0,
- "code": "TX",
- "name": "string"
}, - "country": {
- "id": 0,
- "isoCode": "string",
- "name": "string"
}
}, - "shippingAddress": {
- "addressLine1": "21 E. Main Street",
- "addressLine2": "Office 3",
- "city": "Chicago",
- "zip": "60612",
- "stateName": "string",
- "state": {
- "id": 0,
- "code": "TX",
- "name": "string"
}, - "country": {
- "id": 0,
- "isoCode": "string",
- "name": "string"
}
}, - "lastTransactionDate": "2025-01-27T12:05:54.322587+05:30",
- "transactionsCount": 0,
- "transactionsVolume": 0.1,
- "lastTransactionAmount": 0.1,
- "numberOfSubscriptions": 0,
- "cards": [
- {
- "id": "db02ec6c-2e5a-4b87-98a0-8dd881707d84",
- "name": "string",
- "isDefault": true,
- "panMask": "string",
- "expirationMonth": 0,
- "expirationYear": 0,
- "cardTokenType": 2,
- "cardType": 1,
- "creditDebitType": 1
}
], - "achAccounts": [
- {
- "id": "db02ec6c-2e5a-4b87-98a0-8dd881707d84",
- "name": "string",
- "isDefault": true,
- "accountNumber": "5413591081013511",
- "routingNumber": "string",
- "accountTypeId": 0,
- "accountType": "string",
- "accountHolderTypeId": 0,
- "accountHolderType": "string",
- "taxId": "string"
}
]
}PUT {{baseURL}}/pay-api/v1/customers/{{customerId}}
This endpoint updates the specified customer's information.
Care must be taken to complete all the fields with the existing information.
See Also:
To search for a customer, see GET /pay-api/v1/customers
To find a customer by identifier, see GET /pay-api/v1/customers/{{customerId}}
To create a customer, see POST /pay-api/v1/customers
To delete a customer, see DELETE /pay-api/v1/customers/{{customerId}}
| customerId required | string <uuid> Example: c4b210e9-be39-4ebc-8195-0c422de87f90 Specifies the customerId, also known as the customer identifier. Example: c4b210e9-be39-4ebc-8195-0c422de87f90 |
| firstName required | string Specifies the customer's first name. Example: Alexandro | ||||||||||||||
| lastName required | string Specifies the customer's last name. Example: Peppared | ||||||||||||||
| companyName | string or null Specifies the customer's company name. Example: Peppared Street Cafe | ||||||||||||||
string or null Specifies the customer's email Example: peppared@example.com | |||||||||||||||
| mobilePhoneNumber | string or null <E.164> <= 20 characters ^(null|\+\d{1,20})$ Specifies the customer's mobile phone number. Example: +14155552309 | ||||||||||||||
| isMobileNumberSmsNotificationsEnabled | boolean Specifies the customer's SMS notification is enabled. If Example: true | ||||||||||||||
| useBillingAsShippingAddress | boolean Specifies to use the billing address as the shipping address. If Example: true | ||||||||||||||
object (PaymentGateway.Contracts.Customers.Update.UpdateCustomerRequestDto.AddressDto) Specifies an object for a street address. | |||||||||||||||
| |||||||||||||||
object (PaymentGateway.Contracts.Customers.Update.UpdateCustomerRequestDto.AddressDto) Specifies an object for a street address. | |||||||||||||||
| |||||||||||||||
{- "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
}
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69",
- "entityId": null,
- "errorCode": null
}DELETE {{baseURL}}/pay-api/v1/customers/{{customerId}}
This endpoint deletes the specified customer.
See Also:
To search for a customer, see GET /pay-api/v1/customers
To update a customer's information, see PUT /pay-api/v1/customers/{{customerId}}
To create a customer, see POST /pay-api/v1/customers
To delete a customer, see DELETE /pay-api/v1/customers/{{customerId}}
| customerId required | string <uuid> Example: c4b210e9-be39-4ebc-8195-0c422de87f90 Specifies the customerId, also known as the customer identifier. Example: c4b210e9-be39-4ebc-8195-0c422de87f90 |
{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81",
- "entityId": null,
- "errorCode": null
}POST {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods/cards
| customerId required | string <uuid> Example: c4b210e9-be39-4ebc-8195-0c422de87f90 Specifies the customerId, also known as the customer identifier. Example: c4b210e9-be39-4ebc-8195-0c422de87f90 |
| name | string or null Payment method name |
| pan required | string non-empty PAN |
| expirationMonth required | integer <int32> Expiration month |
| expirationYear required | integer <int32> Expiration year |
| securityCode | string or null Security code |
| id | string <uuid> Indicates the payment method identifier. This is also known the Example: db02ec6c-2e5a-4b87-98a0-8dd881707d84 |
{- "name": "Payment_method",
- "pan": "444466666655555",
- "expirationMonth": 1,
- "expirationYear": 24,
- "securityCode": "345"
}{- "id": "db02ec6c-2e5a-4b87-98a0-8dd881707d84"
}POST {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods/ach
This endpoint adds a payment method for EFT or ACH (automated clearing house) transactions.
The endpoint call, with a fictitious customerId:
POST {{baseURL}}/pay-api/v1/customers/019d2135-be3f-7310-8e03-0bece14c231b/payment-methods/ach
The endpoint request body:
{
"accountNumber": "123456789",
"routingNumber": "123123123",
"accountType": 1,
"accountHolderType": 1
}
The return value is the paymentMethodId (payment method identifier).
{
"id": "ecb05a38-990a-46fb-9a37-b0359164d918"
}
See Also:
To add a payment method for other transaction types, see GET /pay-api/v1/customers/{{customerId}}/payment-methods
To update a payment method, see PUT /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}
To delete a payment method, see DELETE /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}
To set a default payment method, see PUT /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}/make-default
| customerId required | string <uuid> Example: c4b210e9-be39-4ebc-8195-0c422de87f90 Specifies a single customer's identifier. |
| accountNumber required | string or null Specifies the account number. Example: 123456789 | |||||||||
| routingNumber required | string non-empty Specifies the routing number. Example: 123123123 | |||||||||
| accountType required | integer <int32> (PaymentGateway.Contracts.Enums.AccountType) Identifies the account type. Possible values:
Example: 1 | |||||||||
| accountHolderType required | integer <int32> (PaymentGateway.Contracts.Enums.AccountHolderType) Identifies the account holder type. Possible values:
Example: 1 | |||||||||
| name | string Specifies the payment method name. This is a free-formed name that is convenient for the merchant to recognize. Example: Peppared Street Cafe's Preferred Payment | |||||||||
| taxId | string or null Specifies the customer's TIN (tax identifier number). Example: 98-7654321 |
| id | string <uuid> Indicates the payment method identifier. This is also known the Example: db02ec6c-2e5a-4b87-98a0-8dd881707d84 |
{- "accountNumber": "123456789",
- "routingNumber": "123123123",
- "accountType": 1,
- "accountHolderType": 1,
- "name": "Peppared Street Cafe's Preferred Payment",
- "taxId": "98-7654321"
}{- "id": "db02ec6c-2e5a-4b87-98a0-8dd881707d84"
}GET {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods
This endpoint searches the partner's customer's payment methods.
| customerId required | string <uuid> Example: c4b210e9-be39-4ebc-8195-0c422de87f90 Specifies a customer's identifier. |
| search | string Example: search=Conners Electric Specifies the search string. The 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 firstName Example: Conners Electric |
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| dateFrom | string <date-time> Example: dateFrom=2025-01-27T12:05:54.322587+05:30 Specifies returning items on or after this date (in an ISO 8601 date-time UTC or time zone offset format). If Examples: |
| dateTo | string <date-time> Example: dateTo=2025-01-27T12:05:54.322587+05:30 Specifies returning items on or to this date (in an ISO 8601 date-time UTC or time zone offset format). If Examples: |
Array of objects or null (PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.GetCustomerPaymentMethods.GetCustomerPaymentMethodsResponse) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| total | integer <int32> Indicates the total number of payment methods found. Example: 7 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "items": [
- {
- "id": "09af9936-08ec-4235-8386-b8d341cc88e7",
- "name": "Peppared Street Cafe's Preferred Payment",
- "panMask": "514631******0055",
- "isDefault": true,
- "typeId": 2,
- "typeName": "ElectronicCheck",
- "expirationMonth": 7,
- "expirationYear": 2032,
- "createdOn": "2025-01-27T12:05:54.322587+05:30",
- "accountNumber": "123456789",
- "routingNumber": "123123123",
- "accountType": 1,
- "accountHolderType": 1,
- "taxId": "98-7654321",
- "cardTokenType": 2
}
], - "total": 7
}PUT {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}
This endpoint updates the specified customer's payment method.
Only the payment method name may be changed with this endpoint. If a different payment method type is required, a new payment method identifier must be created.
Care must be taken to complete all the fields with the existing information.See Also:
To add a EFT or ACH payment method for EFT or ACH transactions, see POST /pay-api/v1/customers/{{customerId}}/payment-methods/ach
To list a customer payment methods, see GET /pay-api/v1/customers/{{customerId}}/payment-methods
To delete a payment method, see DELETE /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}
To set a default payment method, see PUT /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}/make-default
| customerId required | string <uuid> Example: c4b210e9-be39-4ebc-8195-0c422de87f90 Specifies the customerId, also known as the customer identifier. Example: c4b210e9-be39-4ebc-8195-0c422de87f90 |
| paymentMethodId required | string <uuid> Example: 46e5de89-a9f0-4d79-9350-b612bfa3c5ee Specifies the payment method identifier. |
| name | string Specifies the payment method name. This is a free-formed name that is convenient for the merchant to recognize. Example: Cafe Peppared |
{- "name": "Payment_Method"
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81",
- "entityId": null,
- "errorCode": null
}DELETE {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}
This endpoint deletes the specified payment method.
See Also:
To add a EFT or ACH payment method for EFT or ACH transactions, see POST /pay-api/v1/customers/{{customerId}}/payment-methods/ach
To add a payment method for other transaction types, see GET /pay-api/v1/customers/{{customerId}}/payment-methods
To update a payment method, see PUT /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}
| customerId required | string <uuid> Example: c4b210e9-be39-4ebc-8195-0c422de87f90 Specifies the customerId, also known as the customer identifier. Example: c4b210e9-be39-4ebc-8195-0c422de87f90 |
| paymentMethodId required | string <uuid> Example: 46e5de89-a9f0-4d79-9350-b612bfa3c5ee Specifies the payment method identifier. |
{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
- "entityId": null,
- "errorCode": null
}PUT {{baseURL}}/pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}/make-default
This endpoint sets the specified payment method as the default.
See Also:
To add a EFT or ACH payment method for EFT or ACH transactions, see POST /pay-api/v1/customers/{{customerId}}/payment-methods/ach
To add a payment method for other transaction types, see GET /pay-api/v1/customers/{{customerId}}/payment-methods
To update a payment method, see PUT /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}
| customerId required | string <uuid> Example: c4b210e9-be39-4ebc-8195-0c422de87f90 Specifies the customerId, also known as the customer identifier. Example: c4b210e9-be39-4ebc-8195-0c422de87f90 |
| paymentMethodId required | string <uuid> Example: 46e5de89-a9f0-4d79-9350-b612bfa3c5ee Specifies the payment method identifier. |
{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69",
- "entityId": null,
- "errorCode": null
}GET {{baseURL}}/pay-api/v1/devices
Array of objects or null (PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceResponse) Indicates a list of devices associated with the current merchant. | |||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||
{- "devices": [
- {
- "deviceId": "7aafd09f-b3e6-43fb-b815-5db3bf7f1451",
- "deviceName": "iPhone12,1",
- "lastLoginAt": "2026-01-19T14:27:02.767105Z",
- "apiKeyName": "Peppared's Cafe Key",
- "tapToPayStatus": "Active",
- "tapToPayStatusId": 2,
- "tapToPayEnabled": true,
- "userProfiles": [
- {
- "id": "04103b7f-c2fc-444b-b1ab-93eee3aec815",
- "firstName": "Alexandro",
- "lastName": "Peppared",
- "email": "peppared@example.com"
}
]
}
]
}POST {{baseURL}}/pay-api/v1/devices
| deviceId | string or null Device Id |
| deviceName | string or null Device name |
| deviceId | string or null Device Id |
{- "deviceId": "string",
- "deviceName": "string"
}{- "deviceId": "string"
}GET {{baseURL}}/pay-api/v1/devices/{{deviceId}}
| deviceId required | string <uuid> |
| deviceId | string or null <uuid> Indicates the device identifier. Example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1451 | ||||||||||||
| deviceName | string or null Indicates the device name. Example: iPhone12,1 | ||||||||||||
| lastLoginAt | string <date-time> Indicates the last login time (in IS0 8601 UTC time). Example: 2026-01-19T14:27:02.767105Z | ||||||||||||
| apiKeyName | string or null Indicates the API key name being used. Example: Peppared's Cafe Key | ||||||||||||
| tapToPayStatus | string or null Indicates the tap to pay status. Valid values are:
Example: Active | ||||||||||||
| tapToPayStatusId | integer <int32> Indicates the tap to pay status identifier. Valid values are:
Example: 2 | ||||||||||||
| tapToPayEnabled | boolean Indicates tap to pay feature is enabled. If Example: true | ||||||||||||
Array of objects or null (PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceUserResponse) Profiles associated with this device | |||||||||||||
Array
| |||||||||||||
{- "deviceId": "7aafd09f-b3e6-43fb-b815-5db3bf7f1451",
- "deviceName": "iPhone12,1",
- "lastLoginAt": "2026-01-19T14:27:02.767105Z",
- "apiKeyName": "Peppared's Cafe Key",
- "tapToPayStatus": "Active",
- "tapToPayStatusId": 2,
- "tapToPayEnabled": true,
- "userProfiles": [
- {
- "id": "04103b7f-c2fc-444b-b1ab-93eee3aec815",
- "firstName": "Alexandro",
- "lastName": "Peppared",
- "email": "peppared@example.com"
}
]
}POST {{baseURL}}/pay-api/v1/devices/tap-to-pay/jwt
| deviceId | string or null Device Id |
| jwtToken | string or null The generated JWT for Tap-to-Pay. |
| expiresAt | string <date-time> Indicates the expiration date-time (in IS0 8601 UTC time) of the token. Example: 2026-01-19T14:27:02.767105Z |
{- "deviceId": "string"
}{- "jwtToken": "string",
- "expiresAt": "2026-01-19T14:27:02.767105Z"
}POST {{baseURL}}/pay-api/v1/devices/{{deviceId}}/tap-to-pay/activate
| deviceId required | string <uuid> |
{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70",
- "entityId": null,
- "errorCode": null
}POST {{baseURL}}/pay-int-api/invoices
| x-api-version | string |
The invoice creation request.
| dueDate | string or null <date-time> (invoice_duedate) Specifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) the invoice is due. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||
| cardPaymentProcessorId | string or null <uuid> (cardPaymentProcessorid) Specifies an identifier for the payment processor handling a card transaction. Example: 78723ff2-d47e-460b-b838-d602bdf0e1bc | ||||||||||||||||||||||||||||||||||||||||||||||||||
| achPaymentProcessorId | string or null <uuid> (ach_paymentrocessorid) Specifies an identifier for the automated clearing house (ACH) payment processor handling a transaction. Example: 9925a0b0-eb18-4d74-8967-7e0cf6af0729 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| additionalNotes | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingAmount | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| taxPercentage | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| feesPercentage | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| discountPercentage | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantContactInfoId | string or null <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| achAllowFasterProcessing | boolean or null | ||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects or null (PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||
| canPriceBeForceOverrided | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||
| id | string <uuid> |
{- "dueDate": "2026-02-19T20:24:52.934+05:30",
- "cardPaymentProcessorId": "78723ff2-d47e-460b-b838-d602bdf0e1bc",
- "achPaymentProcessorId": "9925a0b0-eb18-4d74-8967-7e0cf6af0729",
- "additionalNotes": "string",
- "shippingAmount": 0.1,
- "taxPercentage": 0.1,
- "feesPercentage": 0.1,
- "discountPercentage": 0.1,
- "merchantContactInfoId": "f5d826ad-fdaf-44d6-8e8e-3260a44e8639",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "achAllowFasterProcessing": true,
- "customer": {
- "firstName": "Alexandro",
- "lastName": "Peppared",
- "companyName": "string",
- "email": "peppared@example.com",
- "mobilePhoneNumber": "+14155552309",
- "isMobileNumberSmsNotificationsEnabled": true,
- "useBillingAsShippingAddress": true,
- "billingAddress": {
- "line1": "21 E. Main Street",
- "line2": "Apt. Block 6",
- "city": "Chicago",
- "zip": "60612",
- "countryId": 1,
- "stateId": 1,
- "stateName": "TX"
}, - "shippingAddress": {
- "line1": "21 E. Main Street",
- "line2": "Apt. Block 6",
- "city": "Chicago",
- "zip": "60612",
- "countryId": 1,
- "stateId": 1,
- "stateName": "TX"
}
}, - "lineItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lineItemId": "ecf65d8c-fd37-452f-82f1-ff563e6f910f",
- "unitTypeId": 0,
- "productName": "string",
- "description": "string",
- "sku": "string",
- "unitPrice": 0.1,
- "quantity": 0.1,
- "discountPercentage": 0.1,
- "totalAmount": 3219.45
}
], - "canPriceBeForceOverrided": true
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}GET {{baseURL}}/pay-int-api/invoices
| issueDateFrom | string <date-time> | ||||||||||||||||
| issueDateTo | string <date-time> | ||||||||||||||||
| dueDateFrom | string <date-time> | ||||||||||||||||
| dueDateTo | string <date-time> | ||||||||||||||||
| paymentDateFrom | string <date-time> | ||||||||||||||||
| paymentDateTo | string <date-time> | ||||||||||||||||
| status | integer <int32> (PaymentIntegrations.Contracts.Enums.InvoiceStatus) Example: status=2 Possible values:
Example: 2 | ||||||||||||||||
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 | ||||||||||||||||
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 | ||||||||||||||||
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true | ||||||||||||||||
| search | string |
| x-api-version | string |
Array of objects or null (PaymentIntegrations.Contracts.Invoices.Get.GetInvoicesResponseDto) | |||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||
| total | integer <int32> | ||||||||||||||||||||||||||||||||
{- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": "string",
- "customerName": "string",
- "issueDate": "2026-02-19T20:24:52.934+05:30",
- "dueDate": "2026-02-19T20:24:52.934+05:30",
- "paymentDate": "2026-02-19T20:24:52.934+05:30",
- "totalAmount": 3219.45,
- "status": 2
}
], - "total": 0
}GET {{baseURL}}/pay-int-api/invoices/{{invoiceId}}
| invoiceId required | string <uuid> The identifier of the invoice to retrieve. |
| x-api-version | string |
| id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| number | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | integer <int32> (PaymentIntegrations.Contracts.Enums.InvoiceStatus) Possible values:
Example: 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| issueDate | string or null <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the invoice's issue. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dueDate | string or null <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the invoice due date. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| paymentDate | string or null <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the invoice payment. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cardPaymentProcessorId | string or null <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| achPaymentProcessorId | string or null <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| additionalNotes | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subTotalAmount | number <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingAmount | number <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| totalAmount | number <double> Specifies the transaction's total amount. This includes the base amount, tips, taxes, discounts, and other charges. Example: 3219.45 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| taxPercentage | number <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| feesPercentage | number <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| discountPercentage | number <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| surchargeAmount | number <double> Identifies the amount (in USD) when a surcharge is applicable. This is a surcharge on the base amount.
This surcharge was calculated using the preset percentage from Example: 6.45 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| surchargePercentage | number <double> Identifies the surcharge percentage. This is a surcharge on the base amount.
This value is surcharge percentage rate.
This surcharge percentage calculates the surcharge amount for Example: 1.5 (as 1.5%) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cashDiscountAmount | number <double> Identifies the discount amount (in USD) when a cash (or cash-equivalent) discount is applied. This discount was calculated using the preset percentage from Example: 10.55 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cashDiscountPercentage | number <double> Identifies the discount percentage for a cash (or cash-equivalent) discount. This value is percentage rate for the discount.
This discount percentage calculates the discount amount for Example: 1.5 (as 1.5%) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| paymentMethodTypeId | integer or null <int32> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantId | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantContactInfoId | string or null <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentIntegrations.Contracts.Invoices.InvoiceMerchantContactInfoDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects or null (PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isCustomerUpdated | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isLineItemsUpdated | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fullUrl | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shortUrl | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| markedAsPaid | boolean or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionId | string or null <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| achAllowFasterProcessing | boolean or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects or null (PaymentIntegrations.Contracts.Invoices.InvoiceHistoryDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| zeroCostProcessingOptionId | integer or null <int32> ZCP Option Id Available when invoice is in Published or Paid status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| zeroCostProcessingOption | string or null Specifies using the type of zero cost processing. Zero cost processing has the customer covering the card fees and not the merchant. Available when invoice is in Possible values:
Example: DualPricing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| useCardPrice | boolean or null Available for ZCP Option == Dual pricing only, when invoice is in Published or Paid status true - dual pricing, use card price false - dual pricing, use cash price null - other ZCP option | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceCalculationsDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": "string",
- "status": 2,
- "issueDate": "2026-02-19T20:24:52.934+05:30",
- "dueDate": "2026-02-19T20:24:52.934+05:30",
- "paymentDate": "2026-02-19T20:24:52.934+05:30",
- "cardPaymentProcessorId": "db82121d-3317-4452-ab36-552196b0f55a",
- "achPaymentProcessorId": "7795a840-221a-45e0-9419-a69eaa3463ff",
- "additionalNotes": "string",
- "subTotalAmount": 0.1,
- "shippingAmount": 0.1,
- "totalAmount": 3219.45,
- "taxPercentage": 0.1,
- "feesPercentage": 0.1,
- "discountPercentage": 0.1,
- "surchargeAmount": 6.45,
- "surchargePercentage": 1.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountPercentage": 1.5,
- "paymentMethodTypeId": 0,
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "merchantContactInfoId": "f5d826ad-fdaf-44d6-8e8e-3260a44e8639",
- "merchantContactInfo": {
- "addressLine1": "21 E. Main Street",
- "addressLine2": "Office 3",
- "city": "Chicago",
- "zip": "60612",
- "countryId": 1,
- "stateId": 4,
- "stateName": "TX",
- "email": "peppared@example.com",
- "businessPhoneNumber": "+14155552309"
}, - "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "customer": {
- "firstName": "Alexandro",
- "lastName": "Peppared",
- "companyName": "string",
- "email": "peppared@example.com",
- "mobilePhoneNumber": "+14155552309",
- "isMobileNumberSmsNotificationsEnabled": true,
- "useBillingAsShippingAddress": true,
- "billingAddress": {
- "line1": "21 E. Main Street",
- "line2": "Apt. Block 6",
- "city": "Chicago",
- "zip": "60612",
- "countryId": 1,
- "stateId": 1,
- "stateName": "TX"
}, - "shippingAddress": {
- "line1": "21 E. Main Street",
- "line2": "Apt. Block 6",
- "city": "Chicago",
- "zip": "60612",
- "countryId": 1,
- "stateId": 1,
- "stateName": "TX"
}
}, - "lineItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lineItemId": "ecf65d8c-fd37-452f-82f1-ff563e6f910f",
- "unitTypeId": 0,
- "productName": "string",
- "description": "string",
- "sku": "string",
- "unitPrice": 0.1,
- "quantity": 0.1,
- "discountPercentage": 0.1,
- "totalAmount": 3219.45
}
], - "isCustomerUpdated": true,
- "isLineItemsUpdated": true,
- "fullUrl": "string",
- "shortUrl": "string",
- "markedAsPaid": true,
- "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
- "achAllowFasterProcessing": true,
- "history": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
- "typeId": 0,
- "typeName": "string",
- "errorCode": "string",
- "errorMessage": "string",
- "notificationId": "2d591c23-85b1-4e8c-a6bd-74d89f8955c5",
- "notificationType": "string",
- "notificationTypeId": 0,
- "notificationTemplateType": "string",
- "notificationTemplateTypeId": 0,
- "notificationTarget": "string",
- "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
- "paymentMethodTypeId": 0,
- "createdOn": "2026-02-19T20:24:52.934+05:30"
}
], - "zeroCostProcessingOptionId": 0,
- "zeroCostProcessingOption": "DualPricing",
- "useCardPrice": true,
- "invoiceCalculations": {
- "debitCard": {
- "subTotalAmount": 0.1,
- "totalAmount": 3219.45,
- "shippingAmount": 0.1,
- "taxAmount": 0.1,
- "taxPercentage": 0.1,
- "feesAmount": 0.1,
- "feesPercentage": 0.1,
- "discountAmount": 0.1,
- "discountPercentage": 0.1,
- "surchargeAmount": 6.45,
- "surchargePercentage": 1.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountPercentage": 1.5
}, - "creditCard": {
- "subTotalAmount": 0.1,
- "totalAmount": 3219.45,
- "shippingAmount": 0.1,
- "taxAmount": 0.1,
- "taxPercentage": 0.1,
- "feesAmount": 0.1,
- "feesPercentage": 0.1,
- "discountAmount": 0.1,
- "discountPercentage": 0.1,
- "surchargeAmount": 6.45,
- "surchargePercentage": 1.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountPercentage": 1.5
}, - "ach": {
- "subTotalAmount": 0.1,
- "totalAmount": 3219.45,
- "shippingAmount": 0.1,
- "taxAmount": 0.1,
- "taxPercentage": 0.1,
- "feesAmount": 0.1,
- "feesPercentage": 0.1,
- "discountAmount": 0.1,
- "discountPercentage": 0.1,
- "surchargeAmount": 6.45,
- "surchargePercentage": 1.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountPercentage": 1.5
}
}
}PUT {{baseURL}}/pay-int-api/invoices/{{invoiceId}}
| invoiceId required | string <uuid> The identifier of the invoice to update. |
| x-api-version | string |
The invoice update request.
| dueDate | string or null <date-time> (invoice_duedate) Specifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) the invoice is due. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||
| cardPaymentProcessorId | string or null <uuid> (cardPaymentProcessorid) Specifies an identifier for the payment processor handling a card transaction. Example: 78723ff2-d47e-460b-b838-d602bdf0e1bc | ||||||||||||||||||||||||||||||||||||||||||||||||||
| achPaymentProcessorId | string or null <uuid> (ach_paymentrocessorid) Specifies an identifier for the automated clearing house (ACH) payment processor handling a transaction. Example: 9925a0b0-eb18-4d74-8967-7e0cf6af0729 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| additionalNotes | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingAmount | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| taxPercentage | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| feesPercentage | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| discountPercentage | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantContactInfoId | string or null <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| achAllowFasterProcessing | boolean or null | ||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects or null (PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||
| canPriceBeForceOverrided | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||
{- "dueDate": "2026-02-19T20:24:52.934+05:30",
- "cardPaymentProcessorId": "78723ff2-d47e-460b-b838-d602bdf0e1bc",
- "achPaymentProcessorId": "9925a0b0-eb18-4d74-8967-7e0cf6af0729",
- "additionalNotes": "string",
- "shippingAmount": 0.1,
- "taxPercentage": 0.1,
- "feesPercentage": 0.1,
- "discountPercentage": 0.1,
- "merchantContactInfoId": "f5d826ad-fdaf-44d6-8e8e-3260a44e8639",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "achAllowFasterProcessing": true,
- "customer": {
- "firstName": "Alexandro",
- "lastName": "Peppared",
- "companyName": "string",
- "email": "peppared@example.com",
- "mobilePhoneNumber": "+14155552309",
- "isMobileNumberSmsNotificationsEnabled": true,
- "useBillingAsShippingAddress": true,
- "billingAddress": {
- "line1": "21 E. Main Street",
- "line2": "Apt. Block 6",
- "city": "Chicago",
- "zip": "60612",
- "countryId": 1,
- "stateId": 1,
- "stateName": "TX"
}, - "shippingAddress": {
- "line1": "21 E. Main Street",
- "line2": "Apt. Block 6",
- "city": "Chicago",
- "zip": "60612",
- "countryId": 1,
- "stateId": 1,
- "stateName": "TX"
}
}, - "lineItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lineItemId": "ecf65d8c-fd37-452f-82f1-ff563e6f910f",
- "unitTypeId": 0,
- "productName": "string",
- "description": "string",
- "sku": "string",
- "unitPrice": 0.1,
- "quantity": 0.1,
- "discountPercentage": 0.1,
- "totalAmount": 3219.45
}
], - "canPriceBeForceOverrided": true
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69",
- "entityId": null,
- "errorCode": null
}DELETE {{baseURL}}/pay-int-api/invoices/{{invoiceId}}
You can't delete published invoices.
| invoiceId required | string <uuid> The identifier of the invoice to delete. |
| x-api-version | string |
{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
- "entityId": null,
- "errorCode": null
}POST {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/submit
| invoiceId required | string <uuid> The identifier of the invoice to submit. |
| x-api-version | string |
The request containing the details for invoice submission.
| totalAmount | number <double> Specifies the transaction's total amount. This includes the base amount, tips, taxes, discounts, and other charges. Example: 3219.45 |
| accountNumber | string or null Specifies the payment target's bank account number. Example: 5413591081013511 |
| expirationYear | integer <int32> |
| expirationMonth | integer <int32> |
| securityCode | string or null |
| billingCountryId | integer <int32> Specifies the Aurora country identifier. Example: 1 |
| billingPostalCode | string or null |
| savePaymentMethod | boolean |
| success | boolean Indicates the payment was successfully submitted. If Example: true |
| paymentMethodCreated | boolean Indicates the payment method was created. If Example: true |
| customerInfoSaved | boolean Indicates the customer info was saved. If Example: true |
{- "totalAmount": 3219.45,
- "accountNumber": "5413591081013511",
- "expirationYear": 0,
- "expirationMonth": 0,
- "securityCode": "string",
- "billingCountryId": 1,
- "billingPostalCode": "string",
- "savePaymentMethod": true
}{- "success": true,
- "paymentMethodCreated": true,
- "customerInfoSaved": true
}POST {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/ach/submit
| invoiceId required | string <uuid> The identifier of the invoice to submit. |
| x-api-version | string |
The request containing the details for invoice submission.
| routingNumber | string or null | ||||||
| accountNumber | string or null | ||||||
| accountType | integer <int32> (PaymentIntegrations.Contracts.Enums.AccountType) Possible values:
Example: 1 | ||||||
| accountHolderType | integer <int32> (PaymentIntegrations.Contracts.Enums.AccountHolderType) Possible values:
Example: 1 | ||||||
| firstName | string Indicates the customer's first name. Example: Alexandro | ||||||
| lastName | string Indicates the customer's last name. Example: Peppared | ||||||
| companyName | string or null Indicates the customer's company name. Example: Peppared Street Cafe | ||||||
string or null Indicates the customer's email. Example: peppared@example.com | |||||||
| mobilePhoneNumber | string or null <E.164> <= 20 characters ^(null|\+\d{1,20})$ Indicates the customer's mobile phone number. Example: +14155552309 | ||||||
| smsNotification | boolean or null Default: false Specifies the customer is sent an SMS notification. If Example: true | ||||||
| addressLine1 | string or null Indicates the street address. Example: 21 E. Main Street | ||||||
| addressLine2 | string or null Specifies additional street address information. Example: Office 3 | ||||||
| city | string or null Specifies the name of the city. Example: Chicago | ||||||
| stateId | integer <int32> Specifies the Aurora US state or territory identifier code. Example: 4 | ||||||
| billingPostalCode | string or null Specifies the billing postal or ZIP code. Examples: | ||||||
| savePaymentMethod | boolean | ||||||
| authorizeBankWithdrawal | boolean | ||||||
| authorizationConsentTimestamp | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when customer checked the authorization checkbox. This is required for ACH compliance audit logging. Examples: |
| success | boolean Indicates the payment was successfully submitted. If Example: true |
| paymentMethodCreated | boolean Indicates the payment method was created. If Example: true |
| customerInfoSaved | boolean Indicates the customer info was saved. If Example: true |
{- "routingNumber": "string",
- "accountNumber": "string",
- "accountType": 1,
- "accountHolderType": 1,
- "firstName": "Alexandro",
- "lastName": "Peppared",
- "companyName": "string",
- "email": "peppared@example.com",
- "mobilePhoneNumber": "+14155552309",
- "smsNotification": true,
- "addressLine1": "21 E. Main Street",
- "addressLine2": "Office 3",
- "city": "Chicago",
- "stateId": 4,
- "billingPostalCode": "60612",
- "savePaymentMethod": true,
- "authorizeBankWithdrawal": true,
- "authorizationConsentTimestamp": "2026-02-19T20:24:52.934+05:30"
}{- "success": true,
- "paymentMethodCreated": true,
- "customerInfoSaved": true
}GET {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/calculations
| invoiceId required | string <uuid> The identifier of the invoice. |
| x-api-version | string |
| id | string <uuid> |
| subTotalAmount | number <double> |
| shippingAmount | number <double> |
| taxPercentage | number <double> |
| taxAmount | number <double> |
| feesPercentage | number <double> |
| feesAmount | number <double> |
| discountPercentage | number <double> |
| discountAmount | number <double> |
| surchargeAmount | number <double> Identifies the amount (in USD) when a surcharge is applicable. This is a surcharge on the base amount.
This surcharge was calculated using the preset percentage from Example: 6.45 |
| surchargePercentage | number or null <double> Identifies the surcharge percentage. This is a surcharge on the base amount.
This value is surcharge percentage rate.
This surcharge percentage calculates the surcharge amount for Example: 1.5 (as 1.5%) |
| totalAmount | number <double> Specifies the transaction's total amount. This includes the base amount, tips, taxes, discounts, and other charges. Example: 3219.45 |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subTotalAmount": 0.1,
- "shippingAmount": 0.1,
- "taxPercentage": 0.1,
- "taxAmount": 0.1,
- "feesPercentage": 0.1,
- "feesAmount": 0.1,
- "discountPercentage": 0.1,
- "discountAmount": 0.1,
- "surchargeAmount": 6.45,
- "surchargePercentage": 1.5,
- "totalAmount": 3219.45
}POST {{baseURL}}/pay-int-api/invoices/publish
| x-api-version | string |
The request containing the details for publishing the invoice.
| dueDate | string or null <date-time> (invoice_duedate) Specifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) the invoice is due. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||
| cardPaymentProcessorId | string or null <uuid> (cardPaymentProcessorid) Specifies an identifier for the payment processor handling a card transaction. Example: 78723ff2-d47e-460b-b838-d602bdf0e1bc | ||||||||||||||||||||||||||||||||||||||||||||||||||
| achPaymentProcessorId | string or null <uuid> (ach_paymentrocessorid) Specifies an identifier for the automated clearing house (ACH) payment processor handling a transaction. Example: 9925a0b0-eb18-4d74-8967-7e0cf6af0729 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| additionalNotes | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingAmount | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| taxPercentage | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| feesPercentage | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| discountPercentage | number or null <double> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantContactInfoId | string or null <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| achAllowFasterProcessing | boolean or null | ||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects or null (PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||
| canPriceBeForceOverrided | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||
| id | string or null <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||
| id | string <uuid> |
{- "dueDate": "2026-02-19T20:24:52.934+05:30",
- "cardPaymentProcessorId": "78723ff2-d47e-460b-b838-d602bdf0e1bc",
- "achPaymentProcessorId": "9925a0b0-eb18-4d74-8967-7e0cf6af0729",
- "additionalNotes": "string",
- "shippingAmount": 0.1,
- "taxPercentage": 0.1,
- "feesPercentage": 0.1,
- "discountPercentage": 0.1,
- "merchantContactInfoId": "f5d826ad-fdaf-44d6-8e8e-3260a44e8639",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "achAllowFasterProcessing": true,
- "customer": {
- "firstName": "Alexandro",
- "lastName": "Peppared",
- "companyName": "string",
- "email": "peppared@example.com",
- "mobilePhoneNumber": "+14155552309",
- "isMobileNumberSmsNotificationsEnabled": true,
- "useBillingAsShippingAddress": true,
- "billingAddress": {
- "line1": "21 E. Main Street",
- "line2": "Apt. Block 6",
- "city": "Chicago",
- "zip": "60612",
- "countryId": 1,
- "stateId": 1,
- "stateName": "TX"
}, - "shippingAddress": {
- "line1": "21 E. Main Street",
- "line2": "Apt. Block 6",
- "city": "Chicago",
- "zip": "60612",
- "countryId": 1,
- "stateId": 1,
- "stateName": "TX"
}
}, - "lineItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lineItemId": "ecf65d8c-fd37-452f-82f1-ff563e6f910f",
- "unitTypeId": 0,
- "productName": "string",
- "description": "string",
- "sku": "string",
- "unitPrice": 0.1,
- "quantity": 0.1,
- "discountPercentage": 0.1,
- "totalAmount": 3219.45
}
], - "canPriceBeForceOverrided": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}PUT {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/cancel
Only invoices in published(Due, Past Due) status and not paid can be canceled.
| invoiceId required | string <uuid> The identifier of the invoice to cancel. |
| x-api-version | string |
{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70",
- "entityId": null,
- "errorCode": null
}PUT {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/mark-as-paid
Only invoices in published(Due, Past Due) status and not paid can be marked as paid.
| invoiceId required | string <uuid> The identifier of the invoice to mark as paid. |
| x-api-version | string |
The request containing the payment details.
| paymentMethodTypeId | integer or null <int32> |
{- "paymentMethodTypeId": 0
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92",
- "entityId": null,
- "errorCode": null
}POST {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/send-email-notification
| invoiceId required | string <uuid> The identifier of the invoice for which to send the notification. |
| x-api-version | string |
The request containing the details for the SMS notification.
| phoneNumber | string or null <E.164> <= 20 characters ^(null|\+\d{1,20})$ Indicates the SMS phone number. Example: +14155552309 |
| customerConsent | boolean Identifies the customer has consented to receiving the SMS. If Example: true |
{- "phoneNumber": "+14155552309",
- "customerConsent": true
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
- "entityId": null,
- "errorCode": null
}GET {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/download-pdf
Available only for published invoices.
| invoiceId required | string <uuid> The identifier of the invoice. |
| x-api-version | string |
"string"POST {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/send-published-sms-notification
| invoiceId required | string <uuid> The identifier of the invoice for which to send the notification. |
| x-api-version | string |
The request containing the details for the Email notification.
| receiverEmail | string or null |
| customerConsent | boolean Identifies the customer has consented to receiving the SMS. If Example: true |
{- "receiverEmail": "string",
- "customerConsent": true
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
- "entityId": null,
- "errorCode": null
}GET {{baseURL}}/pay-int-api/merchants/{{merchantId}}/invoices/settings
| merchantId required | string <uuid> Example: 46063d32-10fa-44cb-b118-20ddd085ce3f Specifies the identifier of the merchant. |
| x-api-version | string |
| merchantId | string <uuid> |
| dueDateAfterDays | integer or null <int32> |
| taxPercentage | number or null <double> |
| isDiscountEnabled | boolean |
| discountPercentage | number or null <double> |
| isShippingFeeEnabled | boolean |
| shippingFeeAmount | number or null <double> |
| isFeesEnabled | boolean |
| feesPercentage | number or null <double> |
| notes | string or null |
| paymentMethodTypeId | integer <int32> |
| cardPaymentProcessorId | string or null <uuid> (cardPaymentProcessorid) Specifies an identifier for the payment processor handling a card transaction. Example: 78723ff2-d47e-460b-b838-d602bdf0e1bc |
| achPaymentProcessorId | string or null <uuid> (ach_paymentrocessorid) Specifies an identifier for the automated clearing house (ACH) payment processor handling a transaction. Example: 9925a0b0-eb18-4d74-8967-7e0cf6af0729 |
| allowStaffToSetDiscountAndLineItemDiscount | boolean |
| allowManuallyEnterLineItems | boolean |
| isSmsNotificationAfterPaymentEnabled | boolean |
| isSmsNotificationAfterPaymentFailedEnabled | boolean |
| canOverWriteInvoiceLineItemPrice | boolean |
| newZcpFeatureEnabled | boolean |
{- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "dueDateAfterDays": 0,
- "taxPercentage": 0.1,
- "isDiscountEnabled": true,
- "discountPercentage": 0.1,
- "isShippingFeeEnabled": true,
- "shippingFeeAmount": 0.1,
- "isFeesEnabled": true,
- "feesPercentage": 0.1,
- "notes": "string",
- "paymentMethodTypeId": 0,
- "cardPaymentProcessorId": "78723ff2-d47e-460b-b838-d602bdf0e1bc",
- "achPaymentProcessorId": "9925a0b0-eb18-4d74-8967-7e0cf6af0729",
- "allowStaffToSetDiscountAndLineItemDiscount": true,
- "allowManuallyEnterLineItems": true,
- "isSmsNotificationAfterPaymentEnabled": true,
- "isSmsNotificationAfterPaymentFailedEnabled": true,
- "canOverWriteInvoiceLineItemPrice": true,
- "newZcpFeatureEnabled": true
}PUT {{baseURL}}/pay-int-api/merchants/{{merchantId}}/invoices/settings
| merchantId required | string <uuid> Example: 46063d32-10fa-44cb-b118-20ddd085ce3f Specifies the identifier of the merchant. |
| x-api-version | string |
The invoice settings update request.
| dueDateAfterDays | integer or null <int32> |
| taxPercentage | number or null <double> |
| isDiscountEnabled | boolean |
| discountPercentage | number or null <double> |
| isShippingFeeEnabled | boolean |
| shippingFeeAmount | number or null <double> |
| isFeesEnabled | boolean |
| feesPercentage | number or null <double> |
| notes | string or null |
| paymentMethodTypeId | integer or null <int32> |
| cardPaymentProcessorId | string or null <uuid> (cardPaymentProcessorid) Specifies an identifier for the payment processor handling a card transaction. Example: 78723ff2-d47e-460b-b838-d602bdf0e1bc |
| achPaymentProcessorId | string or null <uuid> (ach_paymentrocessorid) Specifies an identifier for the automated clearing house (ACH) payment processor handling a transaction. Example: 9925a0b0-eb18-4d74-8967-7e0cf6af0729 |
| allowStaffToSetDiscountAndLineItemDiscount | boolean |
| allowManuallyEnterLineItems | boolean |
| isSmsNotificationAfterPaymentEnabled | boolean |
| isSmsNotificationAfterPaymentFailedEnabled | boolean |
| achAllowFasterProcessing | boolean or null |
| canOverWriteInvoiceLineItemPrice | boolean |
{- "dueDateAfterDays": 0,
- "taxPercentage": 0.1,
- "isDiscountEnabled": true,
- "discountPercentage": 0.1,
- "isShippingFeeEnabled": true,
- "shippingFeeAmount": 0.1,
- "isFeesEnabled": true,
- "feesPercentage": 0.1,
- "notes": "string",
- "paymentMethodTypeId": 0,
- "cardPaymentProcessorId": "78723ff2-d47e-460b-b838-d602bdf0e1bc",
- "achPaymentProcessorId": "9925a0b0-eb18-4d74-8967-7e0cf6af0729",
- "allowStaffToSetDiscountAndLineItemDiscount": true,
- "allowManuallyEnterLineItems": true,
- "isSmsNotificationAfterPaymentEnabled": true,
- "isSmsNotificationAfterPaymentFailedEnabled": true,
- "achAllowFasterProcessing": true,
- "canOverWriteInvoiceLineItemPrice": true
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81",
- "entityId": null,
- "errorCode": null
}POST {{baseURL}}/pay-int-api/line-items
| x-api-version | string |
The line item creation request.
| productName | string or null |
| description | string or null |
| sku | string or null |
| unitPrice | number <double> |
| unitTypeId | integer <int32> |
| categoryId | string or null <uuid> |
| taxRate | number <double> |
| id | string <uuid> |
{- "productName": "string",
- "description": "string",
- "sku": "string",
- "unitPrice": 0.1,
- "unitTypeId": 0,
- "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
- "taxRate": 0.1
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}GET {{baseURL}}/pay-int-api/line-items
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| search | string |
| categoryId | string <uuid> |
| noCategory | boolean |
| x-api-version | string |
Array of objects or null (PaymentIntegrations.Contracts.LineItems.Get.GetLineItemsResponseDto) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
| total | integer <int32> | ||||||||||||||||||||
{- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "unitType": "string",
- "unitTypeId": 0,
- "productName": "string",
- "description": "string",
- "sku": "string",
- "unitPrice": 0.1,
- "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
- "categoryName": "string",
- "categoryDefaultUnitTypeId": 0
}
], - "total": 0
}PUT {{baseURL}}/pay-int-api/line-items/{{lineItemId}}
| lineItemId required | string <uuid> The ID of the line item to update. |
| x-api-version | string |
The line item update request.
| productName | string or null |
| description | string or null |
| sku | string or null |
| unitPrice | number <double> |
| unitTypeId | integer <int32> |
| categoryId | string or null <uuid> |
| taxRate | number <double> |
{- "productName": "string",
- "description": "string",
- "sku": "string",
- "unitPrice": 0.1,
- "unitTypeId": 0,
- "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
- "taxRate": 0.1
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70",
- "entityId": null,
- "errorCode": null
}DELETE {{baseURL}}/pay-int-api/line-items/{{lineItemId}}
| lineItemId required | string <uuid> The ID of the line item to delete. |
| x-api-version | string |
{- "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='<Service>.DataAccess.Entities.<Model>Entity'",
- "statusCode": 404,
- "source": "<Service>",
- "exceptionType": "Exceptions.NotFoundException",
- "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
- "entityId": null,
- "errorCode": null
}GET {{baseURL}}/pay-int-api/line-items/unit-types
| x-api-version | string |
| id | integer <int32> |
| name | string or null |
| abbreviation | string or null |
| category | string or null |
[- {
- "id": 0,
- "name": "string",
- "abbreviation": "string",
- "category": "string"
}
]The partner has the capability to manage API keys for their merchants. This includes creating and deleting API keys.
This is the same managing capability as through the partner panel. The partner can manage the API keys for their individual merchants. API keys are not interchangeable from among different merchants, even if they are each associated with the same partner. Merchants cannot use API keys from any other merchant. Standalone merchants, those merchants not having associated partners, manage their API keys directly.
An API key is required only if application or account needs to integrate with the API suite. The number of API keys is determined by the partner or standalone merchants. For more information about API keys, see Creating an API Key.
The importance of API keys is that they are used to create API tokens, needed to make endpoint calls. To generate an API token, see Generating an API Token.
This API group is a collection of endpoints used to manage API keys. It can be used for the following:
GET /pay-api/v1/merchants/tokensPOST /pay-api/v1/merchants/tokensDELETE /pay-api/v1/merchants/tokens/{{clientId}}GET {{baseURL}}/pay-api/v1/merchants/tokens
This endpoint lists API keys created for merchants under an affiliate account.
The query parameter filter may be used to further specify API keys to return.
This endpoint requires the Bearer token to be from the affiliates (ISV) API key. Merchant tokens are not accepted.
| merchantId | string <uuid> Example: merchantId=46063d32-10fa-44cb-b118-20ddd085ce3f Specifies the identifier of the merchant. |
Array of objects or null (PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.GetMerchantApiTokensResponseDto.MerchantApiTokenDto)
| |||||||||
Array
| |||||||||
{- "tokens": [
- {
- "merchantId": "fae7620d-ab02-4375-bc20-6ff326b917fd",
- "tokenName": "Peppared Street Cafe's API Key",
- "clientId": "3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5",
- "creationDate": "2026-02-19T20:24:52.934+05:30"
}
]
}POST {{baseURL}}/pay-api/v1/merchants/tokens
This endpoint creates an API key for a merchant managed by your affiliate account.
Provide the Merchant ID and a API key name to generate a unique client Id and client secret for the merchant.
Use the returned credentials to authenticate as the merchant for API operations.
This endpoint requires the Bearer token to be an Affiliate (ISV) token. Merchant tokens are not accepted.
| merchantId required | string <uuid> Specifies the identifier of the merchant. Example: 46063d32-10fa-44cb-b118-20ddd085ce3f |
| tokenName required | string non-empty A free-formed descriptive name for the API key. Example: Peppared Street Cafe's API Key |
| clientId | string <uuid> Identifies the clientId associated with the API key. See Example: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5 |
| clientSecret | string or null The generated client secret for the merchant. This value is only shown once at the time of creation. Be sure to store it securely, as it cannot be retrieved again later. See |
{- "merchantId": "46063d32-10fa-44cb-b118-20ddd085ce3f",
- "tokenName": "Peppared Street Cafe's API Key"
}{- "clientId": "3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5",
- "clientSecret": "string"
}DELETE {{baseURL}}/pay-api/v1/merchants/tokens/{{clientId}}
This endpoint removes an API token associated with a merchant under your affiliate account.
Provide the Merchant ID and the client Id of the token to be deleted.
This action revokes the token and prevents further API access using those credentials.
This endpoint requires the Bearer token to be an Affiliate (ISV) token. Merchant tokens are not accepted.
| clientId required | string <uuid> The client ID of the token to be removed. |
| merchantId | string <uuid> Example: merchantId=46063d32-10fa-44cb-b118-20ddd085ce3f Specifies the identifier of the merchant. |
{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fef",
- "entityId": null,
- "errorCode": null
}GET {{baseURL}}/pay-api/v1/merchants
This endpoint returns a list of merchants associated with the authenticated affiliate (ISV).
The following query parameters are search filters used to specify the retuurned results.
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| search | string Example: search=Conners Electric Specifies the search string. The 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. firstName lastName companyName email mobilePhoneNumber id createdOn lastTransactionDate contactName Example: Conners Electric |
| mccCodeId | integer <int32> Example: mccCodeId=MCC code filter MCC code filter |
| statusId | integer <int32> Merchant status filter. |
| createdFrom | string <date-time> Example: createdFrom=2026-02-19T20:24:52.934Z Specifies the earliest inclusive created date (in an ISO 8601 date-time UTC or time zone offset format). This value may be paired with the field Examples: |
| createdTo | string <date-time> Example: createdTo=2026-02-19T20:24:52.934Z Specifies the latest inclusive created date (in an ISO 8601 date-time UTC or time zone offset format). This value may be paired with the field Examples: |
| modifiedFrom | string <date-time> Example: modifiedFrom=2025-03-21T20:24:52.934Z Specifies the earliest inclusive modified date (in an ISO 8601 date-time UTC or time zone offset format). This value may be paired with the field Examples: |
| modifiedTo | string <date-time> Example: modifiedTo=2026-02-19T20:24:52.934Z Specifies the latest inclusive modified date (in an ISO 8601 date-time UTC or time zone offset format). This value may be paired with the field Examples: |
| lastTransactionDateFrom | string <date-time> Example: lastTransactionDateFrom=2025-03-21T20:24:52.934Z Specifies the earliest inclusive transaction date (in an ISO 8601 date-time UTC or time zone offset format). This value may be paired with the field Examples: |
| lastTransactionDateTo | string <date-time> Example: lastTransactionDateTo=2026-02-19T20:24:52.934Z Specifies the latest inclusive transaction date (in an ISO 8601 date-time UTC or time zone offset format). This value may be paired with the field Examples: |
required | Array of objects Indicates an object array for the returned merchant list. | ||||
Array
| |||||
| total required | integer <int32> Indicates the total number of merchants found. Example: 4 | ||||
{- "items": [
- {
- "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "companyName": "Acme Corp"
}
], - "total": 1
}POST {{baseURL}}/pay-int-api/payment-sessions
This endpoint creates a payment session object.
The client, typically a frontend or checkout page, can use to securely collect payment details and process a transaction.
Although it is not required, we encourage using it. Using a payment session :
| x-api-version | string |
Payment session creation request.
| amount required | number <double> Specifies the base amount (in USD) to charge. For payment sessions, this value must be greater than zero. Examples: | ||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | ||||||||||||
| mode | integer <enum> Default: 1 Specifies the intent of the session.
Example: 2 | ||||||||||||
| skipAddressVerification | boolean Default: false Specifies to bypass the AVS (address verification service) in the payment gateway. This value is applicable only to If Example: true | ||||||||||||
| referenceId | string Specifies a reference identifier provided by the ISV. This is included in the duplicate-check key. It allows the same card and amount combination to be charged multiple times when the reference identifies are different. Example: 10001 | ||||||||||||
| tipAmount | number or null <double> decimal places <= 2 >= 0.01 Specifies the absolute amount (in USD) of tip to be added. If this value is provided, it must be greater than zero. This amount adds to the base amount of the original transaction.
That transaction must be authorized first ( Example: 14.50 |
| id | string <uuid> Indicates the payment session identifier. This value allows the customer to send the card information to complete the transaction. Example: 16143c97-07bc-448c-9807-924189311a66 |
{- "amount": 64.99,
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289de5",
- "mode": 2,
- "skipAddressVerification": true,
- "referenceId": "10001",
- "tipAmount": 14.5
}{- "id": "16143c97-07bc-448c-9807-924189311a66"
}POST {{baseURL}}/pay-int-api/payment-sessions/{{paymentSessionId}}/cancel
| paymentSessionId required | string <uuid> |
| x-api-version | string |
{- "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='<Service>.DataAccess.Entities.<Model>Entity'",
- "statusCode": 404,
- "source": "<Service>",
- "exceptionType": "Exceptions.NotFoundException",
- "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
- "entityId": null,
- "errorCode": null
}GET {{baseURL}}/pay-int-api/payment-sessions/{{paymentSessionId}}
This endpoint returns the details of the specified payment session.
| paymentSessionId required | string <uuid> Example: fffa1259-272a-4bf3-a197-a5757c26eccb Specifies the identifier of the payment session to get the status and details. |
| x-api-version | string |
| statusId | integer <int32> (PaymentIntegrations.Contracts.Enums.PaymentSessionStatus) Indicates the payment session status. Possible values:
Example: 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string or null Indicates the payment session status. Possible values:
Example: 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customerId | string <uuid> Indicates the customer identifier. This was used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| mode | integer <enum> Specifies the intent of the session. Defaults to Payment if omitted.
Example: 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| skipAddressVerification | boolean Default: false Indicates to bypass the AVS (address verification service) in the payment gateway. This value is applicable only to If Example: true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| referenceId | string or null Specifies an external transaction identifier for client-side tracking. Also used in duplicate control validation. A unique value allows similar transactions to process as distinct, bypassing duplicate blocking when needed. Example: 10001 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| vaultedPaymentMethodId | string or null <uuid> Indicates the identifier of the vaulted payment method when the session involves saving or using a stored payment method. Example: 990a65f4-519c-44f9-a615-fc9c7781190c | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionTransactionDetails) Contains information about the processed transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "statusId": 2,
- "status": 2,
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289de5",
- "mode": 2,
- "skipAddressVerification": true,
- "referenceId": "10001",
- "vaultedPaymentMethodId": "990a65f4-519c-44f9-a615-fc9c7781190c",
- "transactionDetails": {
- "transactionReceiptUrl": "string",
- "transactionReceiptShortUrl": "string",
- "source": {
- "typeId": 0,
- "type": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "version": "string"
}, - "transactionReceipt": {
- "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
- "transactionDateTime": "2026-02-19T20:24:52.934+05:30",
- "amount": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountRate": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "tipAmount": 14.5,
- "tipRate": 15,
- "totalAmount": 3219.45
}, - "currencyId": 1,
- "currency": "string",
- "processorId": "a15deb33-4fe1-4eb8-a25b-fe51bc081cca",
- "processor": "string",
- "operationTypeId": 0,
- "operationType": "string",
- "paymentMethodTypeId": 0,
- "paymentMethodType": "string",
- "transactionTypeId": 0,
- "transactionType": "string",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "customerPan": "string",
- "cardTokenType": 2,
- "statusId": 0,
- "status": "string",
- "merchantName": "string",
- "merchantAddress": "string",
- "merchantPhoneNumber": "+14155552309",
- "merchantEmailAddress": "string",
- "merchantWebsite": "string",
- "authCode": "string",
- "source": {
- "typeId": 0,
- "type": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "cardholderAuthenticationMethodId": 0,
- "cardholderAuthenticationMethod": "string",
- "cvmResultMsg": "string",
- "cardDataSourceId": 2,
- "cardDataSource": "string",
- "responseCode": "string",
- "responseDescription": "string",
- "cardProcessingDetails": {
- "authCode": "string",
- "mid": "string",
- "tid": "string",
- "cardCreditDebitTypeId": 0,
- "cardCreditDebitType": "string",
- "processCreditDebitTypeId": 0,
- "processCreditDebitType": "string",
- "rrn": "string",
- "cardTypeId": 0,
- "cardType": "string"
}, - "achProcessingDetails": {
- "customerAccountNumber": "string",
- "customerRoutingNumber": "string",
- "accountHolderType": "string",
- "accountHolderTypeId": 0,
- "accountType": "string",
- "accountTypeId": 0,
- "taxId": "string"
}, - "availableOperations": [
- {
- "typeId": 0,
- "type": "string",
- "availableAmount": 0.1,
- "suggestedTips": [
- {
- "tipAmount": 14.5,
- "tipPercent": 15
}
]
}
], - "avsResponse": {
- "actionId": 1,
- "action": "string",
- "responseCode": "string",
- "groupId": 5,
- "group": "string",
- "resultId": 1,
- "result": "string",
- "codeDescription": "string"
}, - "emvTags": {
- "ac": "string",
- "tvr": "string",
- "tsi": "string",
- "aid": "string",
- "applicationLabel": "string",
- "rawTags": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "orderNumber": "string"
}, - "id": "0e0034bd-028f-4809-b185-f4cca086eb33",
- "paymentProcessorId": "2059fcc1-5507-42be-8e4c-f4fcce245027",
- "date": "2025-01-27T12:05:54.322587+05:30",
- "amount": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 0.1,
- "cashDiscountRate": 1.5,
- "cashDiscountPercentage": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "tipAmount": 14.5,
- "tipRate": 15,
- "taxAmount": 0.1,
- "taxRate": 0.1,
- "totalAmount": 3219.45
}, - "currencyId": 1,
- "currencyCode": "USD",
- "createdBy": "string",
- "merchant": "string",
- "merchantId": "fae7620d-ab02-4375-bc20-6ff326b917fd",
- "processorId": "5e9018ff-dbbb-4ff4-8cde-b10579a3fcd9",
- "processor": "string",
- "operationMode": "string",
- "paymentMethodTypeId": 0,
- "paymentMethodType": "string",
- "paymentMethodName": "string",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "customerName": "string",
- "customerCompany": "Peppared Street Cafe",
- "customerPan": "string",
- "customerEmail": "peppared@example.com",
- "customerPhone": "+14155552309",
- "status": "Processing",
- "statusId": 1,
- "responseCode": "000",
- "responseMessage": "string",
- "responseDescription": "Command Successful. Approved.",
- "avsResponseCode": "string",
- "availableStates": [
- "string"
], - "refunded": true,
- "cardType": "string",
- "typeId": 0,
- "type": "string",
- "creditDebitTypeId": 0,
- "creditDebitTypeType": "string",
- "authCode": "string",
- "mid": "string",
- "tid": "string",
- "referenceId": "string",
- "availableOperations": [
- {
- "typeId": 0,
- "type": "string",
- "availableAmount": 0.1,
- "suggestedTips": [
- {
- "tipAmount": 14.5,
- "tipPercent": 15
}
]
}
], - "avsResponse": {
- "actionId": 1,
- "action": "string",
- "responseCode": "string",
- "groupId": 5,
- "group": "string",
- "resultId": 1,
- "result": "string",
- "codeDescription": "string"
}, - "histories": [
- {
- "id": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
- "transactionDateTime": "2026-02-19T20:24:52.934+05:30",
- "transactionAmount": 0.1,
- "transactionTypeId": 0,
- "transactionType": "string",
- "transactionStatusId": 0,
- "transactionStatus": "string"
}
]
}
}GET {{baseURL}}/pay-int-api/ping
This endpoint pings the terminal to check the current status and context.
| x-api-version | string |
| authenticated | boolean Indicates the request is authenticated. If Example: true |
| merchantId | string or null <uuid> Indicates the identifier of the merchant. If a value is provided, the API key is valid and requests can be made. Example: 46063d32-10fa-44cb-b118-20ddd085ce3f |
| clientId | string or null <uuid> Indicates the first value association with the API key. The second value association with the API key, the client secret, is never shown after the initial creation. Example: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5 |
GET {{baseURL}}/pos-api/v1/pos-transactions
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| terminalId | string <uuid> Example: terminalId=2428b5e7-6386-42ad-8b1c-d2a9032da4b3 Specifies the terminal identifier. |
Array of objects or null (PosService.Contracts.PosTransactions.Get.ListPosTransactionsResponseDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| total | integer <int32> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "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
}POST {{baseURL}}/pos-api/v1/pos-transactions
Initiate a new transaction on the terminal device with predefined information, such as amount and transaction type.
| amount required | number or null <integer> Specifies the total transaction amount (in USD). This is required whentransactionTypeId is:
Example: 45.99 | ||||||||||||||||||||||||||||||
| currencyId required | integer or null <integer> Specifies the Aurora currency identifier. Always set to 1. This is required when transactionTypeId is:
Example: 1 | ||||||||||||||||||||||||||||||
| posDeviceId required | string [ 1 .. 36 ] characters Specifies the External POS (point of sale) device identifier. Example: 000000001 | ||||||||||||||||||||||||||||||
| terminalId required | string <uuid> Specifies the terminal identifier. This is the the terminal used to initiate and handle the transaction. This terminal must be in the semi-integrated mode and available (online and ready). Example: 914358ab-efd7-4c5c-8570-fe4c0370fc37 | ||||||||||||||||||||||||||||||
| transactionTypeId required | integer <int32> (PosService.Contracts.TransactionType) Set the transaction type to be processed by the terminal. Possible values:
Example: 10 | ||||||||||||||||||||||||||||||
| waitForAcceptanceByTerminal required | boolean Specifies the long polling response mode. If
If In either result, use Gets POS transaction by ID ( Example: true | ||||||||||||||||||||||||||||||
| requestPaymentMethodStorageConsent required | boolean Specifies to show popup about saving customer payment method information on the terminal. If Example: true | ||||||||||||||||||||||||||||||
| targetTransactionId required | string or null <uuid> Specifies the transaction identifier. This is required for the following operations:
Example: 250521bd-1e4e-4363-8381-de512760d19a | ||||||||||||||||||||||||||||||
| referenceId | string or null [ 0 .. 36 ] characters Specifies the external transaction reference identifier. | ||||||||||||||||||||||||||||||
| useCardPrice | boolean or null Set the type of price being sent in the This field is mandatory only if the merchant’s ZeroCostProcessingOption is Dual Pricing.
For other ZeroCostProcessingOption values, set it as If The application will automatically calculate the total amounts by each payment method based on these inputs. | ||||||||||||||||||||||||||||||
| paymentProcessorId | string or null <uuid> Set the Payment Processor ID to be used in the transaction. If not provided, it will use the merchant’s default processor. | ||||||||||||||||||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | ||||||||||||||||||||||||||||||
| readingMethodId | integer or null <int32> (PosService.Contracts.Enums.PosTransactionReadingMethod) xxx Set the card reading method for the transaction. Possible values:
Example: 1 |
| posTransactionId | string <uuid> ID of POS transaction | ||||||||||||||||||||||
| statusId | integer <int32> (PosService.Contracts.PosTransactionStatus) Indicates the value of the status identifier. Possible values:
Example: 2 | ||||||||||||||||||||||
| status | string or null Indicates the status identifier. Possible values:
Example: TransactionProcessing |
{- "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
}{- "posTransactionId": "6f1a2b3c-4d5e-4f6a-b7c8-9d0e1f2a3b03",
- "statusId": 1,
- "status": "TerminalConnecting"
}GET {{baseURL}}/pos-api/v1/pos-transactions/{{posTransactionsid}}
Gets POS transaction by ID
| posTransactionsid required | string <uuid> ID of POS transaction |
| waitForTransactionProcessing | boolean Default: false Example: waitForTransactionProcessing=true
If Example: true |
| id | string <uuid> ID of POS transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| createdOn | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the POS transaction was created. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| modifiedOn | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the last POS transaction modification. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantId | string <uuid> ARISE Merchant ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| terminalId | string <uuid> ID of terminal should handle POS Transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| paymentProcessorId | string or null <uuid> Predefined PaymentProcessorID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| posDeviceId | string or null External POS Device ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| referenceId | string or null External Reference Device ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| posTransactionStatusId | integer <int32> (PosService.Contracts.PosTransactionStatus) Indicates the value of the status identifier. Possible values:
Example: 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| posTransactionStatus | string or null Indicates the status identifier. Possible values:
Example: TransactionProcessing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionId | string or null <uuid> ID of attached transaction. Available after processing. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| amount | number or null <double> Transaction amount for transaction types requires Amount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| currencyId | integer or null <int32> Indicates the Aurora currency identifier. Always set to 1. Example: 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| targetTransactionId | string or null <uuid> Transaction Id for Void, Capture, Refund. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionTypeId | integer <int32> (PosService.Contracts.TransactionType) Set the transaction type to be processed by the terminal. Possible values:
Example: 10 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionType | string or null Specifies transaction type being processed by the terminal. Possible values:
Example: 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isCompleted | boolean Indicates the POS transaction completion status. If Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PosService.Contracts.PosTransactions.Get.GetPosTransactionResponseDto.TransactionDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (PaymentGateway.Contracts.Transactions.TransactionReceiptDto)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "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"
}
}POST {{baseURL}}/pos-api/v1/pos-transactions/{{posTransactionsid}}/cancel
Cancels a POS transaction by ID
| posTransactionsid required | string <uuid> ID of POS transaction |
| posTransactionId | string <uuid> ID of POS transaction | ||||||||||||||||||||||
| statusId | integer <int32> (PosService.Contracts.PosTransactionStatus) Indicates the value of the status identifier. Possible values:
Example: 2 | ||||||||||||||||||||||
| status | string or null Indicates the status identifier. Possible values:
Example: TransactionProcessing |
{- "posTransactionId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14",
- "statusId": 1,
- "status": "TerminalConnecting"
}POST {{baseURL}}/pos-api/v1/pos-transactions/{{posTransactionId}}/print
This endpoint allows semi-integrated ISVs to trigger a physical reprint of a completed transaction receipt directly from the POS terminal.
It supports customer requests for duplicate receipts in-person, enabling a seamless merchant experience.
| posTransactionId required | string <uuid> ID of POS transaction |
Print request payload must include required terminalId
| terminalId | string <uuid> Terminal ID from the terminal that will initiate and handle the transaction receipt print request. Terminal must be in the semi-integrated mode and available (online and ready). |
{- "terminalId": "57e69e1b-2c00-4a26-b5e3-44617c6cc659"
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92",
- "entityId": null,
- "errorCode": null
}POST {{baseURL}}/pay-int-api/quick-payments/one-time
This endpoint creates link for a one-time payment.
A one-time is one that can be used only once and then it expires. This can be used for cases like purchases or fee payments. It is limited to only one person. A one-time is in contrast to a reusable payment payment that can be use multiple times by different people.
The link must be activated before use as a security feature.
To activate a one-time payment link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate
The link remains active until one of the following occurs:
See Also:
To activate a link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate
To send a one-time payment link to a customer, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification
To deactivate a link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate
To get a list of all one-time payments links, see GET /pay-int-api/quick-payments/one-time
To get details for a specified one-time payments link, see POST /pay-int-api/quick-payments/one-time/{{quickPaymentId}}
| x-api-version | string |
The one-time payment link creation request.
| amount | number <double> > 0 Specifies the amount (in USD) of the one-time payment. Example: 45.99 |
| referenceId | string or null [ 0 .. 100 ] Specifies the ReferenceId. Example: 10001 |
| customerId | string or null <uuid> Specifies the customer identifier. Example: c9ae4972-b934-41aa-8e1a-1e5d8ad34bec |
| id | string <uuid> Indicates the payment reference link identifier, also known as the quickPaymentId. Example: c8c67f32-aca5-47c4-b10e-123086a43075 |
{- "amount": 45.99,
- "referenceId": "10001",
- "customerId": "c9ae4972-b934-41aa-8e1a-1e5d8ad34bec"
}{- "id": "c8c67f32-aca5-47c4-b10e-123086a43075"
}GET {{baseURL}}/pay-int-api/quick-payments/one-time
This endpoint returns a list of one-time payment links.
The links may be valid or expired.
The request may be filtered to limit returns to the specified search.
See Also:
To create a one-time payment and link, see POST /pay-int-api/quick-payments/one-time
To see the details of a specified one-time payment, see POST /pay-int-api/quick-payments/one-time/{{quickPaymentId}}
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| search | string Specifies a term to search for. Example: contactName |
| x-api-version | string |
Array of objects or null (PaymentIntegrations.Contracts.QuickPayments.OneTime.GetPage.GetOneTimeQuickPaymentPageResponseDto) | ||||||||||||||||||||||||||||||
Array
| ||||||||||||||||||||||||||||||
| total | integer <int32> | |||||||||||||||||||||||||||||
{- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "customerName": "string",
- "amount": 0.1,
- "status": 0,
- "createdOn": "2026-02-19T20:24:52.934+05:30",
- "expirationTime": "2019-08-24T14:15:22Z",
- "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
}
], - "total": 0
}POST {{baseURL}}/pay-int-api/quick-payments/one-time/{{quickPaymentId}}
This endpoint returns the details of a one-time payment.
The link may be valid or expired.
See Also:
To create a one-time payment and link, see POST /pay-int-api/quick-payments/one-time
To see a list of one-time payments, see GET /pay-int-api/quick-payments/one-time
| quickPaymentId required | string <uuid> Example: 0423617a-2004-4516-935d-e5ad4bbbe93e Specifies the payment link identifier. This value is returned from either:
|
| x-api-version | string |
| id | string <uuid> | |||||||||||||||
| amount | number <double> | |||||||||||||||
| referenceId | string or null | |||||||||||||||
| status | integer <int32> (PaymentIntegrations.Contracts.Enums.QuickPaymentStatus) Payment link status. Possible values:
| |||||||||||||||
| shortUrl | string or null | |||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | |||||||||||||||
| customerName | string or null | |||||||||||||||
| createdOn | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the quick payment was created. Examples: |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "amount": 0.1,
- "referenceId": "string",
- "status": 0,
- "shortUrl": "string",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "customerName": "string",
- "createdOn": "2026-02-19T20:24:52.934+05:30"
}POST {{baseURL}}/pay-int-api/quick-payments/{{quickPaymentId}}/activate
This endpoint manually activates a one-time payment link.
A created one-time payment link must be activated before using it.
See Also:
To create a one-time payment link, see POST /pay-int-api/quick-payments/one-time
To send a one-time payment link to a customer, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification
To manually deactivate a link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate
To get a list of all one-time payments links, see GET /pay-int-api/quick-payments/one-time
To get details for a specified one-time payments link, see POST /pay-int-api/quick-payments/one-time/{{quickPaymentId}}
| quickPaymentId required | string <uuid> Example: 0423617a-2004-4516-935d-e5ad4bbbe93e Specifies the payment link identifier. This value is returned from either:
|
| x-api-version | string |
POST {{baseURL}}/pay-int-api/quick-payments/{{quickPaymentId}}/deactivate
This endpoint manually deactivates a one-time payment link. The link can also be manually deactivated any time after it is created but before the Customer completes payment.
The link can be deactivated and cannot be used in the following situations:
See Also:
To create a one-time payment link, see POST /pay-int-api/quick-payments/one-time
To manually activate a link, see POST POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate
To send a one-time payment link to a customer, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification
To get a list of all one-time payments links, see GET /pay-int-api/quick-payments/one-time
To get details for a specified one-time payments link, see POST /pay-int-api/quick-payments/one-time/{{quickPaymentId}}
| quickPaymentId required | string <uuid> Example: 0423617a-2004-4516-935d-e5ad4bbbe93e Specifies the payment link identifier. This value is returned from either:
|
| x-api-version | string |
POST {{baseURL}}/pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification
This endpoint sends a one-time payment link to a customer through SMS.
See Also:
To create a one-time payment link, see POST /pay-int-api/quick-payments/one-time
To activate a link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate
To deactivate a link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate
To get a list of all one-time payments links, see GET /pay-int-api/quick-payments/one-time
To get details for a specified one-time payments link, see POST /pay-int-api/quick-payments/one-time/{{quickPaymentId}}
| quickPaymentId required | string <uuid> Example: 0423617a-2004-4516-935d-e5ad4bbbe93e Specifies the payment link identifier. This value is returned from either:
|
| x-api-version | string |
The request containing the details for the SMS notification.
| phoneNumber | string or null <E.164> <= 20 characters ^(null|\+\d{1,20})$ Indicates the SMS phone number. Example: +14155552309 |
| customerConsent | boolean Indicates the customer has consented to receiving the SMS. If Example: true |
{- "phoneNumber": "+14155552309",
- "customerConsent": true
}POST {{baseURL}}/pay-int-api/quick-payments/reusable
This endpoint creates link for a quick reusable payment.
A reusable payment is one that can be used multiple times and remains active after each use. This can be used for cases like donations or event registration fees. It is not limited to the same person each time. A reusable payment is in contrast to the one-time payment that expires after a single time.
The link must be activated before use as a security feature.
To activate a reusable link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate
The link remains active until one of the following occurs:
See Also:
To deactivate a link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate
To get a list of all reusable payments links, see GET /pay-int-api/quick-payments/reusable
To get details for a specified reusable link, see POST /pay-int-api/quick-payments/reusable/{{quickPaymentId}}}}`
| x-api-version | string |
The payment link creation request.
| amount | number <double> > 0 Specifies the amount (in USD) of the one-time payment. Example: 45.99 |
| id | string <uuid> Indicates the payment reference link identifier, also known as the quickPaymentId. Example: c8c67f32-aca5-47c4-b10e-123086a43075 |
{- "amount": 45.99
}{- "id": "c8c67f32-aca5-47c4-b10e-123086a43075"
}GET {{baseURL}}/pay-int-api/quick-payments/reusable
This endpoint returns a list of reusable links.
The links may be valid or expired.
The request may be filtered to limit returns to the specified search.
See Also:
To create a reusable payment link, see POST /pay-int-api/quick-payments/reusable
To deactivate a link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate
To get details for a specified reusable link, see POST /pay-int-api/quick-payments/reusable/{{quickPaymentId}}}}
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 | |||||||||||||||
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 | |||||||||||||||
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName | |||||||||||||||
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true | |||||||||||||||
| status | integer <int32> (PaymentIntegrations.Contracts.Enums.QuickPaymentStatus) Payment link status. Possible values:
|
| x-api-version | string |
Array of objects or null (PaymentIntegrations.Contracts.QuickPayments.Reusable.GetPage.GetReusableQuickPaymentPageResponseDto) | ||||||||||||||||||||||||||||
Array
| ||||||||||||||||||||||||||||
| total | integer <int32> | |||||||||||||||||||||||||||
{- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "amount": 0.1,
- "status": 0,
- "createdOn": "2026-02-19T20:24:52.934+05:30",
- "totalTransactionsAmount": 0.1,
- "shortUrl": "string"
}
], - "total": 0
}POST {{baseURL}}/pay-int-api/quick-payments/reusable/{{quickPaymentId}}
This endpoint returns the details of a reusable payment.
The link may be valid or expired.
See Also:
To create a reusable payment link, see POST /pay-int-api/quick-payments/reusable
To deactivate a link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate
To get details for a specified reusable link, see POST /pay-int-api/quick-payments/reusable/{{quickPaymentId}}}}`
| quickPaymentId required | string <uuid> Example: 0423617a-2004-4516-935d-e5ad4bbbe93e Specifies the payment link identifier. This value is returned from either:
|
| x-api-version | string |
| id | string <uuid> | |||||||||||||||
| amount | number <double> | |||||||||||||||
| status | integer <int32> (PaymentIntegrations.Contracts.Enums.QuickPaymentStatus) Payment link status. Possible values:
| |||||||||||||||
| shortUrl | string or null | |||||||||||||||
| totalTransactionsAmount | number <double> | |||||||||||||||
| totalTransactionsCount | integer <int32> | |||||||||||||||
| createdOn | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the reusable quick payment was created. Examples: |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "amount": 0.1,
- "status": 0,
- "shortUrl": "string",
- "totalTransactionsAmount": 0.1,
- "totalTransactionsCount": 0,
- "createdOn": "2026-02-19T20:24:52.934+05:30"
}GET {{baseURL}}/pay-api/v1/settlements/batches
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| dateFrom | string <date-time> |
| dateTo | string <date-time> |
| batchIds | Array of strings <uuid> [ items <uuid > ] |
| paymentProcessorIds | Array of strings <uuid> [ items <uuid > ] |
| statusId | integer <int32> (PaymentGateway.Contracts.Enums.SettlementBatchStatus) Example: statusId=2 Possible values:
|
Array of objects or null (PaymentGateway.Contracts.PublicApi.Isv.SettlementBatches.GetPage.GetIsvSettlementBatchesResponse) | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| total | integer <int32> | ||||||||||||||||||||||
{- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "paymentProcessorId": "a7699db0-1e16-4616-b2cf-4e8d4a5320cb",
- "paymentProcessorName": "string",
- "externalBatchId": "string",
- "batchDateTime": "2026-02-19T20:24:52.934+05:30",
- "transactionCount": 0.1,
- "netAmount": 0.1,
- "refundsAmount": 0.1,
- "salesAmount": 0.1,
- "statusId": 0,
- "statusName": "string"
}
], - "total": 0
}A subscription is a recurring payment. The client authorizes a transaction at regular intervals, such as weekly, monthly, or annually.
Examples include mortgages, leases, streaming media payments, and Insurance premiums. Payments represent:
Installments may be specified as a combination of:
Installments may either specify:
The following endpoints are available:
GET /sub-api/v1/subscriptions
Lists subscriptions associated with the merchant.
GET /sub-api/v1/subscriptions/{{subscriptionId}}
Lists subscriptions associated with a specified subscription identifier.
POST /sub-api/v1/subscriptions
Creates a subscription.
GET /sub-api/v1/subscriptions/{{subscriptionId}}/payments
Lists the payment history from a specified subscription identifier.
PUT /sub-api/v1/subscriptions/{{subscriptionId}}/terminate
Terminate or cancels the specified subscription identifier.
GET {{baseURL}}/sub-api/v1/subscriptions
This endpoint returns a list of the merchant's subscriptions.
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| search | string Example: search=Peppared
The allows a partial such on the customer name. For example, Alexandro, Peppared, Alexandro Peppared or ppa may be matched. Search strings not found returns successfully but with an empty array. Example: Peppared |
| customerIds | Array of strings <uuid> [ items <uuid > ] Example: customerIds=019d9cb4-c430-7b49-b232-a6a5d07c8371
Multiple values are not supported. Example: 019d9cb4-c430-7b49-b232-a6a5d07c8371 |
| id | string <uuid> Indicates the subscription identifier. Example: 35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14 | |||||||||||||||||||||
| merchantId | string <uuid> Indicates the merchant identifier. Example: 46f7a8b9-0c1d-4e2f-3a4b-5c6d7e8f9a25 | |||||||||||||||||||||
| paymentProcessorId | string <uuid> Indicates the payment processor identifier. Example: 57a8b9c0-1d2e-4f3a-4b5c-6d7e8f9a0b36 | |||||||||||||||||||||
| statusId | integer <int32> Indicates the subscription status identifier. Possible values:
Example: 2 | |||||||||||||||||||||
| status | string or null Indicates the subscription status. Possible values:
Example: Completed | |||||||||||||||||||||
| transactionTypeId | integer <int32> Indicates the Aurora transaction type identifier code value. Example: 6 | |||||||||||||||||||||
| transactionType | string or null Indicates the Aurora transaction type identifier code name. Example: CardAuthentication | |||||||||||||||||||||
| customerId | string <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | |||||||||||||||||||||
| paymentMethodId | string or null <uuid> (ach_paymentmethodid) Indentifies the customer payment method identifier. Example: b6df8625-cd25-4123-b345-638aa7b5d011 | |||||||||||||||||||||
object (SubscriptionsService.Contracts.Subscriptions.PaymentAmountDto) | ||||||||||||||||||||||
| ||||||||||||||||||||||
| alreadyPaidAmount | number <double> Indicates the total amount the client has already paid as part of this subscription. Example: 259.99 | |||||||||||||||||||||
| allPaymentsAmount | number <double> Indicates the total of all amounts due of the subscription. Example: 54.92 | |||||||||||||||||||||
| currencyId | integer <int32> Indicates the Aurora currency identifier. Always set to 1. Example: 1 | |||||||||||||||||||||
| paymentFrequencyUnitId | integer <int32> Indicates the payment frequency identifier. Possible values:
Example: 3 | |||||||||||||||||||||
| paymentFrequencyUnit | integer or null <int32> Indicates the payment frequency unit. As examples: Possible values:
Example: 3 | |||||||||||||||||||||
| paymentFrequency | integer <int32> Indicates the payment frequency identifier. Possible values:
As examples: Example: Weekly | |||||||||||||||||||||
| createdOn | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the subscription was created. Examples: | |||||||||||||||||||||
| subscriptionStartDate | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's first payment. Examples: | |||||||||||||||||||||
| subscriptionEndDate | string or null <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's last payment. Examples: | |||||||||||||||||||||
| lastPaymentDate | string or null <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's last payment date. Examples: | |||||||||||||||||||||
| nextPaymentDate | string or null <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's next payment date. Examples: | |||||||||||||||||||||
| successfulPaymentsCount | integer <int32> Indicates the number of successful payments for the subscription. See Example: 32 | |||||||||||||||||||||
| numberOfPayments | integer <int32> Total number of payments for the subscription. See Example: 60 | |||||||||||||||||||||
object (SubscriptionsService.Contracts.Subscriptions.Get.GetSubscriptionResponseDto.CustomerDto)
| ||||||||||||||||||||||
| ||||||||||||||||||||||
object (SubscriptionsService.Contracts.SourceResponseDto) | ||||||||||||||||||||||
| ||||||||||||||||||||||
{- "id": "35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14",
- "merchantId": "46f7a8b9-0c1d-4e2f-3a4b-5c6d7e8f9a25",
- "paymentProcessorId": "57a8b9c0-1d2e-4f3a-4b5c-6d7e8f9a0b36",
- "statusId": 2,
- "status": "Completed",
- "transactionTypeId": 6,
- "transactionType": "CardAuthentication",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentAmount": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountRate": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "totalAmount": 3219.45
}, - "alreadyPaidAmount": 259.99,
- "allPaymentsAmount": 54.92,
- "currencyId": 1,
- "paymentFrequencyUnitId": 3,
- "paymentFrequencyUnit": 3,
- "paymentFrequency": "Weekly",
- "createdOn": "2026-02-19T20:24:52.934+05:30",
- "subscriptionStartDate": "2026-02-19T20:24:52.934+05:30",
- "subscriptionEndDate": "2026-02-19T20:24:52.934+05:30",
- "lastPaymentDate": "2026-02-19T20:24:52.934+05:30",
- "nextPaymentDate": "2026-03-19T20:24:52.934+05:",
- "successfulPaymentsCount": 32,
- "numberOfPayments": 60,
- "customer": {
- "customerName": "Example: Alexandro Peppard",
- "companyName": "Example: Peppared Street Cafe",
- "panMask": "4111********1234",
- "cardTokenType": 2,
- "emailAddress": "peppared@example.com",
- "phoneNumber": "+15551234567"
}, - "source": {
- "typeId": 0,
- "type": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}POST {{baseURL}}/sub-api/v1/subscriptions
This endpoint creates a subscription.
A subscription is a recurring payment. The client authorizes a transaction at regular intervals, such as weekly, monthly, or annually.
Payments represent:
Request parameters
| amount required | number <double> Specifies the total amount due (in USD) of the transaction. Example: 43.99 | |||||||||||||||
| transactionType required | integer <int32> (SubscriptionsService.Contracts.Enums.TransactionType) Specifies the transaction type. Possible values:
Example: 11 | |||||||||||||||
| currencyId required | integer <int32> Specifies the Aurora currency identifier. Always set to 1. Example: 1 | |||||||||||||||
| paymentProcessorId required | string <uuid> Specifies the payment processor identifier. Example: 8ebb41c8-e1b0-4777-8f8e-1402e756ee7d | |||||||||||||||
| paymentMethodId required | string <uuid> Specifies the payment method identifier. Must be added and active before subscription creation. Example: 7ef038b0-d612-4d10-9e2c-80e791b54632 example: "7ef038b0-d612-4d10-9e2c-80e791b54632" | |||||||||||||||
| paymentFrequencyUnit required | integer <int32> (SubscriptionsService.Contracts.Enums.PaymentFrequencyUnit) Indicates the payment frequency unit. As examples: Possible values:
Example: 3 | |||||||||||||||
| paymentFrequency required | integer <int32> Specifies the frequency of the payment value. As examples: Example: 2 | |||||||||||||||
| numberOfPayments required | integer <int32> Specifies the number of payments for the subscription. Example: 60 | |||||||||||||||
| customerId required | string <uuid> Specifies the customer identifier of the subscription. Example: d368cf28-4390-4f6d-b363-ce8d112e8517 | |||||||||||||||
| isFasterProcessing required | boolean (ach_isfasterprocessing) Default: false Specifies ACH (automated clearing house) transaction has same day processing enabled. Must be empty or null for card subscriptions. If Example: false | |||||||||||||||
| useCardPrice | boolean Specifies appling the card-based pricing instead of the cash-based pricing. The card price is typically higher because of processing fees. This fee is embedded in the price and not added as a line item. If ZeroCostProcessingOption is DualPricing.
Example: true | |||||||||||||||
| secCode | integer <int32> Default: 1
transactionType is 11 (AchDebit).
Allowed values:
Example: 1 | |||||||||||||||
| percentageOffRate | number or null <double> Specifies the percent of the base amount to be discounted. Example: | |||||||||||||||
| surchargeRate | number or null <double> Specifies the surcharge percentage. This is a surcharge on the base amount.
This value is surcharge percentage rate.
This surcharge percentage calculates the surcharge amount for Example: 1.5 (as 1.5%) | |||||||||||||||
| paymentStartDateTime | string or null <date-time> Specifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's first payment date. If omitted or null, it indicates immediate payment(PayNow). Examples: |
| id | string <uuid> Subscription Id |
| payNowSuccess | boolean or null True if PayNow was executed successfully, otherwise false. |
| transactionId | string or null <uuid> Transaction Id if PayNowSuccess was True. |
| payNowResponse | string or null Payment response if PayNowSucess was False. |
{- "amount": 43.99,
- "transactionType": 11,
- "currencyId": 1,
- "paymentProcessorId": "8ebb41c8-e1b0-4777-8f8e-1402e756ee7d",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentFrequencyUnit": 3,
- "paymentFrequency": 2,
- "numberOfPayments": 60,
- "customerId": "d368cf28-4390-4f6d-b363-ce8d112e8517",
- "isFasterProcessing": false,
- "useCardPrice": true,
- "secCode": 1,
- "percentageOffRate": 12,
- "surchargeRate": 1.5,
- "paymentStartDateTime": "2026-02-19T20:24:52.934+05:30"
}{- "id": "5dd66afe-481a-4718-ad82-3d330a9735c6",
- "payNowSuccess": true,
- "transactionId": "798c3112-54c3-4ba9-b2aa-832d1f724024",
- "payNowResponse": null
}GET {{baseURL}}/sub-api/v1/subscriptions/{subscriptionId}
This endpoint retrieves a specified subscription.
| subscriptionId required | string <uuid> Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58
Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58 |
| id | string <uuid> Indicates the subscription identifier. Example: 35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14 | |||||||||||||||||||||
| merchantId | string <uuid> Indicates the merchant identifier. Example: 46f7a8b9-0c1d-4e2f-3a4b-5c6d7e8f9a25 | |||||||||||||||||||||
| paymentProcessorId | string <uuid> Indicates the payment processor identifier. Example: 57a8b9c0-1d2e-4f3a-4b5c-6d7e8f9a0b36 | |||||||||||||||||||||
| statusId | integer <int32> Indicates the subscription status identifier. Possible values:
Example: 2 | |||||||||||||||||||||
| status | string or null Indicates the subscription status. Possible values:
Example: Completed | |||||||||||||||||||||
| transactionTypeId | integer <int32> Indicates the Aurora transaction type identifier code value. Example: 6 | |||||||||||||||||||||
| transactionType | string or null Indicates the Aurora transaction type identifier code name. Example: CardAuthentication | |||||||||||||||||||||
| customerId | string <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | |||||||||||||||||||||
| paymentMethodId | string or null <uuid> (ach_paymentmethodid) Indentifies the customer payment method identifier. Example: b6df8625-cd25-4123-b345-638aa7b5d011 | |||||||||||||||||||||
object (SubscriptionsService.Contracts.Subscriptions.PaymentAmountDto) | ||||||||||||||||||||||
| ||||||||||||||||||||||
| alreadyPaidAmount | number <double> Indicates the total amount the client has already paid as part of this subscription. Example: 259.99 | |||||||||||||||||||||
| allPaymentsAmount | number <double> Indicates the total of all amounts due of the subscription. Example: 54.92 | |||||||||||||||||||||
| currencyId | integer <int32> Indicates the Aurora currency identifier. Always set to 1. Example: 1 | |||||||||||||||||||||
| paymentFrequencyUnitId | integer <int32> Indicates the payment frequency identifier. Possible values:
Example: 3 | |||||||||||||||||||||
| paymentFrequencyUnit | integer or null <int32> Indicates the payment frequency unit. As examples: Possible values:
Example: 3 | |||||||||||||||||||||
| paymentFrequency | integer <int32> Indicates the payment frequency identifier. Possible values:
As examples: Example: Weekly | |||||||||||||||||||||
| createdOn | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) when the subscription was created. Examples: | |||||||||||||||||||||
| subscriptionStartDate | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's first payment. Examples: | |||||||||||||||||||||
| subscriptionEndDate | string or null <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's last payment. Examples: | |||||||||||||||||||||
| lastPaymentDate | string or null <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's last payment date. Examples: | |||||||||||||||||||||
| nextPaymentDate | string or null <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's next payment date. Examples: | |||||||||||||||||||||
| successfulPaymentsCount | integer <int32> Indicates the number of successful payments for the subscription. See Example: 32 | |||||||||||||||||||||
| numberOfPayments | integer <int32> Total number of payments for the subscription. See Example: 60 | |||||||||||||||||||||
object (SubscriptionsService.Contracts.Subscriptions.Get.GetSubscriptionResponseDto.CustomerDto)
| ||||||||||||||||||||||
| ||||||||||||||||||||||
object (SubscriptionsService.Contracts.SourceResponseDto) | ||||||||||||||||||||||
| ||||||||||||||||||||||
{- "id": "35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14",
- "merchantId": "46f7a8b9-0c1d-4e2f-3a4b-5c6d7e8f9a25",
- "paymentProcessorId": "57a8b9c0-1d2e-4f3a-4b5c-6d7e8f9a0b36",
- "statusId": 2,
- "status": "Completed",
- "transactionTypeId": 6,
- "transactionType": "CardAuthentication",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentAmount": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountRate": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "totalAmount": 3219.45
}, - "alreadyPaidAmount": 259.99,
- "allPaymentsAmount": 54.92,
- "currencyId": 1,
- "paymentFrequencyUnitId": 3,
- "paymentFrequencyUnit": 3,
- "paymentFrequency": "Weekly",
- "createdOn": "2026-02-19T20:24:52.934+05:30",
- "subscriptionStartDate": "2026-02-19T20:24:52.934+05:30",
- "subscriptionEndDate": "2026-02-19T20:24:52.934+05:30",
- "lastPaymentDate": "2026-02-19T20:24:52.934+05:30",
- "nextPaymentDate": "2026-03-19T20:24:52.934+05:",
- "successfulPaymentsCount": 32,
- "numberOfPayments": 60,
- "customer": {
- "customerName": "Example: Alexandro Peppard",
- "companyName": "Example: Peppared Street Cafe",
- "panMask": "4111********1234",
- "cardTokenType": 2,
- "emailAddress": "peppared@example.com",
- "phoneNumber": "+15551234567"
}, - "source": {
- "typeId": 0,
- "type": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}GET {{baseURL}}/sub-api/v1/subscriptions/{{subscriptionId}}/payments
This endpoint retrieves a history of payments for a specified subscription.
| subscriptionId required | string <uuid> Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58
Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58 |
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| hideCompletedAndPlanned | boolean Example: hideCompletedAndPlanned=true Specifies leaving out completed and planned payments from the history list. The retrieved payment history list could excluded previously completed and planned payments. If Example: true |
| id | string <uuid> Indicates the subscription identifier. Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58 | ||||||||||||||||||||||||||||||||||||||||||
| initialExecutionDateTime | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the subscription's initial execution. Examples: | ||||||||||||||||||||||||||||||||||||||||||
| statusId | integer <int32> Indicates the subscription status identifier. Possible values:
Example: 2 | ||||||||||||||||||||||||||||||||||||||||||
| status | string or null Indicates the subscription status. Possible values:
Example: Completed | ||||||||||||||||||||||||||||||||||||||||||
| amount | number <double> Indicates the payment amount. Example: 129.99 | ||||||||||||||||||||||||||||||||||||||||||
| paymentOrder | integer <int32> Indicates a payment attempt identifier. Example: 748411 | ||||||||||||||||||||||||||||||||||||||||||
Array of objects or null (SubscriptionsService.Contracts.Subscriptions.Isv.GetSubscriptionPayments.GetIsvSubscriptionPaymentAttemptResponseDto)
| |||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "initialExecutionDateTime": "2026-02-19T20:24:52.934+0",
- "statusId": 2,
- "status": "Completed",
- "amount": 129.99,
- "paymentOrder": 748411,
- "attempts": [
- {
- "id": "35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14",
- "executionDateTime": "2026-02-19T20:24:52.934+05:30",
- "statusId": 2,
- "status": "Completed",
- "transactionStatusId": 0,
- "transactionStatus": "string",
- "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
}
]
}PUT {{baseURL}}/sub-api/v1/subscriptions/{{subscriptionId}}/terminate
This endpoint terminates, or cancels, an active subscription.
This action occurs immediately and cannot be undone.
| subscriptionId required | string <uuid> Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58
Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58 |
| id | string <uuid> Indicates the subscription identifier. Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58 | ||||||||||||||
| statusId | integer <int32> Indicates the subscription status identifier. Possible values:
Example: 2 | ||||||||||||||
| status | string or null Indicates the subscription status. Possible values:
Example: Completed | ||||||||||||||
| message | string or null Indicates a message with additional details. Example: Subscription is terminated. Future payments will no longer be processed. This action is permanent. |
{- "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"
}GET {{baseURL}}/pos-api/v1/terminals
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| search | string |
| deliveryStatusId | integer <int32> |
| serialNumber | string |
| manufacturerIds | Array of integers <int32> [ items <int32 > ] |
| modelIds | Array of integers <int32> [ items <int32 > ] |
Array of objects or null (PosService.Contracts.Terminals.List.GetTerminalsResponseDto) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
| total | integer <int32> | ||||||||||||||||||||||||||||||
{- "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
}GET {{baseURL}}/pos-api/v1/terminals/{{terminalId}}/status
Retrieves the current status and details of a terminal device.
This endpoint provides the latest available information about a terminal, updated in near real-time.
Depending on the terminal's internet connectivity and operational status, the response may include limited terminal data.
| terminalId required | string <uuid> TerminalId |
| terminalId | string <uuid> Terminal Id | ||||||||||||||||||
| timestamp | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the terminal's status log. Examples: | ||||||||||||||||||
| connectionStatusId | integer <int32> (PosService.Contracts.Enums.TerminalConnectionStatus) Possible values:
| ||||||||||||||||||
| connectionStatus | string or null | ||||||||||||||||||
| connectionTypeId | integer <int32> (PosService.Contracts.Enums.TerminalConnectionType) Possible values:
| ||||||||||||||||||
| connectionType | string or null | ||||||||||||||||||
| wifiConnectionStrength | integer <int32> Wifi Connection Strength 0-100 | ||||||||||||||||||
| mobileConnectionStrength | integer <int32> Mobile Connection Strength 0-100 | ||||||||||||||||||
| lastSeenTimestamp | string or null <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the terminal's online status. Examples: | ||||||||||||||||||
| debitPinKeyId | integer <int32> (PosService.Contracts.Enums.TerminalDebitPinKey) Possible values:
| ||||||||||||||||||
| debitPinKey | string or null | ||||||||||||||||||
| availabilityStatusId | integer <int32> (PosService.Contracts.Enums.TerminalAvailabilityStatus) Possible values:
| ||||||||||||||||||
| availabilityStatus | string or null | ||||||||||||||||||
| ariseTerminalVersion | string or null ARISE Terminal version | ||||||||||||||||||
| batteryLevel | integer <int32> Battery Level 0-100 | ||||||||||||||||||
| printerStatusId | integer <int32> (PosService.Contracts.Enums.TerminalPrinterStatus) Possible values:
| ||||||||||||||||||
| printerStatus | string or null | ||||||||||||||||||
object (PosService.Contracts.Terminals.Status.Get.Get.GetTerminalStatusResponseDto.DeviceSoftwareDetailsDto) | |||||||||||||||||||
| |||||||||||||||||||
| terminalPosStatusId | integer <int32> (PosService.Contracts.Enums.TerminalPosStatus) Possible values:
| ||||||||||||||||||
| terminalPosStatus | string or null Terminal Status name. Active = 1 - terminal is online and ready to accept the POS transaction Busy = 2 - terminal is online, but cannot accept the POS transaction Offline = 3 - terminal is not subscribed for push notifications, or didn't respond before timeout issued | ||||||||||||||||||
{- "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
}The Transactions endpoint group is the fundamental means of managing purchases and refunds. Transactions in general are separated into two divisions: ACH transactions and cards transactions.
ACH transactions are payments processed through the ACH (automated clearing house) network. These are direct bank-to-bank transfers such as debits and credits. These transactions are typically processed in batches and settle or close within one to two business days.
To complete an ACH (automated clearing house) transaction, see ACH Transactions.
Card transactions are payments processed using a credit or debit card. These are processed through a card network such as Visa or Mastercard, among others. Card transaction operations support initiating the transaction, retrieving transaction details, and monitoring transaction status throughout processing. This processing has additional steps, such as verifying available funds, possibly declining the transaction request, holding the funds, and finally settling the request.
Card transactions are separated into two operations: One-step operations and two-step operations.
One-step operations are transactions that authorizes and captures the transaction in a single request. This allows processing a payment in one step or action by both approving the card and immediately completing the transaction. This is a common retail situation when the purchase price is finalized and known at the moment of the sale.
Two-step operations are transactions that authorize and capture the transaction in separate requests. Common situations for this are:
The following procedure is for completing a one-step operation.
Authenticate
Ensure a valid and current API token is available.
This is generated from the partner or merchant API key.
The API token is short-lived.
The 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.
Submit a Payment Transaction
Use the following endpoint to initiate or submit the payment transaction.
This endpoint combines authorization and capturing of a card transaction into one step.
POST {{baseURL}}/pay-api/v1/transactions/sale
This is an example of the minimal request body:
"currencyId": 1,
"expirationMonth": 12,
"amount": 642.99,
"accountNumber": "4000007640000003",
"expirationYear": 2028
}
This is an example of the return body, with the field transactionId noted.
This field references the transaction for subsequent endpoints, if needed.
...
"transactionId": "69c71dd2-36c7-4b57-9467-3a03b171f741",
...
}
Automatic Processing
Aurora receives the payment data from the endpoint.
It routes the transaction to the processing center.
The processor communicates with the customer’s bank for approval or denial.
It then relays the response back to the merchant site.
The client's app gets back the transaction result. This includes whether it was approved or declined. The app handles either case directly.
The following procedure is for completing a two-step operation.
Authenticate
Ensure a valid and current API token is available.
This is generated from the partner or merchant API key.
The API token is short-lived.
The 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.
Authorize
Use the following endpoint to authorize for the payment transaction.
Authorizing a payment transaction, or request, confirms that the payment method is valid.
If payment method is valid, it reserves, or puts a hold on, the funds.
It does not actually move funds yet.
The transaction can be rejected if the payment method is invalid and/or the requested funds are not available.
This endpoint attempts to authorize the transaction:
POST /pay-api/v1/transactions/auth
This is an example of the minimal request body:
{
"accountNumber": "4111111111111111",
"amount": 129.95,
"currencyId": 1,
"expirationMonth": 12,
"expirationYear": 2028
}
This is an example of the return body, with the field transactionId noted.
This field references the transaction for subsequent endpoints, if needed.
...
"transactionId": "2f41c881-7337-45b9-8dba-fa5d9711e2b1",
...
}
Add Optional Tip Amount
An optional tip amount may be added.
This amount is not necessarily included on the original base amount from the initial authorization.
The tip amount is updated on the authorized transaction before the final capture.
This endpoint adds a tip:
POST {{baseURL}}/pay-api/v1/transactions/tip-adjustment
This is an example of the request body.
The transactionId is the transactionId from the Authorization endpoint above:
{
"transactionId": "2f41c881-7337-45b9-8dba-fa5d9711e2b1",
"tipAmount": 10
}
Capture
Capture completes a previously authorized transaction and initiates the transfer of funds.
This endpoint captures the authorized funds and completes the transaction:
POST {{baseURL}}/pay-api/v1/transactions/capture
This is an example of the minimal request body.
For example, if the original authorization amount was $200 and a
tip-adjustment of $10 was later added with POST /pay-api/v1/transactions/tip-adjustment,
the amount here must be 210.
Any other value will fail the call.
The transactionId is the transactionId from the Authorization endpoint above.
{
"amount": "210",
"transactionId": "2f41c881-7337-45b9-8dba-fa5d9711e2b1"
}
GET {{baseURL}}/pay-api/v1/transactions
This endpoint returns a list of transactions details.
| page | integer <int32> Default: 0 Specifies the page number of the returned search results. A page is considered each set of the The maximum page value is the Values above the maximum page value will complete successfully but not return any items. Example: 0 |
| pageSize | integer <int32> Default: 15 Specifies the number of items for each page of the returned search results. A page is considered each set of the The maximum page value is the Example: 50 |
| orderBy | string Specifies the field the results get ordered by. The sort order is specified by the Example: contactName |
| asc | boolean Default: true Specifies the sort order is ascending. The sort field is specified by the If Example: true |
| createMethodId | integer <int32> Example: createMethodId=3 Specifies the Aurora ACH transaction creator type identifier. Example: 3 |
| createdById | string <uuid> Example: createdById=109fb6fb-91bf-442a-a9cb-051255ff72b0 Specifies the transaction creator's identifier. Example: 109fb6fb-91bf-442a-a9cb-051255ff72b0 |
| batchId | string <uuid> Example: batchId=44a56eab-82c8-46de-bc07-021371be4721 Specifies the identifier assigned to the batch that contains one or more ACH (automated clearing house) transactions. Example: 44a56eab-82c8-46de-bc07-021371be4721 |
| noBatch | boolean Default: true Example: noBatch=false Specifies the transaction should bypass normal ACH (automated clearing house) batching. The transaction will be processed individually instead of being grouped with other ACH transactions. If Example: false |
Array of objects or null (PaymentGateway.Contracts.PublicApi.Isv.Transactions.GetPage.GetIsvTransactionsResponse) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| total | integer <int32> | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total = amount of items, Items = transactions list 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
}
]
}GET {{baseURL}}/pay-api/v1/transactions/{{transactionId}}
This endpoint returns a transaction details by transaction identifier.
See Also:
To return a list of transactions, see POST /pay-api/v1/transactions
| transactionId required | string <uuid> Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 Specifies the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 |
| transactionId | string <uuid> Indicates the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionDateTime | string <date-time> Indicates the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the transaction execution. Examples: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionReceiptDto.AmountDto) Indicates an object detailing the amount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| currencyId | integer <int32> Indicates the Aurora currency identifier. Always set to 1. Example: 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| currency | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| processorId | string <uuid> | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| processor | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| operationTypeId | integer <int32> | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| operationType | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| paymentMethodTypeId | integer <int32> | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| paymentMethodType | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionTypeId | integer <int32> | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionType | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customerPan | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cardTokenType | integer <int32> (PaymentGateway.Contracts.Enums.TokenType) Identifies the card token type. Possible values:
Example: 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| statusId | integer <int32> | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantName | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantAddress | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantPhoneNumber | string or null <E.164> <= 20 characters ^(null|\+\d{1,20})$ Indicates the merchant's phone number. Example: +14155552309 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantEmailAddress | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| merchantWebsite | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| authCode | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.SourceResponseDto) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cardholderAuthenticationMethodId | integer <int32> (PaymentGateway.Contracts.Enums.CardholderAuthenticationMethod) Possible values:
Example: 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cardholderAuthenticationMethod | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cvmResultMsg | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cardDataSourceId | integer <int32> (PaymentGateway.Contracts.Enums.CardDataSource) Specifies the card data source. Possible values:
Example: 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cardDataSource | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| responseCode | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| responseDescription | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionReceiptDto.CardDetailsDto) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionReceiptDto.ElectronicCheckDetails) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects or null (PaymentGateway.Contracts.Enums.TransactionOperation) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AvsResponseDto) Address Verification Service Response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionReceiptDto.EmvTagsDto) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| orderNumber | string or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| baseAmount | number <double> Deprecated Identifies the original amount (in USD) of a transaction before adjustments are applied. Deprecated. Use Amount.BaseAmount Example: 129.99 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| totalAmount | number <double> Deprecated Deprecated. Use Amount.TotalAmount | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse.TsysCardDetailsDto) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse.AchDetailsDto) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "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"
}POST {{baseURL}}/pay-api/v1/transactions/auth
This endpoint authorizes a payment transaction.
This verifies that the customer's payment method is valid and that sufficient funds or credit are available.
See Also:
To capture or complete a transaction, see POST {/pay-api/v1/transactions/capture
To settle a transaction, see POST /pay-api/v1/transactions/settle
| amount required | number <double> Specifies the amount of the transaction. Example: 29.99 | ||||||||||||||||||||||||||||||
| accountNumber required | string Specifies the card number used for the transaction. This field may contain a token issued against a card number. This is de-tokenized by TransIT to process the transaction. Example: 4111111111111111 | ||||||||||||||||||||||||||||||
| currencyId required | integer <int32> Specifies the Aurora currency identifier. Always set to 1. Example: 1 | ||||||||||||||||||||||||||||||
| expirationMonth required | integer <int32> Specifies the expiration month of the card. Example: 7 | ||||||||||||||||||||||||||||||
| expirationYear required | integer <int32> Specifies the expiration year of the card. Example: 2032 | ||||||||||||||||||||||||||||||
| cardDataSource | integer <int32> (PaymentGateway.Contracts.Enums.CardDataSource) Specifies the card data source. Possible values:
Example: 2 | ||||||||||||||||||||||||||||||
| deviceId | string or null <uuid> Specifies the device when using the Arise Mobile app. If this value is included, the user is linked to that device.
This stores their name as the transaction creator Example: a30f9b66-b2f0-4b18-a03a-b861b00afa8b | ||||||||||||||||||||||||||||||
| paymentProcessorId | string or null <uuid> Specifies the payment processor identifier. Example: 37bd9ccb-2c9d-45cf-a65f-c9a224bdeaeb | ||||||||||||||||||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | ||||||||||||||||||||||||||||||
| paymentMethodId | string or null <uuid> Customer payment method ID | ||||||||||||||||||||||||||||||
| tipAmount | number or null <double> Specifies the absolute amount (in USD) of tip to be added. This amount adds to the number included in the field No additional tip amount or tip rate is required to be added, such as from tipAmount and tipRate are mutually exclusive.
Care must be taken to include one or the other but not both.
Example: 14.50 | ||||||||||||||||||||||||||||||
| tipRate | number or null <double> Specifies the tip rate as a percentage of the base amount to be added. This amount adds to the number included in the field No additional tip amount or tip rate is required to be added, such as from tipAmount and tipRate are mutually exclusive.
Care must be taken to include one or the other but not both.
Example: 15 (as 15%) | ||||||||||||||||||||||||||||||
| percentageOffRate | number or null <double> The percent of the base amount to be discounted. Example: | ||||||||||||||||||||||||||||||
| surchargeRate | number or null <double> The percent of transaction amount to be added to the amount after Example: | ||||||||||||||||||||||||||||||
| useCardPrice | boolean or null Parameter is mandatory when merchant has ZeroCostProcessingOption == Dual Pricing. Parameter must be null when merchant has other ZeroCostProcessingOption. For Dual Pricing, amount should be the card price and useCardPrice should
be | ||||||||||||||||||||||||||||||
| appVersion | string or null Specifies the version of the mobile app. This value is stored on the transaction.
It is visible in the transaction details.
The Example: 10.413.01 | ||||||||||||||||||||||||||||||
| sdkVersion | string or null Specifies the version of the Aurora SDK. This value is stored on the transaction.
It is visible in the transaction details.
The Example: 8.61.01 | ||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AddressDto) Specifies an object defining the address. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AddressDto) Specifies an object defining the address. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.ContactInfoDto) This group contains the customer's contact details. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
| securityCode | string or null The three or four digit security code on the credit card. | ||||||||||||||||||||||||||||||
| track1 | string or null The card data from track 1 of the magnetic stripe. | ||||||||||||||||||||||||||||||
| track2 | string or null Information stored on the magnetic stripe of a credit or debit card, including the card number, expiration date, and cardholder's name. | ||||||||||||||||||||||||||||||
| emvTags | Array of strings or null Each tag corresponds to a particular piece of data stored on the card. | ||||||||||||||||||||||||||||||
| emvPaymentAppVersion | string or null The version number of the payment application in use. | ||||||||||||||||||||||||||||||
| pin | string or null | ||||||||||||||||||||||||||||||
| pinKsn | string or null | ||||||||||||||||||||||||||||||
| emvFallbackCondition | integer <int32> (PaymentGateway.Contracts.Enums.EMVFallbackCondition) Possible values:
Example: 2 | ||||||||||||||||||||||||||||||
| emvFallbackLastChipRead | integer <int32> (PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead) Possible values:
Example: 1 | ||||||||||||||||||||||||||||||
| referenceId | string or null Specifies an external transaction identifier for client-side tracking. Also used in duplicate control validation. A unique value allows similar transactions to process as distinct, bypassing duplicate blocking when needed. | ||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL2Data) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL3Data) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
| customerInitiatedTransaction | boolean Customer Initiated Transaction if true Merchant Initiated Transaction if false Default value - false. | ||||||||||||||||||||||||||||||
| transactionId | string <uuid> Identifies the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionDateTime | string <date-time> Specifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the transaction execution. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| typeId | integer <int32> Type id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | string or null Type name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| statusId | integer <int32> Indicates the status identifier of the transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string or null Indicates the status name of the transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (PaymentGateway.Contracts.Transactions.TransactionReceiptDto)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| processedAmount | number <double> Indicates which amount is authorized. The amount may differ from the amount in the request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AvsResponseDto) Address Verification Service Response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "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
}Transaction, type Authorization, status = Authorized. Transaction status after an approved pre-authorization request
{- "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
}
}POST {{baseURL}}/pay-api/v1/transactions/sale
This endpoint completes a transaction in a single step.
It combines the two actions of authorizing and capturing a transaction into a single endpoint. Use this endpoint when the final amount is known and will not change. The transaction can be made immediately.
See Also:
To authorize a transaction, see POST /pay-api/v1/transactions/auth
To capture or complete a transaction, see POST {/pay-api/v1/transactions/capture
To settle a transaction, see POST /pay-api/v1/transactions/settle
| amount required | number <double> Specifies the amount of the transaction. Example: 64.99 | ||||||||||||||||||||||||||||||
| accountNumber required | string Specifies the 13-19 digit card number used for the transaction. This field may contain a token issued against a card number. This is de-tokenized by TransIT to process the transaction. | ||||||||||||||||||||||||||||||
| cardDataSource required | integer <int32> (PaymentGateway.Contracts.Enums.CardDataSource) Specifies the card data source. Possible values:
Example: 2 | ||||||||||||||||||||||||||||||
| currencyId required | integer <int32> Specifies the Aurora currency identifier. Always set to 1. Example: 1 | ||||||||||||||||||||||||||||||
| expirationMonth required | integer <int32> Specifies the expiration month of the card. Example: 7 | ||||||||||||||||||||||||||||||
| expirationYear required | integer <int32> Specifies the expiration year of the card. Example: 2032 | ||||||||||||||||||||||||||||||
| deviceId | string or null <uuid> Specifies the device when using the Arise Mobile app. If this value is included, the user is linked to that device.
This stores their name as the transaction creator Example: a30f9b66-b2f0-4b18-a03a-b861b00afa8b | ||||||||||||||||||||||||||||||
| paymentProcessorId | string or null <uuid> Specifies the payment processor identifier. Example: 8ebb41c8-e1b0-4777-8f8e-1402e756ee7d | ||||||||||||||||||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | ||||||||||||||||||||||||||||||
| paymentMethodId | string or null <uuid> Specifies the customer payment method identifier. | ||||||||||||||||||||||||||||||
| tipAmount | number or null <double> Specifies the absolute amount (in USD) of tip to be added. This amount adds to the base amount of the original transaction. That transaction must be authorized first. Values fortipAmount and tipRate are mutually exclusive.
Care must be taken to include one or the other but not both.
Example: 14.50 | ||||||||||||||||||||||||||||||
| tipRate | number or null <double> Specifies the tip rate as a percentage of the base amount to be added. This amount adds to the base amount of the original transaction. That transaction must be authorized first. Values fortipAmount and tipRate are mutually exclusive.
Care must be taken to include one or the other but not both.
Example: 15 (as 15%) | ||||||||||||||||||||||||||||||
| percentageOffRate | number or null <double> Identifies the discount percentage. This value is percentage rate for the discount. Example: 3.5 (as 3.5%) | ||||||||||||||||||||||||||||||
| surchargeRate | number or null <double> Identifies the surcharge percentage. This is a surcharge on the base amount.
This value is surcharge percentage rate.
This surcharge percentage calculates the surcharge amount for Example: 1.5 (as 1.5%) | ||||||||||||||||||||||||||||||
| useCardPrice | boolean or null Parameter is mandatory when merchant has ZeroCostProcessingOption == Dual Pricing. Parameter must be null when merchant has other ZeroCostProcessingOption. For Dual Pricing, amount should be the card price and useCardPrice should be | ||||||||||||||||||||||||||||||
| appVersion | string or null Specifies the version of the mobile app. This value is stored on the transaction.
It is visible in the transaction details.
The Example: 10.413.01 | ||||||||||||||||||||||||||||||
| sdkVersion | string or null Specifies the version of the Aurora SDK. This value is stored on the transaction.
It is visible in the transaction details.
The Example: 8.61.08 | ||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AddressDto) Specifies an object defining the address. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AddressDto) Specifies an object defining the address. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.ContactInfoDto) This group contains the customer's contact details. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
| securityCode | string or null Specifies the three or four digit security code on the credit card. | ||||||||||||||||||||||||||||||
| track1 | string or null Specifies the card data from track 1 of the magnetic stripe. | ||||||||||||||||||||||||||||||
| track2 | string or null Information stored on the magnetic stripe of a credit or debit card. This includes the card number, expiration date, and cardholder's name. | ||||||||||||||||||||||||||||||
| emvTags | Array of strings or null Each tag corresponds to a particular piece of data stored on the card. | ||||||||||||||||||||||||||||||
| emvPaymentAppVersion | string or null Specifies the version number of the payment application in use. | ||||||||||||||||||||||||||||||
| pin | string or null Specifies the encrypted PIN for the terminal. | ||||||||||||||||||||||||||||||
| pinKsn | string or null Specifies the KSN for DUKPT PIN encryption. Required only if the PIN is encrypted using DUKPT. | ||||||||||||||||||||||||||||||
| debit | boolean or null IF Debit THEN use card as a debit card, else use card as a credit card | ||||||||||||||||||||||||||||||
| emvFallbackCondition | integer <int32> (PaymentGateway.Contracts.Enums.EMVFallbackCondition) Possible values:
Example: 2 | ||||||||||||||||||||||||||||||
| emvFallbackLastChipRead | integer <int32> (PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead) Possible values:
Example: 1 | ||||||||||||||||||||||||||||||
| referenceId | string or null Specifies an external transaction identifier for client-side tracking. Also used in duplicate control validation. A unique value allows similar transactions to process as distinct, bypassing duplicate blocking when needed. | ||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL2Data) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL3Data) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
| customerInitiatedTransaction | boolean Default: false Customer Initiated Transaction if true. Merchant Initiated Transaction if false | ||||||||||||||||||||||||||||||
| transactionId | string <uuid> Identifies the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionDateTime | string <date-time> Specifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the transaction execution. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| typeId | integer <int32> Type id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | string or null Type name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| statusId | integer <int32> Indicates the status identifier of the transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string or null Indicates the status name of the transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (PaymentGateway.Contracts.Transactions.TransactionReceiptDto)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| processedAmount | number <double> Indicates which amount is authorized. The amount may differ from the amount in the request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AvsResponseDto) Address Verification Service Response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "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
}Transaction, type Authorization, status = Authorized. Transaction status after an approved pre-authorization request
{- "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
}
}POST {{baseURL}}/pay-api/v1/transactions/capture
This endpoint captures a previously authorized transaction.
The capture must reference an existing authorized transaction. It intends to convert the authorization hold into a completed charge that will be submitted for settlement. When a transaction is first authorized, the customer’s bank places a temporary hold on the funds. Those funds are not transfer the money yet. A capture confirms that the merchant intends to collect those funds and finalizes the transaction. Once captured, the transaction cannot be voided.
For example, a customer orders $100 at a restaurant. The charge is authorized but the funds are not paid yet. The customer is waiting to add a tip amount. After the tip is included and a new amount is agreed on, the transaction is captured. Now, the funds are released for payment.
See Also:
To authorize a transaction, see POST /pay-api/v1/transactions/auth
To refund a settled transaction, see POST /pay-api/v1/transactions/return
To capture an amount for funds transfer, see POST /pay-api/v1/transactions/capture
| amount required | number <double> Specifies the base amount of the transaction before adjustments (if any). Adjustments, such as tips, discounts, and surcharges, are added individually through request parameters.
The call makes all adjustments during processing.
The total amount charged is returned in the response body Example: 124.86 |
| transactionId required | string <uuid> Specifies the transactionId from the original authorization. After the transaction is complete, the transactionId is invalidated for future attempts. Example: 19be194d-d962-41e2-bba0-ee719ed94634 |
| transactionId | string <uuid> Indicates the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionDateTime | string <date-time> Indicates the date-time (in ISO 8601 UTC or timezone offset format) of the transaction. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| typeId | integer <int32> Type id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | string or null Type name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| statusId | integer <int32> Status id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string or null Status name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (PaymentGateway.Contracts.Transactions.TransactionReceiptDto)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "amount": 123.45,
- "transactionId": "4b25e010-5a4a-4bd0-9961-0cff14bdb41b"
}{- "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
- "transactionDateTime": "2026-08-24T08:45:22Z",
- "typeId": 0,
- "type": "string",
- "statusId": 0,
- "status": "string",
- "details": {
- "hostResponseCode": "string",
- "hostResponseMessage": "string",
- "hostResponseDefinition": "string",
- "code": "string",
- "message": "string",
- "processorResponseCode": "string",
- "authCode": "string",
- "maskedPan": "string"
}, - "transactionReceipt": {
- "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
- "transactionDateTime": "2026-02-19T20:24:52.934+05:30",
- "amount": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountRate": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "tipAmount": 14.5,
- "tipRate": 15,
- "totalAmount": 3219.45
}, - "currencyId": 1,
- "currency": "string",
- "processorId": "a15deb33-4fe1-4eb8-a25b-fe51bc081cca",
- "processor": "string",
- "operationTypeId": 0,
- "operationType": "string",
- "paymentMethodTypeId": 0,
- "paymentMethodType": "string",
- "transactionTypeId": 0,
- "transactionType": "string",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "customerPan": "string",
- "cardTokenType": 2,
- "statusId": 0,
- "status": "string",
- "merchantName": "string",
- "merchantAddress": "string",
- "merchantPhoneNumber": "+14155552309",
- "merchantEmailAddress": "string",
- "merchantWebsite": "string",
- "authCode": "string",
- "source": {
- "typeId": 0,
- "type": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "cardholderAuthenticationMethodId": 0,
- "cardholderAuthenticationMethod": "string",
- "cvmResultMsg": "string",
- "cardDataSourceId": 2,
- "cardDataSource": "string",
- "responseCode": "string",
- "responseDescription": "string",
- "cardProcessingDetails": {
- "authCode": "string",
- "mid": "string",
- "tid": "string",
- "cardCreditDebitTypeId": 0,
- "cardCreditDebitType": "string",
- "processCreditDebitTypeId": 0,
- "processCreditDebitType": "string",
- "rrn": "string",
- "cardTypeId": 0,
- "cardType": "string"
}, - "achProcessingDetails": {
- "customerAccountNumber": "string",
- "customerRoutingNumber": "string",
- "accountHolderType": "string",
- "accountHolderTypeId": 0,
- "accountType": "string",
- "accountTypeId": 0,
- "taxId": "string"
}, - "availableOperations": [
- {
- "typeId": 0,
- "type": "string",
- "availableAmount": 0.1,
- "suggestedTips": [
- {
- "tipAmount": 14.5,
- "tipPercent": 15
}
]
}
], - "avsResponse": {
- "actionId": 1,
- "action": "string",
- "responseCode": "string",
- "groupId": 5,
- "group": "string",
- "resultId": 1,
- "result": "string",
- "codeDescription": "string"
}, - "emvTags": {
- "ac": "string",
- "tvr": "string",
- "tsi": "string",
- "aid": "string",
- "applicationLabel": "string",
- "rawTags": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "orderNumber": "string"
}
}POST {{baseURL}}/pay-api/v1/transactions/return
This endpoint refunds or returns funds from an original transaction identifier.
This creates a refund transaction that is linked to a specific previous transaction.
See Also:
To refund without a transaction identifier, see POST /pay-api/v1/transactions/return/no-reference
To settle a transaction, see POST /pay-api/v1/transactions/settle
| cardDataSource required | integer <int32> (PaymentGateway.Contracts.Enums.CardDataSource) Specifies the card data source. Possible values:
Example: 2 | ||||||||||||||||||||||||
| transactionId required | string <uuid> Specifies the transaction identifier. Example: 94c59697-3db4-4ef7-84f7-b1cc14f21d93 | ||||||||||||||||||||||||
| track1 | string or null The card data from track 1 of the magnetic stripe. | ||||||||||||||||||||||||
| track2 | string or null Information stored on the magnetic stripe of a credit or debit card, including the card number, expiration date, and cardholder's name. | ||||||||||||||||||||||||
| emvTags | Array of strings or null Each tag corresponds to a particular piece of data stored on the card. | ||||||||||||||||||||||||
| emvPaymentAppVersion | string or null The version number of the payment application in use. | ||||||||||||||||||||||||
| pin | string or null | ||||||||||||||||||||||||
| pinKsn | string or null | ||||||||||||||||||||||||
| amount | number or null <double> Amount |
| transactionId | string <uuid> Indicates the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionDateTime | string <date-time> Indicates the date-time (in ISO 8601 UTC or timezone offset format) of the transaction. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| typeId | integer <int32> Type id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | string or null Type name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| statusId | integer <int32> Status id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string or null Status name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (PaymentGateway.Contracts.Transactions.TransactionReceiptDto)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Id is required
{- "track1": null,
- "track2": null,
- "emvTags": null,
- "emvPaymentAppVersion": null,
- "cardDataSource": 1,
- "pin": null,
- "pinKsn": null,
- "transactionId": "debb3098-3ca0-4b8b-b28d-d3a1c3e50e66",
- "amount": null
}{- "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
- "transactionDateTime": "2026-08-24T08:45:22Z",
- "typeId": 0,
- "type": "string",
- "statusId": 0,
- "status": "string",
- "details": {
- "hostResponseCode": "string",
- "hostResponseMessage": "string",
- "hostResponseDefinition": "string",
- "code": "string",
- "message": "string",
- "processorResponseCode": "string",
- "authCode": "string",
- "maskedPan": "string"
}, - "transactionReceipt": {
- "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
- "transactionDateTime": "2026-02-19T20:24:52.934+05:30",
- "amount": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountRate": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "tipAmount": 14.5,
- "tipRate": 15,
- "totalAmount": 3219.45
}, - "currencyId": 1,
- "currency": "string",
- "processorId": "a15deb33-4fe1-4eb8-a25b-fe51bc081cca",
- "processor": "string",
- "operationTypeId": 0,
- "operationType": "string",
- "paymentMethodTypeId": 0,
- "paymentMethodType": "string",
- "transactionTypeId": 0,
- "transactionType": "string",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "customerPan": "string",
- "cardTokenType": 2,
- "statusId": 0,
- "status": "string",
- "merchantName": "string",
- "merchantAddress": "string",
- "merchantPhoneNumber": "+14155552309",
- "merchantEmailAddress": "string",
- "merchantWebsite": "string",
- "authCode": "string",
- "source": {
- "typeId": 0,
- "type": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "cardholderAuthenticationMethodId": 0,
- "cardholderAuthenticationMethod": "string",
- "cvmResultMsg": "string",
- "cardDataSourceId": 2,
- "cardDataSource": "string",
- "responseCode": "string",
- "responseDescription": "string",
- "cardProcessingDetails": {
- "authCode": "string",
- "mid": "string",
- "tid": "string",
- "cardCreditDebitTypeId": 0,
- "cardCreditDebitType": "string",
- "processCreditDebitTypeId": 0,
- "processCreditDebitType": "string",
- "rrn": "string",
- "cardTypeId": 0,
- "cardType": "string"
}, - "achProcessingDetails": {
- "customerAccountNumber": "string",
- "customerRoutingNumber": "string",
- "accountHolderType": "string",
- "accountHolderTypeId": 0,
- "accountType": "string",
- "accountTypeId": 0,
- "taxId": "string"
}, - "availableOperations": [
- {
- "typeId": 0,
- "type": "string",
- "availableAmount": 0.1,
- "suggestedTips": [
- {
- "tipAmount": 14.5,
- "tipPercent": 15
}
]
}
], - "avsResponse": {
- "actionId": 1,
- "action": "string",
- "responseCode": "string",
- "groupId": 5,
- "group": "string",
- "resultId": 1,
- "result": "string",
- "codeDescription": "string"
}, - "emvTags": {
- "ac": "string",
- "tvr": "string",
- "tsi": "string",
- "aid": "string",
- "applicationLabel": "string",
- "rawTags": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "orderNumber": "string"
}
}POST {{baseURL}}/pay-api/v1/transactions/return/no-reference
This endpoint refunds or returns funds without a reference.
Without a reference means the customer does not have the link to the original transaction identifier. This creates a refund transaction that is not linked to a specific previous transaction. Instead of refunding a known transaction identifier, the system processes a standalone credit back to the cardholder’s payment method.
The endpoint requires the administrative API permission: Ecommerce Refund Without Reference.
See Also:
To refund using a transaction identifier, see POST /pay-api/v1/transactions/return
To settle a transaction, see POST /pay-api/v1/transactions/settle
| cardDataSource required | integer <int32> (PaymentGateway.Contracts.Enums.CardDataSource) Specifies the card data source. Possible values:
Example: 2 | ||||||||||||||||||||||||
| currencyId required | integer <int32> Specifies the Aurora currency identifier. Always set to 1. Example: 1 | ||||||||||||||||||||||||
| debit required | boolean Specifies the card as a debit card. If Example: true | ||||||||||||||||||||||||
| paymentProcessorId required | string <uuid> Specifies the identifier assigned to the payment processor. Example: 0c16d6e5-6157-42f0-a285-d14abbc54faa | ||||||||||||||||||||||||
| customerId | string or null <uuid> Specifies the customer identifier. This is used when saving the payment method. Example: fd9198a4-eb6f-4620-9603-4f4638289de5 | ||||||||||||||||||||||||
| amount | number <double> The amount of the transaction. | ||||||||||||||||||||||||
| accountNumber | string or null The 13-19 digit card number used for the transaction. This field may contain a token issued against a card number. This is de-tokenized by TransIT to process the transaction. Example: 5413591081013511 example: "5413591081013511" | ||||||||||||||||||||||||
| securityCode | string or null The three or four digit security code on the credit card. | ||||||||||||||||||||||||
| expirationMonth | integer or null <int32> The expiration month of the card | ||||||||||||||||||||||||
| expirationYear | integer or null <int32> The expiration year of the card | ||||||||||||||||||||||||
| track1 | string or null Magnetic track 1. | ||||||||||||||||||||||||
| track2 | string or null Magnetic track 2. | ||||||||||||||||||||||||
| emvTags | Array of strings or null Holds data fetched from a EMV Chip Credit/Debit card to perform transaction. That is a string array of variable size, should be used as is. | ||||||||||||||||||||||||
| emvPaymentAppVersion | string or null The version number of the payment application in use. | ||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AddressDto) Specifies an object defining the address. | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AddressDto) Specifies an object defining the address. | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.ContactInfoDto) This group contains the customer's contact details. | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
| pin | string or null Encrypted PIN for the terminal. | ||||||||||||||||||||||||
| pinKsn | string or null The KSN for DUKPT PIN encryption. Required only if the PIN is encrypted using DUKPT. | ||||||||||||||||||||||||
| emvFallbackCondition | integer <int32> (PaymentGateway.Contracts.Enums.EMVFallbackCondition) Possible values:
Example: 2 | ||||||||||||||||||||||||
| emvFallbackLastChipRead | integer <int32> (PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead) Possible values:
Example: 1 | ||||||||||||||||||||||||
| referenceId | string or null Specifies an external transaction identifier for client-side tracking. Also used in duplicate control validation. A unique value allows similar transactions to process as distinct, bypassing duplicate blocking when needed. | ||||||||||||||||||||||||
| transactionId | string <uuid> Identifies the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionDateTime | string <date-time> Specifies the date-time (in an ISO 8601 date-time UTC or time zone offset format) of the transaction execution. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| typeId | integer <int32> Type id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | string or null Type name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| statusId | integer <int32> Indicates the status identifier of the transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string or null Indicates the status name of the transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (PaymentGateway.Contracts.Transactions.TransactionReceiptDto)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| processedAmount | number <double> Indicates which amount is authorized. The amount may differ from the amount in the request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.AvsResponseDto) Address Verification Service Response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "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"
}Transaction, type Authorization, status = Authorized. Transaction status after an approved pre-authorization request
{- "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
}
}POST {{baseURL}}/pay-api/v1/transactions/settle
This endpoint settles, or completes, a transaction.
A settlement transaction is the step in the payment process when an authorized transaction is finalized. The funds are transferred to the merchant's acquiring bank.
See Also:
To authorize a transaction, see POST /pay-api/v1/transactions/auth
To refund a settled transaction, see POST /pay-api/v1/transactions/return
| paymentProcessorId required | string <uuid> Specifies the payment processor identifier. Example: 8f5a4c27-71c4-4b5d-944e-8bb457594d86 |
| code | integer <int32> (PaymentGateway.Contracts.Enums.ResponseCode) xxx A vendor independent response code. Possible values:
Example: 0 | ||||||||||||
| message | string or null Free-form result description. | ||||||||||||
| processorResponseCode | string or null Processor-specific response code that precisely describes the operation result. |
{- "paymentProcessorId": "b72b54b3-de02-430c-80c3-2908167d817c"
}{- "code": 0,
- "message": "string",
- "processorResponseCode": "string"
}POST {{baseURL}}/pay-api/v1/transactions/void
This endpoint voids or cancels a transaction payment before it is processed or settled.
The transaction cannot be voided after it has been captured.
See Also:
To authorize a transaction, see POST /pay-api/v1/transactions/auth
To refund a settled transaction, see POST /pay-api/v1/transactions/return
To capture an amount for funds transfer, see POST /pay-api/v1/transactions/capture
| transactionId required | string <uuid> Specifies the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 |
| transactionId | string <uuid> Indicates the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionDateTime | string <date-time> Indicates the date-time (in ISO 8601 UTC or timezone offset format) of the transaction. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| typeId | integer <int32> Type id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | string or null Type name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| statusId | integer <int32> Status id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string or null Status name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (PaymentGateway.Contracts.Transactions.TransactionReceiptDto)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "transactionId": "881eabbc-6138-4677-9d37-592e7dca46f3"
}{- "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
- "transactionDateTime": "2026-08-24T08:45:22Z",
- "typeId": 0,
- "type": "string",
- "statusId": 0,
- "status": "string",
- "details": {
- "hostResponseCode": "string",
- "hostResponseMessage": "string",
- "hostResponseDefinition": "string",
- "code": "string",
- "message": "string",
- "processorResponseCode": "string",
- "authCode": "string",
- "maskedPan": "string"
}, - "transactionReceipt": {
- "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
- "transactionDateTime": "2026-02-19T20:24:52.934+05:30",
- "amount": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountRate": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "tipAmount": 14.5,
- "tipRate": 15,
- "totalAmount": 3219.45
}, - "currencyId": 1,
- "currency": "string",
- "processorId": "a15deb33-4fe1-4eb8-a25b-fe51bc081cca",
- "processor": "string",
- "operationTypeId": 0,
- "operationType": "string",
- "paymentMethodTypeId": 0,
- "paymentMethodType": "string",
- "transactionTypeId": 0,
- "transactionType": "string",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "customerPan": "string",
- "cardTokenType": 2,
- "statusId": 0,
- "status": "string",
- "merchantName": "string",
- "merchantAddress": "string",
- "merchantPhoneNumber": "+14155552309",
- "merchantEmailAddress": "string",
- "merchantWebsite": "string",
- "authCode": "string",
- "source": {
- "typeId": 0,
- "type": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "cardholderAuthenticationMethodId": 0,
- "cardholderAuthenticationMethod": "string",
- "cvmResultMsg": "string",
- "cardDataSourceId": 2,
- "cardDataSource": "string",
- "responseCode": "string",
- "responseDescription": "string",
- "cardProcessingDetails": {
- "authCode": "string",
- "mid": "string",
- "tid": "string",
- "cardCreditDebitTypeId": 0,
- "cardCreditDebitType": "string",
- "processCreditDebitTypeId": 0,
- "processCreditDebitType": "string",
- "rrn": "string",
- "cardTypeId": 0,
- "cardType": "string"
}, - "achProcessingDetails": {
- "customerAccountNumber": "string",
- "customerRoutingNumber": "string",
- "accountHolderType": "string",
- "accountHolderTypeId": 0,
- "accountType": "string",
- "accountTypeId": 0,
- "taxId": "string"
}, - "availableOperations": [
- {
- "typeId": 0,
- "type": "string",
- "availableAmount": 0.1,
- "suggestedTips": [
- {
- "tipAmount": 14.5,
- "tipPercent": 15
}
]
}
], - "avsResponse": {
- "actionId": 1,
- "action": "string",
- "responseCode": "string",
- "groupId": 5,
- "group": "string",
- "resultId": 1,
- "result": "string",
- "codeDescription": "string"
}, - "emvTags": {
- "ac": "string",
- "tvr": "string",
- "tsi": "string",
- "aid": "string",
- "applicationLabel": "string",
- "rawTags": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "orderNumber": "string"
}
}POST {{baseURL}}/pay-api/v1/transactions/tip-adjustment
This endpoint adjusts the tip amount.
This must be on a previously authorized transaction before settlement. Typically, the transaction is authorized first and for the base amount only. This endpoint adds an additional amount, the tip, above that base amount. The total amount from the original base amount is adjusted with the tip amount for settlement.
See Also:
To authorize a transaction, see POST /pay-api/v1/transactions/auth
| transactionId required | string <uuid> Specifies the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 |
| tipAmount required | number <double> Specifies the absolute amount (in USD) of tip to be added. This amount adds to the base amount of the original transaction. That transaction must be authorized first. Example: 14.50 |
| transactionId | string <uuid> Indicates the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transactionDateTime | string <date-time> Indicates the date-time (in ISO 8601 UTC or timezone offset format) of the transaction. Examples: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| typeId | integer <int32> Type id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | string or null Type name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| statusId | integer <int32> Status id of transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string or null Status name of transaction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (PaymentGateway.Contracts.Transactions.TransactionReceiptDto)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "transactionId": "f7b48aea-0b3a-40a6-b005-c2d840f71ff7",
- "tipAmount": 10
}{- "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
- "transactionDateTime": "2026-08-24T08:45:22Z",
- "typeId": 0,
- "type": "string",
- "statusId": 0,
- "status": "string",
- "details": {
- "hostResponseCode": "string",
- "hostResponseMessage": "string",
- "hostResponseDefinition": "string",
- "code": "string",
- "message": "string",
- "processorResponseCode": "string",
- "authCode": "string",
- "maskedPan": "string"
}, - "transactionReceipt": {
- "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
- "transactionDateTime": "2026-02-19T20:24:52.934+05:30",
- "amount": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 10.55,
- "cashDiscountRate": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "tipAmount": 14.5,
- "tipRate": 15,
- "totalAmount": 3219.45
}, - "currencyId": 1,
- "currency": "string",
- "processorId": "a15deb33-4fe1-4eb8-a25b-fe51bc081cca",
- "processor": "string",
- "operationTypeId": 0,
- "operationType": "string",
- "paymentMethodTypeId": 0,
- "paymentMethodType": "string",
- "transactionTypeId": 0,
- "transactionType": "string",
- "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
- "customerPan": "string",
- "cardTokenType": 2,
- "statusId": 0,
- "status": "string",
- "merchantName": "string",
- "merchantAddress": "string",
- "merchantPhoneNumber": "+14155552309",
- "merchantEmailAddress": "string",
- "merchantWebsite": "string",
- "authCode": "string",
- "source": {
- "typeId": 0,
- "type": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "cardholderAuthenticationMethodId": 0,
- "cardholderAuthenticationMethod": "string",
- "cvmResultMsg": "string",
- "cardDataSourceId": 2,
- "cardDataSource": "string",
- "responseCode": "string",
- "responseDescription": "string",
- "cardProcessingDetails": {
- "authCode": "string",
- "mid": "string",
- "tid": "string",
- "cardCreditDebitTypeId": 0,
- "cardCreditDebitType": "string",
- "processCreditDebitTypeId": 0,
- "processCreditDebitType": "string",
- "rrn": "string",
- "cardTypeId": 0,
- "cardType": "string"
}, - "achProcessingDetails": {
- "customerAccountNumber": "string",
- "customerRoutingNumber": "string",
- "accountHolderType": "string",
- "accountHolderTypeId": 0,
- "accountType": "string",
- "accountTypeId": 0,
- "taxId": "string"
}, - "availableOperations": [
- {
- "typeId": 0,
- "type": "string",
- "availableAmount": 0.1,
- "suggestedTips": [
- {
- "tipAmount": 14.5,
- "tipPercent": 15
}
]
}
], - "avsResponse": {
- "actionId": 1,
- "action": "string",
- "responseCode": "string",
- "groupId": 5,
- "group": "string",
- "resultId": 1,
- "result": "string",
- "codeDescription": "string"
}, - "emvTags": {
- "ac": "string",
- "tvr": "string",
- "tsi": "string",
- "aid": "string",
- "applicationLabel": "string",
- "rawTags": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "orderNumber": "string"
}
}POST {{baseURL}}/pay-api/v1/transactions/{{transactionId}}/send-transaction-receipt-by-sms
This endpoint sends a transaction receipt to the customer by SMS.
| transactionId required | string <uuid> Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 Specifies the transaction identifier. Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7 |
| phoneNumber required | string <E.164> [ 1 .. 20 ] characters ^(null|\+\d{1,20})$ Identifies the customer's phone number. Example: +15551234567 |
| customerConsent required | boolean Identifies the customer has consented to receiving the SMS. If Example: true |
| phoneNumber required | string <E.164> [ 1 .. 20 ] characters ^(null|\+\d{1,20})$ Identifies the customer's phone number. Example: +15551234567 |
| customerConsent required | boolean Identifies the customer has consented to receiving the SMS. If Example: true |
{- "phoneNumber": "+15551234567",
- "customerConsent": true
}{- "phoneNumber": "+15551234567",
- "customerConsent": true
}GET {{baseURL}}/pay-api/v1/transactions/calculate-amount
This endpoint calculates adjusts to the base transaction amount to be charged to the customer.
The amount considers applicable discounts, surcharges, and tips, This includes any ZCP (zero cost processing) mode enabled for the merchant account, such as dual pricing, cash discounts, or credit card surcharges.
The calculated amounts are for information only. Applications, such as payment terminals or point of service devices, can display the appropriate values. For example, clients could review the suggestions before submitting the payment.
| amount | number <double> Example: amount=29.49 Specifies the base transaction amount before discounts and fees. Example: 29.49 |
| percentageOffRate | number <double> Example: percentageOffRate=25 Specifies the percentage off or the discount rate. Example: 25 (for 25%) |
| surchargeRate | number <double> Example: surchargeRate=15 Specifies the credit card surcharge rate. It may be omitted to use the default credit card surcharge rate setting in the merchant account. Example: 15 (for 15%) |
| tipAmount | number <double> Example: tipAmount=62.38 Specifies the absolute amount (in USD) of tip to be added. Values fortipAmount and tipRate are mutually exclusive.
Care must be taken to include one or the other but not both.
|
| tipRate | number <double> Example: tipRate=18 Specifies the relative value of tip to be added. Values fortipAmount and tipRate are mutually exclusive.
Care must be taken to include one or the other but not both.
Example: 18 (for 18%) |
| currencyId | integer <int32> Example: currencyId=1 Specifies the the Aurora currency code. It must be 1 (for USD). Example: 1 |
| useCardPrice | boolean Default: true Example: useCardPrice=true Specifies to calculate the transaction amount for card payment. If Example: true |
| currencyId | integer <int32> (PaymentGateway.Contracts.Enums.Currency) Possible values:
Example: 1 | ||||||||||||||||||||||||||
| currency | string or null | ||||||||||||||||||||||||||
| zeroCostProcessingOptionId | integer <int32> (PaymentGateway.Contracts.Enums.ZeroCostProcessingOption)
Possible values:
Example: 3 | ||||||||||||||||||||||||||
| zeroCostProcessingOption | string or null Zero Cost Processing Option name. Possible values:
Example: DualPricing | ||||||||||||||||||||||||||
| useCardPrice | boolean or null | ||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Amounts.AmountDto) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Amounts.AmountDto) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Amounts.AmountDto) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (PaymentGateway.Contracts.Amounts.AmountDto) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
{- "currencyId": 1,
- "currency": "string",
- "zeroCostProcessingOptionId": 3,
- "zeroCostProcessingOption": "DualPricing",
- "useCardPrice": true,
- "cash": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 0.1,
- "cashDiscountRate": 1.5,
- "cashDiscountPercentage": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "tipAmount": 14.5,
- "tipRate": 15,
- "taxAmount": 0.1,
- "taxRate": 0.1,
- "totalAmount": 3219.45
}, - "creditCard": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 0.1,
- "cashDiscountRate": 1.5,
- "cashDiscountPercentage": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "tipAmount": 14.5,
- "tipRate": 15,
- "taxAmount": 0.1,
- "taxRate": 0.1,
- "totalAmount": 3219.45
}, - "debitCard": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 0.1,
- "cashDiscountRate": 1.5,
- "cashDiscountPercentage": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "tipAmount": 14.5,
- "tipRate": 15,
- "taxAmount": 0.1,
- "taxRate": 0.1,
- "totalAmount": 3219.45
}, - "ach": {
- "baseAmount": 129.99,
- "percentageOffAmount": 12.5,
- "percentageOffRate": 3.5,
- "cashDiscountAmount": 0.1,
- "cashDiscountRate": 1.5,
- "cashDiscountPercentage": 1.5,
- "surchargeAmount": 6.45,
- "surchargeRate": 1.5,
- "tipAmount": 14.5,
- "tipRate": 15,
- "taxAmount": 0.1,
- "taxRate": 0.1,
- "totalAmount": 3219.45
}
}GET {{baseURL}}/pay-api/v1/transactions/settings/autofill
object (PaymentGateway.Contracts.TransactionSettings.L2Settings) | |||||||||||||||||||||||
| |||||||||||||||||||||||
object (PaymentGateway.Contracts.TransactionSettings.L3Settings) | |||||||||||||||||||||||
| |||||||||||||||||||||||
{- "l2Settings": {
- "taxRate": 0.1
}, - "l3Settings": {
- "product": {
- "name": "string",
- "code": "string",
- "unitPrice": 0.1,
- "measurementUnit": "string",
- "quantity": 0.1,
- "discountPercentage": 0.1,
- "description": "string"
}, - "shippingCharge": 0.1,
- "dutyChargeRate": 0.1
}
}PUT {{baseURL}}/pay-api/v1/transactions/settings/autofill
required | object (PaymentGateway.Contracts.TransactionSettings.L2Settings) | ||||||||||||||||||||||
| |||||||||||||||||||||||
required | object (PaymentGateway.Contracts.TransactionSettings.L3Settings) | ||||||||||||||||||||||
| |||||||||||||||||||||||
{- "l2Settings": {
- "taxRate": 0.1
}, - "l3Settings": {
- "product": {
- "name": "string",
- "code": "string",
- "unitPrice": 0.1,
- "measurementUnit": "string",
- "quantity": 0.1,
- "discountPercentage": 0.1,
- "description": "string"
}, - "shippingCharge": 0.1,
- "dutyChargeRate": 0.1
}
}{- "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": "<Service>",
- "exceptionType": "FluentValidation.ValidationException",
- "correlationId": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69",
- "entityId": null,
- "errorCode": null
}