Created
September 19, 2024 01:53
-
-
Save jay-babu/1bc76d6da51dd9f107acd18d96703af7 to your computer and use it in GitHub Desktop.
Payrix
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| components: | |
| schemas: | |
| txnsCreateFields: | |
| properties: | |
| address1: | |
| description: "The first line of the address associated with this Transaction.\ | |
| \ \nThis field is stored as a text string and must be between 1 and 500\ | |
| \ characters long." | |
| type: string | |
| address2: | |
| description: "The second line of the address associated with this Transaction.\ | |
| \ \nThis field is stored as a text string and must be between 1 and 500\ | |
| \ characters long." | |
| type: string | |
| allowPartial: | |
| description: "Whether to allow partial amount authorizations of this Transaction.\ | |
| \ \nFor example, if the transaction amount is $1000 and the processor\ | |
| \ only authorizes a smaller amount, then enabling this field lets the\ | |
| \ Transaction proceed anyway." | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Partial amount authorizations are not allowed. | |
| - Partial amount authorizations are allowed | |
| authTokenCustomer: | |
| description: The customer identifier from the AuthToken used during authentication. | |
| type: string | |
| authentication: | |
| description: Authentication token returned by the network in a 3DSecure | |
| txn. | |
| type: string | |
| authenticationId: | |
| description: Optional transaction ID returned by the network in a 3DSecure | |
| txn. | |
| type: string | |
| batch: | |
| description: If the Transaction is linked to a Batch, this field specifies | |
| the identifier of the Batch. | |
| type: string | |
| cashback: | |
| description: "The amount of the total sum of this Transaction that is given\ | |
| \ as cash back. \nThis field is specified as an integer in cents." | |
| type: integer | |
| channel: | |
| description: This field is stored as a text string and must be between 0 | |
| and 1000 characters long. | |
| type: string | |
| city: | |
| description: "The name of the city in the address associated with this Transaction.\ | |
| \ \nThis field is stored as a text string and must be between 1 and 500\ | |
| \ characters long." | |
| type: string | |
| clientIp: | |
| description: "The client ip address from which the Transaction was created.\ | |
| \ \nValid values are any Ipv4 or Ipv6 address." | |
| type: string | |
| cofType: | |
| description: The type of Card On File transaction when using a token. | |
| enum: | |
| - single | |
| - scheduled | |
| - unscheduled | |
| type: string | |
| x-enum-descriptions: | |
| - Individual Transaction | |
| - Scheduled Transaction | |
| - Unscheduled sequential Transaction | |
| company: | |
| description: "The name of the company associated with this Transaction.\ | |
| \ \nSetting this field is especially important when processing an eCheck\ | |
| \ from a company." | |
| type: string | |
| copyReason: | |
| description: Reason for copying Transaction referenced in fromtxn field. | |
| enum: | |
| - resubmission | |
| - reauthorization | |
| type: string | |
| x-enum-descriptions: | |
| - Resubmission | |
| - Reauthorization | |
| country: | |
| description: "The country associated with this Transaction. \nValid values\ | |
| \ for this field is the 3-letter ISO code for the country." | |
| enum: | |
| - ABW | |
| - AFG | |
| - AGO | |
| - AIA | |
| - ALA | |
| - ALB | |
| - AND | |
| - ARE | |
| - ARG | |
| - ARM | |
| - ASM | |
| - ATA | |
| - ATF | |
| - ATG | |
| - AUS | |
| - AUT | |
| - AZE | |
| - BDI | |
| - BEL | |
| - BEN | |
| - BES | |
| - BFA | |
| - BGD | |
| - BGR | |
| - BHR | |
| - BHS | |
| - BIH | |
| - BLM | |
| - BLR | |
| - BLZ | |
| - BMU | |
| - BOL | |
| - BRA | |
| - BRB | |
| - BRN | |
| - BTN | |
| - BVT | |
| - BWA | |
| - CAF | |
| - CAN | |
| - CCK | |
| - CHE | |
| - CHL | |
| - CHN | |
| - CIV | |
| - CMR | |
| - COD | |
| - COG | |
| - COK | |
| - COL | |
| - COM | |
| - CPV | |
| - CRI | |
| - CUB | |
| - CUW | |
| - CXR | |
| - CYM | |
| - CYP | |
| - CZE | |
| - DEU | |
| - DJI | |
| - DMA | |
| - DNK | |
| - DOM | |
| - DZA | |
| - ECU | |
| - EGY | |
| - ERI | |
| - ESH | |
| - ESP | |
| - EST | |
| - ETH | |
| - FIN | |
| - FJI | |
| - FLK | |
| - FRA | |
| - FRO | |
| - FSM | |
| - GAB | |
| - GBR | |
| - GEO | |
| - GGY | |
| - GHA | |
| - GIB | |
| - GIN | |
| - GLP | |
| - GMB | |
| - GNB | |
| - GNQ | |
| - GRC | |
| - GRD | |
| - GRL | |
| - GTM | |
| - GUF | |
| - GUM | |
| - GUY | |
| - HKG | |
| - HMD | |
| - HND | |
| - HRV | |
| - HTI | |
| - HUN | |
| - IDN | |
| - IMN | |
| - IND | |
| - IOT | |
| - IRL | |
| - IRN | |
| - IRQ | |
| - ISL | |
| - ISR | |
| - ITA | |
| - JAM | |
| - JEY | |
| - JOR | |
| - JPN | |
| - KAZ | |
| - KEN | |
| - KGZ | |
| - KHM | |
| - KIR | |
| - KNA | |
| - KOR | |
| - KWT | |
| - LAO | |
| - LBN | |
| - LBR | |
| - LBY | |
| - LCA | |
| - LIE | |
| - LKA | |
| - LSO | |
| - LTU | |
| - LUX | |
| - LVA | |
| - MAC | |
| - MAF | |
| - MAR | |
| - MCO | |
| - MDA | |
| - MDG | |
| - MDV | |
| - MEX | |
| - MHL | |
| - MKD | |
| - MLI | |
| - MLT | |
| - MMR | |
| - MNE | |
| - MNG | |
| - MNP | |
| - MOZ | |
| - MRT | |
| - MSR | |
| - MTQ | |
| - MUS | |
| - MWI | |
| - MYS | |
| - MYT | |
| - NAM | |
| - NCL | |
| - NER | |
| - NFK | |
| - NGA | |
| - NIC | |
| - NIU | |
| - NLD | |
| - NOR | |
| - NPL | |
| - NRU | |
| - NZL | |
| - OMN | |
| - PAK | |
| - PAN | |
| - PCN | |
| - PER | |
| - PHL | |
| - PLW | |
| - PNG | |
| - POL | |
| - PRI | |
| - PRK | |
| - PRT | |
| - PRY | |
| - PSE | |
| - PYF | |
| - QAT | |
| - REU | |
| - ROU | |
| - RUS | |
| - RWA | |
| - SAU | |
| - SDN | |
| - SEN | |
| - SGP | |
| - SGS | |
| - SHN | |
| - SJM | |
| - SLB | |
| - SLE | |
| - SLV | |
| - SMR | |
| - SOM | |
| - SPM | |
| - SRB | |
| - SSD | |
| - STP | |
| - SUR | |
| - SVK | |
| - SVN | |
| - SWE | |
| - SWZ | |
| - SXM | |
| - SYC | |
| - SYR | |
| - TCA | |
| - TCD | |
| - TGO | |
| - THA | |
| - TJK | |
| - TKL | |
| - TKM | |
| - TLS | |
| - TON | |
| - TTO | |
| - TUN | |
| - TUR | |
| - TUV | |
| - TWN | |
| - TZA | |
| - UGA | |
| - UKR | |
| - UMI | |
| - URY | |
| - USA | |
| - UZB | |
| - VAT | |
| - VCT | |
| - VEN | |
| - VGB | |
| - VIR | |
| - VNM | |
| - VUT | |
| - WLF | |
| - WSM | |
| - XXK | |
| - YEM | |
| - ZAF | |
| - ZMB | |
| - ZWE | |
| type: string | |
| x-enum-descriptions: | |
| - Aruba | |
| - Afghanistan | |
| - Angola | |
| - Anguilla | |
| - Aland Islands | |
| - Albania | |
| - Andorra | |
| - United Arab Emirates | |
| - Argentina | |
| - Armenia | |
| - American Samoa | |
| - Antarctica | |
| - French Southern Territories | |
| - Antigua and Barbuda | |
| - Australia | |
| - Austria | |
| - Azerbaijan | |
| - Burundi | |
| - Belgium | |
| - Benin | |
| - Bonaire, Sint Eustatius and Saba | |
| - Burkina Faso | |
| - Bangladesh | |
| - Bulgaria | |
| - Bahrain | |
| - Bahamas | |
| - Bosnia and Herzegovina | |
| - "Saint Barth\xE9lemy" | |
| - Belarus | |
| - Belize | |
| - Bermuda | |
| - Bolivia, Plurinational State of | |
| - Brazil | |
| - Barbados | |
| - Brunei Darussalam | |
| - Bhutan | |
| - Bouvet Island | |
| - Botswana | |
| - Central African Republic | |
| - Canada | |
| - Cocos (Keeling) Islands | |
| - Switzerland | |
| - Chile | |
| - China | |
| - "C\xF4te d\u2019Ivoire" | |
| - Cameroon | |
| - Congo, the Democratic Republic of the | |
| - Congo | |
| - Cook Islands | |
| - Colombia | |
| - Comoros | |
| - Cape Verde | |
| - Costa Rica | |
| - Cuba | |
| - "Cura\xE7ao" | |
| - Christmas Island | |
| - Cayman Islands | |
| - Cyprus | |
| - Czech Republic | |
| - Germany | |
| - Djibouti | |
| - Dominica | |
| - Denmark | |
| - Dominican Republic | |
| - Algeria | |
| - Ecuador | |
| - Egypt | |
| - Eritrea | |
| - Western Sahara | |
| - Spain | |
| - Estonia | |
| - Ethiopia | |
| - Finland | |
| - Fiji | |
| - Falkland Islands (Malvinas) | |
| - France | |
| - Faroe Islands | |
| - Micronesia, Federated States of | |
| - Gabon | |
| - United Kingdom | |
| - Georgia | |
| - Guernsey | |
| - Ghana | |
| - Gibraltar | |
| - Guinea | |
| - Guadeloupe | |
| - Gambia | |
| - Guinea-Bissau | |
| - Equatorial Guinea | |
| - Greece | |
| - Grenada | |
| - Greenland | |
| - Guatemala | |
| - French Guiana | |
| - Guam | |
| - Guyana | |
| - Hong Kong | |
| - Heard Island and McDonald Islands | |
| - Honduras | |
| - Croatia | |
| - Haiti | |
| - Hungary | |
| - Indonesia | |
| - Isle of Man | |
| - India | |
| - British Indian Ocean Territory | |
| - Ireland | |
| - Iran, Islamic Republic of | |
| - Iraq | |
| - Iceland | |
| - Israel | |
| - Italy | |
| - Jamaica | |
| - Jersey | |
| - Jordan | |
| - Japan | |
| - Kazakhstan | |
| - Kenya | |
| - Kyrgyzstan | |
| - Cambodia | |
| - Kiribati | |
| - Saint Kitts and Nevis | |
| - Korea, Republic of | |
| - Kuwait | |
| - Lao People's Democratic Republic | |
| - Lebanon | |
| - Liberia | |
| - Libya | |
| - Saint Lucia | |
| - Liechtenstein | |
| - Sri Lanka | |
| - Lesotho | |
| - Lithuania | |
| - Luxembourg | |
| - Latvia | |
| - Macao | |
| - Saint Martin (French part) | |
| - Morocco | |
| - Monaco | |
| - Moldova, Republic of | |
| - Madagascar | |
| - Maldives | |
| - Mexico | |
| - Marshall Islands | |
| - Macedonia, the former Yugoslav Republic of | |
| - Mali | |
| - Malta | |
| - Myanmar | |
| - Montenegro | |
| - Mongolia | |
| - Northern Mariana Islands | |
| - Mozambique | |
| - Mauritania | |
| - Montserrat | |
| - Martinique | |
| - Mauritius | |
| - Malawi | |
| - Malaysia | |
| - Mayotte | |
| - Namibia | |
| - New Caledonia | |
| - Niger | |
| - Norfolk Island | |
| - Nigeria | |
| - Nicaragua | |
| - Niue | |
| - Netherlands | |
| - Norway | |
| - Nepal | |
| - Nauru | |
| - New Zealand | |
| - Oman | |
| - Pakistan | |
| - Panama | |
| - Pitcairn | |
| - Peru | |
| - Philippines | |
| - Palau | |
| - Papua New Guinea | |
| - Poland | |
| - Puerto Rico | |
| - Korea, Democratic People's Republic of | |
| - Portugal | |
| - Paraguay | |
| - Palestine, State of | |
| - French Polynesia | |
| - Qatar | |
| - "R\xE9union" | |
| - Romania | |
| - Russian Federation | |
| - Rwanda | |
| - Saudi Arabia | |
| - Sudan | |
| - Senegal | |
| - Singapore | |
| - South Georgia and the South Sandwich Islands | |
| - Saint Helena, Ascension and Tristan da Cunha | |
| - Svalbard and Jan Mayen | |
| - Solomon Islands | |
| - Sierra Leone | |
| - El Salvador | |
| - San Marino | |
| - Somalia | |
| - Saint Pierre and Miquelon | |
| - Serbia | |
| - South Sudan | |
| - Sao Tome and Principe | |
| - Suriname | |
| - Slovakia | |
| - Slovenia | |
| - Sweden | |
| - Swaziland | |
| - Sint Maarten (Dutch part) | |
| - Seychelles | |
| - Syrian Arab Republic | |
| - Turks and Caicos Islands | |
| - Chad | |
| - Togo | |
| - Thailand | |
| - Tajikistan | |
| - Tokelau | |
| - Turkmenistan | |
| - Timor-Leste | |
| - Tonga | |
| - Trinidad and Tobago | |
| - Tunisia | |
| - Turkey | |
| - Tuvalu | |
| - Taiwan, Province of China | |
| - Tanzania, United Republic of | |
| - Uganda | |
| - Ukraine | |
| - United States Minor Outlying Islands | |
| - Uruguay | |
| - United States | |
| - Uzbekistan | |
| - Holy See (Vatican City State) | |
| - Saint Vincent and the Grenadines | |
| - Venezuela, Bolivarian Republic of | |
| - Virgin Islands, British | |
| - Virgin Islands, U.S. | |
| - Viet Nam | |
| - Vanuatu | |
| - Wallis and Futuna | |
| - Samoa | |
| - '' | |
| - Yemen | |
| - South Africa | |
| - Zambia | |
| - Zimbabwe | |
| currency: | |
| description: The currency of the txn. | |
| enum: | |
| - AED | |
| - AFN | |
| - ALL | |
| - AMD | |
| - ANG | |
| - AOA | |
| - ARS | |
| - AUD | |
| - AWG | |
| - AZN | |
| - BAM | |
| - BBD | |
| - BDT | |
| - BGN | |
| - BHD | |
| - BIF | |
| - BMD | |
| - BND | |
| - BOB | |
| - BOV | |
| - BRL | |
| - BSD | |
| - BTN | |
| - BWP | |
| - BYN | |
| - BZD | |
| - CAD | |
| - CDF | |
| - CHE | |
| - CHF | |
| - CHW | |
| - CLF | |
| - CLP | |
| - CNY | |
| - COP | |
| - COU | |
| - CRC | |
| - CUC | |
| - CUP | |
| - CVE | |
| - CZK | |
| - DJF | |
| - DKK | |
| - DOP | |
| - DZD | |
| - EGP | |
| - ERN | |
| - ETB | |
| - EUR | |
| - FJD | |
| - FKP | |
| - GBP | |
| - GEL | |
| - GHS | |
| - GIP | |
| - GMD | |
| - GNF | |
| - GTQ | |
| - GYD | |
| - HKD | |
| - HNL | |
| - HRK | |
| - HTG | |
| - HUF | |
| - IDR | |
| - ILS | |
| - INR | |
| - IQD | |
| - IRR | |
| - ISK | |
| - JMD | |
| - JOD | |
| - JPY | |
| - KES | |
| - KGS | |
| - KHR | |
| - KMF | |
| - KPW | |
| - KRW | |
| - KWD | |
| - KYD | |
| - KZT | |
| - LAK | |
| - LBP | |
| - LKR | |
| - LRD | |
| - LSL | |
| - LYD | |
| - MAD | |
| - MDL | |
| - MGA | |
| - MKD | |
| - MMK | |
| - MNT | |
| - MOP | |
| - MRU | |
| - MUR | |
| - MVR | |
| - MWK | |
| - MXN | |
| - MXV | |
| - MYR | |
| - MZN | |
| - NAD | |
| - NGN | |
| - NIO | |
| - NOK | |
| - NPR | |
| - NZD | |
| - OMR | |
| - PAB | |
| - PEN | |
| - PGK | |
| - PHP | |
| - PKR | |
| - PLN | |
| - PYG | |
| - QAR | |
| - RON | |
| - RSD | |
| - RUB | |
| - RWF | |
| - SAR | |
| - SBD | |
| - SCR | |
| - SDG | |
| - SEK | |
| - SGD | |
| - SHP | |
| - SLL | |
| - SOS | |
| - SRD | |
| - SSP | |
| - STN | |
| - SVC | |
| - SYP | |
| - SZL | |
| - THB | |
| - TJS | |
| - TMT | |
| - TND | |
| - TOP | |
| - TRY | |
| - TTD | |
| - TWD | |
| - TZS | |
| - UAH | |
| - UGX | |
| - USD | |
| - USN | |
| - UYI | |
| - UYU | |
| - UZS | |
| - VEF | |
| - VND | |
| - VUV | |
| - WST | |
| - XAF | |
| - XAG | |
| - XAU | |
| - XBA | |
| - XBB | |
| - XBC | |
| - XBD | |
| - XCD | |
| - XDR | |
| - XOF | |
| - XPD | |
| - XPF | |
| - XPT | |
| - XSU | |
| - XUA | |
| - YER | |
| - ZAR | |
| - ZMW | |
| - ZWL | |
| type: string | |
| x-enum-descriptions: | |
| - United Arab Emirates dirham | |
| - Afghan afghani | |
| - Albanian lek | |
| - Armenian dram | |
| - Netherlands Antillean guilder | |
| - Angolan kwanza | |
| - Argentine peso | |
| - Australian dollar | |
| - Aruban florin | |
| - Azerbaijani manat | |
| - Bosnia and Herzegovina convertible mark | |
| - Barbados dollar | |
| - Bangladeshi taka | |
| - Bulgarian lev | |
| - Bahraini dinar | |
| - Burundian franc | |
| - Bermudian dollar | |
| - Brunei dollar | |
| - Boliviano | |
| - Bolivian Mvdol | |
| - Brazilian real | |
| - Bahamian dollar | |
| - Bhutanese ngultrum | |
| - Botswana pula | |
| - Belarusian ruble | |
| - Belize dollar | |
| - Canadian dollar | |
| - Congolese franc | |
| - WIR Euro | |
| - Swiss franc | |
| - WIR Franc | |
| - Unidad de Fomento | |
| - Chilean peso | |
| - Renminbi (Chinese) yuan | |
| - Colombian peso | |
| - Unidad de Valor Real | |
| - Costa Rican colon | |
| - Cuban convertible peso | |
| - Cuban peso | |
| - Cape Verde escudo | |
| - Czech koruna | |
| - Djiboutian franc | |
| - Danish krone | |
| - Dominican peso | |
| - Algerian dinar | |
| - Egyptian pound | |
| - Eritrean nakfa | |
| - Ethiopian birr | |
| - Euro | |
| - Fiji dollar | |
| - Falkland Islands pound | |
| - Pound sterling | |
| - Georgian lari | |
| - Ghanaian cedi | |
| - Gibraltar pound | |
| - Gambian dalasi | |
| - Guinean franc | |
| - Guatemalan quetzal | |
| - Guyanese dollar | |
| - Hong Kong dollar | |
| - Honduran lempira | |
| - Croatian kuna | |
| - Haitian gourde | |
| - Hungarian forint | |
| - Indonesian rupiah | |
| - Israeli new shekel | |
| - Indian rupee | |
| - Iraqi dinar | |
| - Iranian rial | |
| - "Icelandic kr\xF3na" | |
| - Jamaican dollar | |
| - Jordanian dinar | |
| - Japanese yen | |
| - Kenyan shilling | |
| - Kyrgyzstani som | |
| - Cambodian riel | |
| - Comoro franc | |
| - North Korean won | |
| - South Korean won | |
| - Kuwaiti dinar | |
| - Cayman Islands dollar | |
| - Kazakhstani tenge | |
| - Lao kip | |
| - Lebanese pound | |
| - Sri Lankan rupee | |
| - Liberian dollar | |
| - Lesotho loti | |
| - Libyan dinar | |
| - Moroccan dirham | |
| - Moldovan leu | |
| - Malagasy ariary | |
| - Macedonian denar | |
| - Myanmar kyat | |
| - "Mongolian t\xF6gr\xF6g" | |
| - Macanese pataca | |
| - Mauritanian ouguiya | |
| - Mauritian rupee | |
| - Maldivian rufiyaa | |
| - Malawian kwacha | |
| - Mexican peso | |
| - Mexican Unidad de Inversion | |
| - Malaysian ringgit | |
| - Mozambican metical | |
| - Namibian dollar | |
| - Nigerian naira | |
| - "Nicaraguan c\xF3rdoba" | |
| - Norwegian krone | |
| - Nepalese rupee | |
| - New Zealand dollar | |
| - Omani rial | |
| - Panamanian balboa | |
| - Peruvian sol | |
| - Papua New Guinean kina | |
| - Philippine piso | |
| - Pakistani rupee | |
| - "Polish z\u0142oty" | |
| - "Paraguayan guaran\xED" | |
| - Qatari riyal | |
| - Romanian leu | |
| - Serbian dinar | |
| - Russian ruble | |
| - Rwandan franc | |
| - Saudi riyal | |
| - Solomon Islands dollar | |
| - Seychelles rupee | |
| - Sudanese pound | |
| - Swedish krona/kronor | |
| - Singapore dollar | |
| - Saint Helena pound | |
| - Sierra Leonean leone | |
| - Somali shilling | |
| - Surinamese dollar | |
| - South Sudanese pound | |
| - "S\xE3o Tom\xE9 and Pr\xEDncipe dobra" | |
| - "Salvadoran col\xF3n" | |
| - Syrian pound | |
| - Swazi lilangeni | |
| - Thai baht | |
| - Tajikistani somoni | |
| - Turkmenistan manat | |
| - Tunisian dinar | |
| - Tongan pa'anga | |
| - Turkish lira | |
| - Trinidad and Tobago dollar | |
| - New Taiwan dollar | |
| - Tanzanian shilling | |
| - Ukrainian hryvnia | |
| - Ugandan shilling | |
| - United States dollar | |
| - United States dollar | |
| - Uruguay Peso en Unidades Indexadas | |
| - Uruguayan peso | |
| - Uzbekistan som | |
| - "Venezuelan bol\xEDvar" | |
| - "Vietnamese \u0111\u1ED3ng" | |
| - Vanuatu vatu | |
| - Samoan tala | |
| - CFA franc BEAC | |
| - Silver | |
| - Gold | |
| - European Composite Unit | |
| - European Monetary Unit | |
| - European Unit of Account | |
| - European Unit of Account | |
| - East Caribbean dollar | |
| - Special drawing rights | |
| - CFA franc BCEAO | |
| - Palladium | |
| - CFP franc | |
| - Platinum | |
| - SUCRE | |
| - ADB Unit of Account | |
| - Yemeni rial | |
| - South African rand | |
| - Zambian kwacha | |
| - Zimbabwean dollar | |
| currencyConversion: | |
| enum: | |
| - customerAccepted | |
| - customerRejected | |
| - notEligible | |
| type: string | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| - '' | |
| cvvStatus: | |
| description: The status of the CVV on the card. | |
| enum: | |
| - notPresent | |
| - illegible | |
| - notProvided | |
| type: string | |
| x-enum-descriptions: | |
| - CVV is not present. | |
| - CVV is illegible. | |
| - CVV was not provided. | |
| debtRepayment: | |
| description: If this transaction is for debt repayment. | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| description: | |
| description: "A description of this Transaction. \nThis field is stored\ | |
| \ as a text string and must be between 0 and 1000 characters long." | |
| type: string | |
| discount: | |
| description: The discount applied to the transaction. | |
| type: integer | |
| duty: | |
| description: The duty fee applicable to this transaction. | |
| type: integer | |
| email: | |
| description: The email associated with this Transaction. | |
| type: string | |
| entryMode: | |
| description: How payment information has been entered. | |
| enum: | |
| - '1' | |
| - '2' | |
| - '3' | |
| - '4' | |
| - '5' | |
| - '6' | |
| - '7' | |
| - '8' | |
| - '9' | |
| - '10' | |
| - '11' | |
| - '12' | |
| - '13' | |
| - '14' | |
| type: integer | |
| x-enum-descriptions: | |
| - Terminal used with key entry. | |
| - Track 1 read. | |
| - Track 2 read. | |
| - Complete magnetic stripe read. | |
| - EMV chip read. | |
| - EMV/Magnetic Stripe through contactless card. | |
| - Fallback from EMV to Swipe. | |
| - Fallback from EMV to Manual Entry. | |
| - Apple Pay. | |
| - Google Pay. | |
| - Merchant created transaction. | |
| - Invoice payment. | |
| - Merchant created transaction in payrix portal. | |
| - Invoice payment from payrix portal. | |
| expiration: | |
| description: "The expiration date of this Transaction. \nThis field is stored\ | |
| \ as a text string in 'MMYY' format, where 'MM' is the number of a month\ | |
| \ and 'YY' is the last two digits of a year. For example, '0623' for June\ | |
| \ 2023. \nThe value must reflect a future date." | |
| type: string | |
| fee: | |
| description: "Optional calculated fee amount indicator. This should be used\ | |
| \ in conjunction with txnFee setting on Fees resource. \nThis field is\ | |
| \ specified as an integer in cents." | |
| type: string | |
| first: | |
| description: The first name associated with this Transaction. For eCheck | |
| transactions, either first or last is required. | |
| type: string | |
| fortxn: | |
| description: "If this Transaction is related to another Transaction, then\ | |
| \ this field is set to the identifier of the other Transaction. \nFor\ | |
| \ example, if this Transaction is a refund, this field could be set to\ | |
| \ the identifier of the original sale Transaction." | |
| type: string | |
| fromtxn: | |
| description: Reauthorize this referenced Transaction. For example, to process | |
| a resubmission of a declined Transaction or to reauthorize an expired | |
| Transaction. | |
| type: string | |
| funded: | |
| description: "A date indicating when this Transaction was funded. \nThis\ | |
| \ field is set automatically." | |
| type: integer | |
| fundingCurrency: | |
| description: The funding currency of the txn. | |
| enum: | |
| - AED | |
| - AFN | |
| - ALL | |
| - AMD | |
| - ANG | |
| - AOA | |
| - ARS | |
| - AUD | |
| - AWG | |
| - AZN | |
| - BAM | |
| - BBD | |
| - BDT | |
| - BGN | |
| - BHD | |
| - BIF | |
| - BMD | |
| - BND | |
| - BOB | |
| - BOV | |
| - BRL | |
| - BSD | |
| - BTN | |
| - BWP | |
| - BYN | |
| - BZD | |
| - CAD | |
| - CDF | |
| - CHE | |
| - CHF | |
| - CHW | |
| - CLF | |
| - CLP | |
| - CNY | |
| - COP | |
| - COU | |
| - CRC | |
| - CUC | |
| - CUP | |
| - CVE | |
| - CZK | |
| - DJF | |
| - DKK | |
| - DOP | |
| - DZD | |
| - EGP | |
| - ERN | |
| - ETB | |
| - EUR | |
| - FJD | |
| - FKP | |
| - GBP | |
| - GEL | |
| - GHS | |
| - GIP | |
| - GMD | |
| - GNF | |
| - GTQ | |
| - GYD | |
| - HKD | |
| - HNL | |
| - HRK | |
| - HTG | |
| - HUF | |
| - IDR | |
| - ILS | |
| - INR | |
| - IQD | |
| - IRR | |
| - ISK | |
| - JMD | |
| - JOD | |
| - JPY | |
| - KES | |
| - KGS | |
| - KHR | |
| - KMF | |
| - KPW | |
| - KRW | |
| - KWD | |
| - KYD | |
| - KZT | |
| - LAK | |
| - LBP | |
| - LKR | |
| - LRD | |
| - LSL | |
| - LYD | |
| - MAD | |
| - MDL | |
| - MGA | |
| - MKD | |
| - MMK | |
| - MNT | |
| - MOP | |
| - MRU | |
| - MUR | |
| - MVR | |
| - MWK | |
| - MXN | |
| - MXV | |
| - MYR | |
| - MZN | |
| - NAD | |
| - NGN | |
| - NIO | |
| - NOK | |
| - NPR | |
| - NZD | |
| - OMR | |
| - PAB | |
| - PEN | |
| - PGK | |
| - PHP | |
| - PKR | |
| - PLN | |
| - PYG | |
| - QAR | |
| - RON | |
| - RSD | |
| - RUB | |
| - RWF | |
| - SAR | |
| - SBD | |
| - SCR | |
| - SDG | |
| - SEK | |
| - SGD | |
| - SHP | |
| - SLL | |
| - SOS | |
| - SRD | |
| - SSP | |
| - STN | |
| - SVC | |
| - SYP | |
| - SZL | |
| - THB | |
| - TJS | |
| - TMT | |
| - TND | |
| - TOP | |
| - TRY | |
| - TTD | |
| - TWD | |
| - TZS | |
| - UAH | |
| - UGX | |
| - USD | |
| - USN | |
| - UYI | |
| - UYU | |
| - UZS | |
| - VEF | |
| - VND | |
| - VUV | |
| - WST | |
| - XAF | |
| - XAG | |
| - XAU | |
| - XBA | |
| - XBB | |
| - XBC | |
| - XBD | |
| - XCD | |
| - XDR | |
| - XOF | |
| - XPD | |
| - XPF | |
| - XPT | |
| - XSU | |
| - XUA | |
| - YER | |
| - ZAR | |
| - ZMW | |
| - ZWL | |
| type: string | |
| x-enum-descriptions: | |
| - United Arab Emirates dirham | |
| - Afghan afghani | |
| - Albanian lek | |
| - Armenian dram | |
| - Netherlands Antillean guilder | |
| - Angolan kwanza | |
| - Argentine peso | |
| - Australian dollar | |
| - Aruban florin | |
| - Azerbaijani manat | |
| - Bosnia and Herzegovina convertible mark | |
| - Barbados dollar | |
| - Bangladeshi taka | |
| - Bulgarian lev | |
| - Bahraini dinar | |
| - Burundian franc | |
| - Bermudian dollar | |
| - Brunei dollar | |
| - Boliviano | |
| - Bolivian Mvdol | |
| - Brazilian real | |
| - Bahamian dollar | |
| - Bhutanese ngultrum | |
| - Botswana pula | |
| - Belarusian ruble | |
| - Belize dollar | |
| - Canadian dollar | |
| - Congolese franc | |
| - WIR Euro | |
| - Swiss franc | |
| - WIR Franc | |
| - Unidad de Fomento | |
| - Chilean peso | |
| - Renminbi (Chinese) yuan | |
| - Colombian peso | |
| - Unidad de Valor Real | |
| - Costa Rican colon | |
| - Cuban convertible peso | |
| - Cuban peso | |
| - Cape Verde escudo | |
| - Czech koruna | |
| - Djiboutian franc | |
| - Danish krone | |
| - Dominican peso | |
| - Algerian dinar | |
| - Egyptian pound | |
| - Eritrean nakfa | |
| - Ethiopian birr | |
| - Euro | |
| - Fiji dollar | |
| - Falkland Islands pound | |
| - Pound sterling | |
| - Georgian lari | |
| - Ghanaian cedi | |
| - Gibraltar pound | |
| - Gambian dalasi | |
| - Guinean franc | |
| - Guatemalan quetzal | |
| - Guyanese dollar | |
| - Hong Kong dollar | |
| - Honduran lempira | |
| - Croatian kuna | |
| - Haitian gourde | |
| - Hungarian forint | |
| - Indonesian rupiah | |
| - Israeli new shekel | |
| - Indian rupee | |
| - Iraqi dinar | |
| - Iranian rial | |
| - "Icelandic kr\xF3na" | |
| - Jamaican dollar | |
| - Jordanian dinar | |
| - Japanese yen | |
| - Kenyan shilling | |
| - Kyrgyzstani som | |
| - Cambodian riel | |
| - Comoro franc | |
| - North Korean won | |
| - South Korean won | |
| - Kuwaiti dinar | |
| - Cayman Islands dollar | |
| - Kazakhstani tenge | |
| - Lao kip | |
| - Lebanese pound | |
| - Sri Lankan rupee | |
| - Liberian dollar | |
| - Lesotho loti | |
| - Libyan dinar | |
| - Moroccan dirham | |
| - Moldovan leu | |
| - Malagasy ariary | |
| - Macedonian denar | |
| - Myanmar kyat | |
| - "Mongolian t\xF6gr\xF6g" | |
| - Macanese pataca | |
| - Mauritanian ouguiya | |
| - Mauritian rupee | |
| - Maldivian rufiyaa | |
| - Malawian kwacha | |
| - Mexican peso | |
| - Mexican Unidad de Inversion | |
| - Malaysian ringgit | |
| - Mozambican metical | |
| - Namibian dollar | |
| - Nigerian naira | |
| - "Nicaraguan c\xF3rdoba" | |
| - Norwegian krone | |
| - Nepalese rupee | |
| - New Zealand dollar | |
| - Omani rial | |
| - Panamanian balboa | |
| - Peruvian sol | |
| - Papua New Guinean kina | |
| - Philippine piso | |
| - Pakistani rupee | |
| - "Polish z\u0142oty" | |
| - "Paraguayan guaran\xED" | |
| - Qatari riyal | |
| - Romanian leu | |
| - Serbian dinar | |
| - Russian ruble | |
| - Rwandan franc | |
| - Saudi riyal | |
| - Solomon Islands dollar | |
| - Seychelles rupee | |
| - Sudanese pound | |
| - Swedish krona/kronor | |
| - Singapore dollar | |
| - Saint Helena pound | |
| - Sierra Leonean leone | |
| - Somali shilling | |
| - Surinamese dollar | |
| - South Sudanese pound | |
| - "S\xE3o Tom\xE9 and Pr\xEDncipe dobra" | |
| - "Salvadoran col\xF3n" | |
| - Syrian pound | |
| - Swazi lilangeni | |
| - Thai baht | |
| - Tajikistani somoni | |
| - Turkmenistan manat | |
| - Tunisian dinar | |
| - Tongan pa'anga | |
| - Turkish lira | |
| - Trinidad and Tobago dollar | |
| - New Taiwan dollar | |
| - Tanzanian shilling | |
| - Ukrainian hryvnia | |
| - Ugandan shilling | |
| - United States dollar | |
| - United States dollar | |
| - Uruguay Peso en Unidades Indexadas | |
| - Uruguayan peso | |
| - Uzbekistan som | |
| - "Venezuelan bol\xEDvar" | |
| - "Vietnamese \u0111\u1ED3ng" | |
| - Vanuatu vatu | |
| - Samoan tala | |
| - CFA franc BEAC | |
| - Silver | |
| - Gold | |
| - European Composite Unit | |
| - European Monetary Unit | |
| - European Unit of Account | |
| - European Unit of Account | |
| - East Caribbean dollar | |
| - Special drawing rights | |
| - CFA franc BCEAO | |
| - Palladium | |
| - CFP franc | |
| - Platinum | |
| - SUCRE | |
| - ADB Unit of Account | |
| - Yemeni rial | |
| - South African rand | |
| - Zambian kwacha | |
| - Zimbabwean dollar | |
| fundingEnabled: | |
| description: Whether or not funding is enabled for this Txn | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Disabled | |
| - Enabled | |
| last: | |
| description: The last name associated with this Transaction. For eCheck | |
| transactions, either first or last is required. | |
| type: string | |
| merchant: | |
| description: The identifier of the Merchant associated with this Transaction. | |
| type: string | |
| middle: | |
| description: The middle name associated with this Transaction. | |
| type: string | |
| mobile: | |
| description: Indicates if a transaction is being processed through a Mobile | |
| POS | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Non-mobile POS | |
| - Mobile POS | |
| networkTokenIndicator: | |
| description: Indicates if a transaction qualified for a network token through | |
| Network Payment Manager. | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - N | |
| - Y | |
| order: | |
| description: "The identifier of the Order associated with this Transaction.\ | |
| \ \nThis field is stored as a text string and must be between 0 and 1000\ | |
| \ characters long." | |
| type: string | |
| origin: | |
| description: The origin of this Transaction. | |
| enum: | |
| - '1' | |
| - '2' | |
| - '3' | |
| - '4' | |
| - '5' | |
| - '6' | |
| - '7' | |
| - '8' | |
| - '9' | |
| type: integer | |
| x-enum-descriptions: | |
| - Originated at a credit card terminal. | |
| - Originated through an eCommerce system. | |
| - Originated as a mail order or telephone order transaction. | |
| - '' | |
| - Originated as a Successful 3D Secure transaction. | |
| - Originated as an Attempted 3D Secure transaction. | |
| - Originated as a recurring transaction on the card. | |
| - Originated in a Payframe. | |
| - Originated as a transaction where authorization was received in writing. | |
| payment: | |
| $ref: '#/definitions/txnspaymentRequestFields' | |
| phone: | |
| description: "The phone number associated with this Transaction. \nThis\ | |
| \ field is stored as a text string and must be between 10 and 15 characters\ | |
| \ long." | |
| type: string | |
| pin: | |
| description: Whether this Transaction was verified with a PIN. | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| pinEntryCapability: | |
| description: Indicates the PIN entry capability of the device | |
| enum: | |
| - unknown | |
| - capable | |
| - notCapable | |
| - pinPadDown | |
| type: string | |
| x-enum-descriptions: | |
| - Unknown PIN Entry Capability | |
| - Terminal can accept PINs | |
| - Terminal cannot accept entry of PINs | |
| - Terminal PIN Pad is down | |
| platform: | |
| description: The platform used to process this Transaction. | |
| enum: | |
| - APPLE | |
| - ELAVON | |
| - FIRSTDATA | |
| - VANTIV | |
| - VCORE | |
| - WELLSACH | |
| - WELLSFARGO | |
| - WFSINGLE | |
| - WORLDPAY | |
| - TDBANKCA | |
| type: string | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| processedSequence: | |
| type: integer | |
| requestSequence: | |
| type: integer | |
| returned: | |
| type: integer | |
| shipping: | |
| description: The shipping fee pertaining to this transaction. | |
| type: integer | |
| signature: | |
| description: "Whether a signature was captured during this Transaction.\ | |
| \ \nYou can set this field if you took a signature for the Transaction.\ | |
| \ The API also sets this field automatically if you associate a signature\ | |
| \ to the Transaction by creating a 'txnDatas' resource." | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Not captured. | |
| - Captured. | |
| state: | |
| description: "The state associated with this Transaction. \nIf in the U.S.\ | |
| \ this is specified as the 2 character postal abbreviation for the state,\ | |
| \ if outside of the U.S. the full state name. \nThis field is stored as\ | |
| \ a text string and must be between 2 and 100 characters long." | |
| enum: | |
| - AB | |
| - BC | |
| - MB | |
| - NB | |
| - NL | |
| - NT | |
| - NS | |
| - NU | |
| - 'ON' | |
| - PE | |
| - QC | |
| - SK | |
| - YT | |
| type: string | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| statement: | |
| type: string | |
| surcharge: | |
| description: "The amount of the total sum of this Transaction that is made\ | |
| \ up of surcharge. \nThis field is specified as an integer in cents." | |
| type: integer | |
| swiped: | |
| description: "Whether the card was swiped during this Transaction. \nThis\ | |
| \ field is set to '1' automatically if 'track' data was received." | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Not swiped. | |
| - Swiped. | |
| tax: | |
| description: "The amount of the total sum of this Transaction that is made\ | |
| \ up of tax. \nThis field is specified as an integer in cents." | |
| type: integer | |
| terminal: | |
| description: "The identifier of the terminal that processed this Transaction.\ | |
| \ \nThe identifier is taken from the terminal system and varies in format\ | |
| \ according to the type of terminal. \nThis field is stored as a text\ | |
| \ string and must be between 0 and 50 characters long." | |
| type: string | |
| terminalCapability: | |
| description: Capabilities of the terminal device. | |
| enum: | |
| - '1' | |
| - '2' | |
| - '3' | |
| - '4' | |
| type: integer | |
| x-enum-descriptions: | |
| - Key entry only terminal. | |
| - Can read magnetic stripe. | |
| - Integrated circuit reader. | |
| - '' | |
| tmxSessionId: | |
| description: Threatmetrix session ID, used to trace the financial session | |
| and prevent possible frauds. | |
| type: string | |
| token: | |
| description: The token of the Tokens resource this Transaction is associated | |
| with. | |
| type: string | |
| total: | |
| description: "The total amount of this Transaction. \nThis field is specified\ | |
| \ as an integer in cents." | |
| type: integer | |
| type: | |
| description: The type of Transaction. | |
| enum: | |
| - '1' | |
| - '2' | |
| - '3' | |
| - '4' | |
| - '5' | |
| - '7' | |
| - '8' | |
| - '11' | |
| - '12' | |
| type: integer | |
| x-enum-descriptions: | |
| - 'Credit Card Only: Sale Transaction. This is the most common type of Transaction, | |
| it processes a sale and charges the customer' | |
| - 'Credit Card Only: Auth Transaction. Authorizes and holds the requested | |
| total on the credit card' | |
| - 'Credit Card Only: Capture Transaction. Finalizes a prior Auth Transaction | |
| and charges the customer' | |
| - 'Credit Card Only: Reverse Authorization. Reverses a prior Auth or Sale | |
| Transaction and releases the credit hold.' | |
| - 'Credit Card Only: Refund Transaction. Refunds a prior Capture or Sale | |
| Transaction (total may be specified for a partial refund).' | |
| - 'Echeck Only: Echeck Sale Transaction. Sale Transaction for ECheck payment.' | |
| - 'Echeck Only: ECheck Refund Transaction. Refund Transaction for prior | |
| ECheck Sale Transaction.' | |
| - 'Echeck Only: Echeck Redeposit Transaction. Attempt to redeposit a prior | |
| failed eCheck Sale Transaction.' | |
| - 'Echeck Only: Echeck Account Verification Transaction. Attempt to verify | |
| eCheck payment details' | |
| unattended: | |
| description: "Whether the card was swiped at an unattended terminal during\ | |
| \ this Transaction. \nThis field is set to '0' by default." | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Attended terminal. | |
| - Unattended terminal. | |
| unauthReason: | |
| description: "The reason for the auth reversal. \n This field is set to\ | |
| \ 'customerCancelled' by default." | |
| enum: | |
| - incomplete | |
| - timeout | |
| - clerkCancelled | |
| - customerCancelled | |
| - misdispense | |
| - hardwareFailure | |
| - suspectedFraud | |
| type: string | |
| x-enum-descriptions: | |
| - Incomplete | |
| - Timeout | |
| - Clerk Cancelled | |
| - Customer Cancelled | |
| - Misdispense | |
| - Hardware Failure | |
| - Suspected Fraud | |
| zip: | |
| description: "The ZIP code in the address associated with this Transaction.\ | |
| \ \nThis field is stored as a text string and must be between 1 and 20\ | |
| \ characters long." | |
| type: string | |
| required: | |
| - allowPartial | |
| - authentication | |
| - debtRepayment | |
| - fortxn | |
| - origin | |
| - platform | |
| - type | |
| - unauthReason | |
| - currency | |
| - fundingCurrency | |
| - swiped | |
| - merchant | |
| - pin | |
| - signature | |
| - total | |
| - unattended | |
| type: object | |
| x-redacted: [] | |
| txnsCreateResponseRest: | |
| properties: | |
| response: | |
| properties: | |
| data: | |
| description: The data object that the API returns for this request. | |
| items: | |
| $ref: '#/definitions/txnsCreateResponseFields' | |
| type: array | |
| details: | |
| description: An object describing the response, including the request | |
| ID and pagination indicators. | |
| properties: | |
| page: | |
| description: "Where the response lists multiple resources, the API\ | |
| \ splits the response into several 'pages'. \nThis object indicates\ | |
| \ the current and last available pages in the list." | |
| properties: | |
| current: | |
| description: The current page in the paginated resource list. | |
| type: integer | |
| last: | |
| description: The last available page in the paginated resource | |
| list. | |
| type: integer | |
| type: object | |
| requestId: | |
| description: "A unique identifier set by the API client, that is\ | |
| \ echoed by the response. \nThe request ID can be useful in troubleshooting\ | |
| \ and monitoring." | |
| type: string | |
| type: object | |
| errors: | |
| description: An array of zero or more errors that occurred when the | |
| API processed the request. | |
| items: | |
| properties: | |
| code: | |
| description: The error code associated with a particular error. | |
| type: integer | |
| errorCode: | |
| description: An identifying string code for this error. | |
| type: string | |
| message: | |
| description: The message associated with a particular error. | |
| type: string | |
| severity: | |
| description: "The severity level of a particular error. \nPossible\ | |
| \ values are '0' (informational), '1' (warning), '2' (error)\ | |
| \ and '4' (failure)." | |
| type: integer | |
| type: object | |
| type: array | |
| type: object | |
| type: object | |
| txnsCreateRest: | |
| $ref: '#/definitions/txnsCreateFields' | |
| txnsQueryResponseFields: | |
| properties: | |
| address1: | |
| description: "The first line of the address associated with this Transaction.\ | |
| \ \nThis field is stored as a text string and must be between 1 and 500\ | |
| \ characters long." | |
| type: string | |
| address2: | |
| description: "The second line of the address associated with this Transaction.\ | |
| \ \nThis field is stored as a text string and must be between 1 and 500\ | |
| \ characters long." | |
| type: string | |
| allowPartial: | |
| description: "Whether to allow partial amount authorizations of this Transaction.\ | |
| \ \nFor example, if the transaction amount is $1000 and the processor\ | |
| \ only authorizes a smaller amount, then enabling this field lets the\ | |
| \ Transaction proceed anyway." | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Partial amount authorizations are not allowed. | |
| - Partial amount authorizations are allowed | |
| approved: | |
| description: "The total amount that was approved for this Transaction by\ | |
| \ the processor. \nThis field is specified as an integer in cents." | |
| type: integer | |
| authCode: | |
| description: "The authorization code for this Transaction. \nThis field\ | |
| \ is stored as a text string and must be between 0 and 20 characters long." | |
| type: string | |
| authDate: | |
| description: "The date on which the Transaction was authorized. \nThe date\ | |
| \ is specified as an eight digit string in YYYYMMDD format, for example,\ | |
| \ '20160120' for January 20, 2016. \nThe value of this field must represent\ | |
| \ a date in the past." | |
| type: integer | |
| authTokenCustomer: | |
| description: The customer identifier from the AuthToken used during authentication. | |
| type: string | |
| authentication: | |
| description: Authentication token returned by the network in a 3DSecure | |
| txn. | |
| type: string | |
| authenticationId: | |
| description: Optional transaction ID returned by the network in a 3DSecure | |
| txn. | |
| type: string | |
| authorization: | |
| description: The authorization code for this Transaction, as returned by | |
| the network. | |
| type: string | |
| batch: | |
| description: If the Transaction is linked to a Batch, this field specifies | |
| the identifier of the Batch. | |
| type: string | |
| captured: | |
| description: "A timestamp indicating when this Transaction was captured.\ | |
| \ \nThis field is set automatically." | |
| format: date-time | |
| type: string | |
| cashback: | |
| description: "The amount of the total sum of this Transaction that is given\ | |
| \ as cash back. \nThis field is specified as an integer in cents." | |
| type: integer | |
| channel: | |
| description: This field is stored as a text string and must be between 0 | |
| and 1000 characters long. | |
| type: string | |
| city: | |
| description: "The name of the city in the address associated with this Transaction.\ | |
| \ \nThis field is stored as a text string and must be between 1 and 500\ | |
| \ characters long." | |
| type: string | |
| clientIp: | |
| description: "The client ip address from which the Transaction was created.\ | |
| \ \nValid values are any Ipv4 or Ipv6 address." | |
| type: string | |
| cofType: | |
| description: The type of Card On File transaction when using a token. | |
| enum: | |
| - single | |
| - scheduled | |
| - unscheduled | |
| type: string | |
| x-enum-descriptions: | |
| - Individual Transaction | |
| - Scheduled Transaction | |
| - Unscheduled sequential Transaction | |
| company: | |
| description: "The name of the company associated with this Transaction.\ | |
| \ \nSetting this field is especially important when processing an eCheck\ | |
| \ from a company." | |
| type: string | |
| convenienceFee: | |
| type: integer | |
| copyReason: | |
| description: Reason for copying Transaction referenced in fromtxn field. | |
| enum: | |
| - resubmission | |
| - reauthorization | |
| type: string | |
| x-enum-descriptions: | |
| - Resubmission | |
| - Reauthorization | |
| country: | |
| description: "The country associated with this Transaction. \nValid values\ | |
| \ for this field is the 3-letter ISO code for the country." | |
| enum: | |
| - ABW | |
| - AFG | |
| - AGO | |
| - AIA | |
| - ALA | |
| - ALB | |
| - AND | |
| - ARE | |
| - ARG | |
| - ARM | |
| - ASM | |
| - ATA | |
| - ATF | |
| - ATG | |
| - AUS | |
| - AUT | |
| - AZE | |
| - BDI | |
| - BEL | |
| - BEN | |
| - BES | |
| - BFA | |
| - BGD | |
| - BGR | |
| - BHR | |
| - BHS | |
| - BIH | |
| - BLM | |
| - BLR | |
| - BLZ | |
| - BMU | |
| - BOL | |
| - BRA | |
| - BRB | |
| - BRN | |
| - BTN | |
| - BVT | |
| - BWA | |
| - CAF | |
| - CAN | |
| - CCK | |
| - CHE | |
| - CHL | |
| - CHN | |
| - CIV | |
| - CMR | |
| - COD | |
| - COG | |
| - COK | |
| - COL | |
| - COM | |
| - CPV | |
| - CRI | |
| - CUB | |
| - CUW | |
| - CXR | |
| - CYM | |
| - CYP | |
| - CZE | |
| - DEU | |
| - DJI | |
| - DMA | |
| - DNK | |
| - DOM | |
| - DZA | |
| - ECU | |
| - EGY | |
| - ERI | |
| - ESH | |
| - ESP | |
| - EST | |
| - ETH | |
| - FIN | |
| - FJI | |
| - FLK | |
| - FRA | |
| - FRO | |
| - FSM | |
| - GAB | |
| - GBR | |
| - GEO | |
| - GGY | |
| - GHA | |
| - GIB | |
| - GIN | |
| - GLP | |
| - GMB | |
| - GNB | |
| - GNQ | |
| - GRC | |
| - GRD | |
| - GRL | |
| - GTM | |
| - GUF | |
| - GUM | |
| - GUY | |
| - HKG | |
| - HMD | |
| - HND | |
| - HRV | |
| - HTI | |
| - HUN | |
| - IDN | |
| - IMN | |
| - IND | |
| - IOT | |
| - IRL | |
| - IRN | |
| - IRQ | |
| - ISL | |
| - ISR | |
| - ITA | |
| - JAM | |
| - JEY | |
| - JOR | |
| - JPN | |
| - KAZ | |
| - KEN | |
| - KGZ | |
| - KHM | |
| - KIR | |
| - KNA | |
| - KOR | |
| - KWT | |
| - LAO | |
| - LBN | |
| - LBR | |
| - LBY | |
| - LCA | |
| - LIE | |
| - LKA | |
| - LSO | |
| - LTU | |
| - LUX | |
| - LVA | |
| - MAC | |
| - MAF | |
| - MAR | |
| - MCO | |
| - MDA | |
| - MDG | |
| - MDV | |
| - MEX | |
| - MHL | |
| - MKD | |
| - MLI | |
| - MLT | |
| - MMR | |
| - MNE | |
| - MNG | |
| - MNP | |
| - MOZ | |
| - MRT | |
| - MSR | |
| - MTQ | |
| - MUS | |
| - MWI | |
| - MYS | |
| - MYT | |
| - NAM | |
| - NCL | |
| - NER | |
| - NFK | |
| - NGA | |
| - NIC | |
| - NIU | |
| - NLD | |
| - NOR | |
| - NPL | |
| - NRU | |
| - NZL | |
| - OMN | |
| - PAK | |
| - PAN | |
| - PCN | |
| - PER | |
| - PHL | |
| - PLW | |
| - PNG | |
| - POL | |
| - PRI | |
| - PRK | |
| - PRT | |
| - PRY | |
| - PSE | |
| - PYF | |
| - QAT | |
| - REU | |
| - ROU | |
| - RUS | |
| - RWA | |
| - SAU | |
| - SDN | |
| - SEN | |
| - SGP | |
| - SGS | |
| - SHN | |
| - SJM | |
| - SLB | |
| - SLE | |
| - SLV | |
| - SMR | |
| - SOM | |
| - SPM | |
| - SRB | |
| - SSD | |
| - STP | |
| - SUR | |
| - SVK | |
| - SVN | |
| - SWE | |
| - SWZ | |
| - SXM | |
| - SYC | |
| - SYR | |
| - TCA | |
| - TCD | |
| - TGO | |
| - THA | |
| - TJK | |
| - TKL | |
| - TKM | |
| - TLS | |
| - TON | |
| - TTO | |
| - TUN | |
| - TUR | |
| - TUV | |
| - TWN | |
| - TZA | |
| - UGA | |
| - UKR | |
| - UMI | |
| - URY | |
| - USA | |
| - UZB | |
| - VAT | |
| - VCT | |
| - VEN | |
| - VGB | |
| - VIR | |
| - VNM | |
| - VUT | |
| - WLF | |
| - WSM | |
| - XXK | |
| - YEM | |
| - ZAF | |
| - ZMB | |
| - ZWE | |
| type: string | |
| x-enum-descriptions: | |
| - Aruba | |
| - Afghanistan | |
| - Angola | |
| - Anguilla | |
| - Aland Islands | |
| - Albania | |
| - Andorra | |
| - United Arab Emirates | |
| - Argentina | |
| - Armenia | |
| - American Samoa | |
| - Antarctica | |
| - French Southern Territories | |
| - Antigua and Barbuda | |
| - Australia | |
| - Austria | |
| - Azerbaijan | |
| - Burundi | |
| - Belgium | |
| - Benin | |
| - Bonaire, Sint Eustatius and Saba | |
| - Burkina Faso | |
| - Bangladesh | |
| - Bulgaria | |
| - Bahrain | |
| - Bahamas | |
| - Bosnia and Herzegovina | |
| - "Saint Barth\xE9lemy" | |
| - Belarus | |
| - Belize | |
| - Bermuda | |
| - Bolivia, Plurinational State of | |
| - Brazil | |
| - Barbados | |
| - Brunei Darussalam | |
| - Bhutan | |
| - Bouvet Island | |
| - Botswana | |
| - Central African Republic | |
| - Canada | |
| - Cocos (Keeling) Islands | |
| - Switzerland | |
| - Chile | |
| - China | |
| - "C\xF4te d\u2019Ivoire" | |
| - Cameroon | |
| - Congo, the Democratic Republic of the | |
| - Congo | |
| - Cook Islands | |
| - Colombia | |
| - Comoros | |
| - Cape Verde | |
| - Costa Rica | |
| - Cuba | |
| - "Cura\xE7ao" | |
| - Christmas Island | |
| - Cayman Islands | |
| - Cyprus | |
| - Czech Republic | |
| - Germany | |
| - Djibouti | |
| - Dominica | |
| - Denmark | |
| - Dominican Republic | |
| - Algeria | |
| - Ecuador | |
| - Egypt | |
| - Eritrea | |
| - Western Sahara | |
| - Spain | |
| - Estonia | |
| - Ethiopia | |
| - Finland | |
| - Fiji | |
| - Falkland Islands (Malvinas) | |
| - France | |
| - Faroe Islands | |
| - Micronesia, Federated States of | |
| - Gabon | |
| - United Kingdom | |
| - Georgia | |
| - Guernsey | |
| - Ghana | |
| - Gibraltar | |
| - Guinea | |
| - Guadeloupe | |
| - Gambia | |
| - Guinea-Bissau | |
| - Equatorial Guinea | |
| - Greece | |
| - Grenada | |
| - Greenland | |
| - Guatemala | |
| - French Guiana | |
| - Guam | |
| - Guyana | |
| - Hong Kong | |
| - Heard Island and McDonald Islands | |
| - Honduras | |
| - Croatia | |
| - Haiti | |
| - Hungary | |
| - Indonesia | |
| - Isle of Man | |
| - India | |
| - British Indian Ocean Territory | |
| - Ireland | |
| - Iran, Islamic Republic of | |
| - Iraq | |
| - Iceland | |
| - Israel | |
| - Italy | |
| - Jamaica | |
| - Jersey | |
| - Jordan | |
| - Japan | |
| - Kazakhstan | |
| - Kenya | |
| - Kyrgyzstan | |
| - Cambodia | |
| - Kiribati | |
| - Saint Kitts and Nevis | |
| - Korea, Republic of | |
| - Kuwait | |
| - Lao People's Democratic Republic | |
| - Lebanon | |
| - Liberia | |
| - Libya | |
| - Saint Lucia | |
| - Liechtenstein | |
| - Sri Lanka | |
| - Lesotho | |
| - Lithuania | |
| - Luxembourg | |
| - Latvia | |
| - Macao | |
| - Saint Martin (French part) | |
| - Morocco | |
| - Monaco | |
| - Moldova, Republic of | |
| - Madagascar | |
| - Maldives | |
| - Mexico | |
| - Marshall Islands | |
| - Macedonia, the former Yugoslav Republic of | |
| - Mali | |
| - Malta | |
| - Myanmar | |
| - Montenegro | |
| - Mongolia | |
| - Northern Mariana Islands | |
| - Mozambique | |
| - Mauritania | |
| - Montserrat | |
| - Martinique | |
| - Mauritius | |
| - Malawi | |
| - Malaysia | |
| - Mayotte | |
| - Namibia | |
| - New Caledonia | |
| - Niger | |
| - Norfolk Island | |
| - Nigeria | |
| - Nicaragua | |
| - Niue | |
| - Netherlands | |
| - Norway | |
| - Nepal | |
| - Nauru | |
| - New Zealand | |
| - Oman | |
| - Pakistan | |
| - Panama | |
| - Pitcairn | |
| - Peru | |
| - Philippines | |
| - Palau | |
| - Papua New Guinea | |
| - Poland | |
| - Puerto Rico | |
| - Korea, Democratic People's Republic of | |
| - Portugal | |
| - Paraguay | |
| - Palestine, State of | |
| - French Polynesia | |
| - Qatar | |
| - "R\xE9union" | |
| - Romania | |
| - Russian Federation | |
| - Rwanda | |
| - Saudi Arabia | |
| - Sudan | |
| - Senegal | |
| - Singapore | |
| - South Georgia and the South Sandwich Islands | |
| - Saint Helena, Ascension and Tristan da Cunha | |
| - Svalbard and Jan Mayen | |
| - Solomon Islands | |
| - Sierra Leone | |
| - El Salvador | |
| - San Marino | |
| - Somalia | |
| - Saint Pierre and Miquelon | |
| - Serbia | |
| - South Sudan | |
| - Sao Tome and Principe | |
| - Suriname | |
| - Slovakia | |
| - Slovenia | |
| - Sweden | |
| - Swaziland | |
| - Sint Maarten (Dutch part) | |
| - Seychelles | |
| - Syrian Arab Republic | |
| - Turks and Caicos Islands | |
| - Chad | |
| - Togo | |
| - Thailand | |
| - Tajikistan | |
| - Tokelau | |
| - Turkmenistan | |
| - Timor-Leste | |
| - Tonga | |
| - Trinidad and Tobago | |
| - Tunisia | |
| - Turkey | |
| - Tuvalu | |
| - Taiwan, Province of China | |
| - Tanzania, United Republic of | |
| - Uganda | |
| - Ukraine | |
| - United States Minor Outlying Islands | |
| - Uruguay | |
| - United States | |
| - Uzbekistan | |
| - Holy See (Vatican City State) | |
| - Saint Vincent and the Grenadines | |
| - Venezuela, Bolivarian Republic of | |
| - Virgin Islands, British | |
| - Virgin Islands, U.S. | |
| - Viet Nam | |
| - Vanuatu | |
| - Wallis and Futuna | |
| - Samoa | |
| - '' | |
| - Yemen | |
| - South Africa | |
| - Zambia | |
| - Zimbabwe | |
| created: | |
| description: The date and time at which this resource was created. | |
| format: date-time | |
| type: string | |
| creator: | |
| description: The identifier of the Login that created this resource. | |
| type: string | |
| currency: | |
| description: The currency of the txn. | |
| enum: | |
| - AED | |
| - AFN | |
| - ALL | |
| - AMD | |
| - ANG | |
| - AOA | |
| - ARS | |
| - AUD | |
| - AWG | |
| - AZN | |
| - BAM | |
| - BBD | |
| - BDT | |
| - BGN | |
| - BHD | |
| - BIF | |
| - BMD | |
| - BND | |
| - BOB | |
| - BOV | |
| - BRL | |
| - BSD | |
| - BTN | |
| - BWP | |
| - BYN | |
| - BZD | |
| - CAD | |
| - CDF | |
| - CHE | |
| - CHF | |
| - CHW | |
| - CLF | |
| - CLP | |
| - CNY | |
| - COP | |
| - COU | |
| - CRC | |
| - CUC | |
| - CUP | |
| - CVE | |
| - CZK | |
| - DJF | |
| - DKK | |
| - DOP | |
| - DZD | |
| - EGP | |
| - ERN | |
| - ETB | |
| - EUR | |
| - FJD | |
| - FKP | |
| - GBP | |
| - GEL | |
| - GHS | |
| - GIP | |
| - GMD | |
| - GNF | |
| - GTQ | |
| - GYD | |
| - HKD | |
| - HNL | |
| - HRK | |
| - HTG | |
| - HUF | |
| - IDR | |
| - ILS | |
| - INR | |
| - IQD | |
| - IRR | |
| - ISK | |
| - JMD | |
| - JOD | |
| - JPY | |
| - KES | |
| - KGS | |
| - KHR | |
| - KMF | |
| - KPW | |
| - KRW | |
| - KWD | |
| - KYD | |
| - KZT | |
| - LAK | |
| - LBP | |
| - LKR | |
| - LRD | |
| - LSL | |
| - LYD | |
| - MAD | |
| - MDL | |
| - MGA | |
| - MKD | |
| - MMK | |
| - MNT | |
| - MOP | |
| - MRU | |
| - MUR | |
| - MVR | |
| - MWK | |
| - MXN | |
| - MXV | |
| - MYR | |
| - MZN | |
| - NAD | |
| - NGN | |
| - NIO | |
| - NOK | |
| - NPR | |
| - NZD | |
| - OMR | |
| - PAB | |
| - PEN | |
| - PGK | |
| - PHP | |
| - PKR | |
| - PLN | |
| - PYG | |
| - QAR | |
| - RON | |
| - RSD | |
| - RUB | |
| - RWF | |
| - SAR | |
| - SBD | |
| - SCR | |
| - SDG | |
| - SEK | |
| - SGD | |
| - SHP | |
| - SLL | |
| - SOS | |
| - SRD | |
| - SSP | |
| - STN | |
| - SVC | |
| - SYP | |
| - SZL | |
| - THB | |
| - TJS | |
| - TMT | |
| - TND | |
| - TOP | |
| - TRY | |
| - TTD | |
| - TWD | |
| - TZS | |
| - UAH | |
| - UGX | |
| - USD | |
| - USN | |
| - UYI | |
| - UYU | |
| - UZS | |
| - VEF | |
| - VND | |
| - VUV | |
| - WST | |
| - XAF | |
| - XAG | |
| - XAU | |
| - XBA | |
| - XBB | |
| - XBC | |
| - XBD | |
| - XCD | |
| - XDR | |
| - XOF | |
| - XPD | |
| - XPF | |
| - XPT | |
| - XSU | |
| - XUA | |
| - YER | |
| - ZAR | |
| - ZMW | |
| - ZWL | |
| type: string | |
| x-enum-descriptions: | |
| - United Arab Emirates dirham | |
| - Afghan afghani | |
| - Albanian lek | |
| - Armenian dram | |
| - Netherlands Antillean guilder | |
| - Angolan kwanza | |
| - Argentine peso | |
| - Australian dollar | |
| - Aruban florin | |
| - Azerbaijani manat | |
| - Bosnia and Herzegovina convertible mark | |
| - Barbados dollar | |
| - Bangladeshi taka | |
| - Bulgarian lev | |
| - Bahraini dinar | |
| - Burundian franc | |
| - Bermudian dollar | |
| - Brunei dollar | |
| - Boliviano | |
| - Bolivian Mvdol | |
| - Brazilian real | |
| - Bahamian dollar | |
| - Bhutanese ngultrum | |
| - Botswana pula | |
| - Belarusian ruble | |
| - Belize dollar | |
| - Canadian dollar | |
| - Congolese franc | |
| - WIR Euro | |
| - Swiss franc | |
| - WIR Franc | |
| - Unidad de Fomento | |
| - Chilean peso | |
| - Renminbi (Chinese) yuan | |
| - Colombian peso | |
| - Unidad de Valor Real | |
| - Costa Rican colon | |
| - Cuban convertible peso | |
| - Cuban peso | |
| - Cape Verde escudo | |
| - Czech koruna | |
| - Djiboutian franc | |
| - Danish krone | |
| - Dominican peso | |
| - Algerian dinar | |
| - Egyptian pound | |
| - Eritrean nakfa | |
| - Ethiopian birr | |
| - Euro | |
| - Fiji dollar | |
| - Falkland Islands pound | |
| - Pound sterling | |
| - Georgian lari | |
| - Ghanaian cedi | |
| - Gibraltar pound | |
| - Gambian dalasi | |
| - Guinean franc | |
| - Guatemalan quetzal | |
| - Guyanese dollar | |
| - Hong Kong dollar | |
| - Honduran lempira | |
| - Croatian kuna | |
| - Haitian gourde | |
| - Hungarian forint | |
| - Indonesian rupiah | |
| - Israeli new shekel | |
| - Indian rupee | |
| - Iraqi dinar | |
| - Iranian rial | |
| - "Icelandic kr\xF3na" | |
| - Jamaican dollar | |
| - Jordanian dinar | |
| - Japanese yen | |
| - Kenyan shilling | |
| - Kyrgyzstani som | |
| - Cambodian riel | |
| - Comoro franc | |
| - North Korean won | |
| - South Korean won | |
| - Kuwaiti dinar | |
| - Cayman Islands dollar | |
| - Kazakhstani tenge | |
| - Lao kip | |
| - Lebanese pound | |
| - Sri Lankan rupee | |
| - Liberian dollar | |
| - Lesotho loti | |
| - Libyan dinar | |
| - Moroccan dirham | |
| - Moldovan leu | |
| - Malagasy ariary | |
| - Macedonian denar | |
| - Myanmar kyat | |
| - "Mongolian t\xF6gr\xF6g" | |
| - Macanese pataca | |
| - Mauritanian ouguiya | |
| - Mauritian rupee | |
| - Maldivian rufiyaa | |
| - Malawian kwacha | |
| - Mexican peso | |
| - Mexican Unidad de Inversion | |
| - Malaysian ringgit | |
| - Mozambican metical | |
| - Namibian dollar | |
| - Nigerian naira | |
| - "Nicaraguan c\xF3rdoba" | |
| - Norwegian krone | |
| - Nepalese rupee | |
| - New Zealand dollar | |
| - Omani rial | |
| - Panamanian balboa | |
| - Peruvian sol | |
| - Papua New Guinean kina | |
| - Philippine piso | |
| - Pakistani rupee | |
| - "Polish z\u0142oty" | |
| - "Paraguayan guaran\xED" | |
| - Qatari riyal | |
| - Romanian leu | |
| - Serbian dinar | |
| - Russian ruble | |
| - Rwandan franc | |
| - Saudi riyal | |
| - Solomon Islands dollar | |
| - Seychelles rupee | |
| - Sudanese pound | |
| - Swedish krona/kronor | |
| - Singapore dollar | |
| - Saint Helena pound | |
| - Sierra Leonean leone | |
| - Somali shilling | |
| - Surinamese dollar | |
| - South Sudanese pound | |
| - "S\xE3o Tom\xE9 and Pr\xEDncipe dobra" | |
| - "Salvadoran col\xF3n" | |
| - Syrian pound | |
| - Swazi lilangeni | |
| - Thai baht | |
| - Tajikistani somoni | |
| - Turkmenistan manat | |
| - Tunisian dinar | |
| - Tongan pa'anga | |
| - Turkish lira | |
| - Trinidad and Tobago dollar | |
| - New Taiwan dollar | |
| - Tanzanian shilling | |
| - Ukrainian hryvnia | |
| - Ugandan shilling | |
| - United States dollar | |
| - United States dollar | |
| - Uruguay Peso en Unidades Indexadas | |
| - Uruguayan peso | |
| - Uzbekistan som | |
| - "Venezuelan bol\xEDvar" | |
| - "Vietnamese \u0111\u1ED3ng" | |
| - Vanuatu vatu | |
| - Samoan tala | |
| - CFA franc BEAC | |
| - Silver | |
| - Gold | |
| - European Composite Unit | |
| - European Monetary Unit | |
| - European Unit of Account | |
| - European Unit of Account | |
| - East Caribbean dollar | |
| - Special drawing rights | |
| - CFA franc BCEAO | |
| - Palladium | |
| - CFP franc | |
| - Platinum | |
| - SUCRE | |
| - ADB Unit of Account | |
| - Yemeni rial | |
| - South African rand | |
| - Zambian kwacha | |
| - Zimbabwean dollar | |
| currencyConversion: | |
| enum: | |
| - customerAccepted | |
| - customerRejected | |
| - notEligible | |
| type: string | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| - '' | |
| cvv: | |
| description: Whether correct cvv was sent during this Transaction. | |
| type: integer | |
| cvvStatus: | |
| description: The status of the CVV on the card. | |
| enum: | |
| - notPresent | |
| - illegible | |
| - notProvided | |
| type: string | |
| x-enum-descriptions: | |
| - CVV is not present. | |
| - CVV is illegible. | |
| - CVV was not provided. | |
| debtRepayment: | |
| description: If this transaction is for debt repayment. | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| description: | |
| description: "A description of this Transaction. \nThis field is stored\ | |
| \ as a text string and must be between 0 and 1000 characters long." | |
| type: string | |
| descriptor: | |
| description: "The descriptor used in this Transaction. \nThis field is stored\ | |
| \ as a text string and must be between 1 and 50 characters long. If a\ | |
| \ value is not set, an attempt is made to set a default value from the\ | |
| \ merchant information." | |
| type: string | |
| discount: | |
| description: The discount applied to the transaction. | |
| type: integer | |
| duty: | |
| description: The duty fee applicable to this transaction. | |
| type: integer | |
| email: | |
| description: The email associated with this Transaction. | |
| type: string | |
| emv: | |
| description: Whether the card was dipped (using the EMV chip) during this | |
| Transaction | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Not dipped | |
| - Dipped | |
| entryMode: | |
| description: How payment information has been entered. | |
| enum: | |
| - '1' | |
| - '2' | |
| - '3' | |
| - '4' | |
| - '5' | |
| - '6' | |
| - '7' | |
| - '8' | |
| - '9' | |
| - '10' | |
| - '11' | |
| - '12' | |
| - '13' | |
| - '14' | |
| type: integer | |
| x-enum-descriptions: | |
| - Terminal used with key entry. | |
| - Track 1 read. | |
| - Track 2 read. | |
| - Complete magnetic stripe read. | |
| - EMV chip read. | |
| - EMV/Magnetic Stripe through contactless card. | |
| - Fallback from EMV to Swipe. | |
| - Fallback from EMV to Manual Entry. | |
| - Apple Pay. | |
| - Google Pay. | |
| - Merchant created transaction. | |
| - Invoice payment. | |
| - Merchant created transaction in payrix portal. | |
| - Invoice payment from payrix portal. | |
| expiration: | |
| description: "The expiration date of this Transaction. \nThis field is stored\ | |
| \ as a text string in 'MMYY' format, where 'MM' is the number of a month\ | |
| \ and 'YY' is the last two digits of a year. For example, '0623' for June\ | |
| \ 2023. \nThe value must reflect a future date." | |
| type: string | |
| fee: | |
| description: "Optional calculated fee amount indicator. This should be used\ | |
| \ in conjunction with txnFee setting on Fees resource. \nThis field is\ | |
| \ specified as an integer in cents." | |
| type: string | |
| first: | |
| description: The first name associated with this Transaction. For eCheck | |
| transactions, either first or last is required. | |
| type: string | |
| fortxn: | |
| description: "If this Transaction is related to another Transaction, then\ | |
| \ this field is set to the identifier of the other Transaction. \nFor\ | |
| \ example, if this Transaction is a refund, this field could be set to\ | |
| \ the identifier of the original sale Transaction." | |
| type: string | |
| fromtxn: | |
| description: Reauthorize this referenced Transaction. For example, to process | |
| a resubmission of a declined Transaction or to reauthorize an expired | |
| Transaction. | |
| type: string | |
| frozen: | |
| description: Whether this resource is marked as frozen. | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Not frozen | |
| - Frozen | |
| funded: | |
| description: "A date indicating when this Transaction was funded. \nThis\ | |
| \ field is set automatically." | |
| type: integer | |
| fundingCurrency: | |
| description: The funding currency of the txn. | |
| enum: | |
| - AED | |
| - AFN | |
| - ALL | |
| - AMD | |
| - ANG | |
| - AOA | |
| - ARS | |
| - AUD | |
| - AWG | |
| - AZN | |
| - BAM | |
| - BBD | |
| - BDT | |
| - BGN | |
| - BHD | |
| - BIF | |
| - BMD | |
| - BND | |
| - BOB | |
| - BOV | |
| - BRL | |
| - BSD | |
| - BTN | |
| - BWP | |
| - BYN | |
| - BZD | |
| - CAD | |
| - CDF | |
| - CHE | |
| - CHF | |
| - CHW | |
| - CLF | |
| - CLP | |
| - CNY | |
| - COP | |
| - COU | |
| - CRC | |
| - CUC | |
| - CUP | |
| - CVE | |
| - CZK | |
| - DJF | |
| - DKK | |
| - DOP | |
| - DZD | |
| - EGP | |
| - ERN | |
| - ETB | |
| - EUR | |
| - FJD | |
| - FKP | |
| - GBP | |
| - GEL | |
| - GHS | |
| - GIP | |
| - GMD | |
| - GNF | |
| - GTQ | |
| - GYD | |
| - HKD | |
| - HNL | |
| - HRK | |
| - HTG | |
| - HUF | |
| - IDR | |
| - ILS | |
| - INR | |
| - IQD | |
| - IRR | |
| - ISK | |
| - JMD | |
| - JOD | |
| - JPY | |
| - KES | |
| - KGS | |
| - KHR | |
| - KMF | |
| - KPW | |
| - KRW | |
| - KWD | |
| - KYD | |
| - KZT | |
| - LAK | |
| - LBP | |
| - LKR | |
| - LRD | |
| - LSL | |
| - LYD | |
| - MAD | |
| - MDL | |
| - MGA | |
| - MKD | |
| - MMK | |
| - MNT | |
| - MOP | |
| - MRU | |
| - MUR | |
| - MVR | |
| - MWK | |
| - MXN | |
| - MXV | |
| - MYR | |
| - MZN | |
| - NAD | |
| - NGN | |
| - NIO | |
| - NOK | |
| - NPR | |
| - NZD | |
| - OMR | |
| - PAB | |
| - PEN | |
| - PGK | |
| - PHP | |
| - PKR | |
| - PLN | |
| - PYG | |
| - QAR | |
| - RON | |
| - RSD | |
| - RUB | |
| - RWF | |
| - SAR | |
| - SBD | |
| - SCR | |
| - SDG | |
| - SEK | |
| - SGD | |
| - SHP | |
| - SLL | |
| - SOS | |
| - SRD | |
| - SSP | |
| - STN | |
| - SVC | |
| - SYP | |
| - SZL | |
| - THB | |
| - TJS | |
| - TMT | |
| - TND | |
| - TOP | |
| - TRY | |
| - TTD | |
| - TWD | |
| - TZS | |
| - UAH | |
| - UGX | |
| - USD | |
| - USN | |
| - UYI | |
| - UYU | |
| - UZS | |
| - VEF | |
| - VND | |
| - VUV | |
| - WST | |
| - XAF | |
| - XAG | |
| - XAU | |
| - XBA | |
| - XBB | |
| - XBC | |
| - XBD | |
| - XCD | |
| - XDR | |
| - XOF | |
| - XPD | |
| - XPF | |
| - XPT | |
| - XSU | |
| - XUA | |
| - YER | |
| - ZAR | |
| - ZMW | |
| - ZWL | |
| type: string | |
| x-enum-descriptions: | |
| - United Arab Emirates dirham | |
| - Afghan afghani | |
| - Albanian lek | |
| - Armenian dram | |
| - Netherlands Antillean guilder | |
| - Angolan kwanza | |
| - Argentine peso | |
| - Australian dollar | |
| - Aruban florin | |
| - Azerbaijani manat | |
| - Bosnia and Herzegovina convertible mark | |
| - Barbados dollar | |
| - Bangladeshi taka | |
| - Bulgarian lev | |
| - Bahraini dinar | |
| - Burundian franc | |
| - Bermudian dollar | |
| - Brunei dollar | |
| - Boliviano | |
| - Bolivian Mvdol | |
| - Brazilian real | |
| - Bahamian dollar | |
| - Bhutanese ngultrum | |
| - Botswana pula | |
| - Belarusian ruble | |
| - Belize dollar | |
| - Canadian dollar | |
| - Congolese franc | |
| - WIR Euro | |
| - Swiss franc | |
| - WIR Franc | |
| - Unidad de Fomento | |
| - Chilean peso | |
| - Renminbi (Chinese) yuan | |
| - Colombian peso | |
| - Unidad de Valor Real | |
| - Costa Rican colon | |
| - Cuban convertible peso | |
| - Cuban peso | |
| - Cape Verde escudo | |
| - Czech koruna | |
| - Djiboutian franc | |
| - Danish krone | |
| - Dominican peso | |
| - Algerian dinar | |
| - Egyptian pound | |
| - Eritrean nakfa | |
| - Ethiopian birr | |
| - Euro | |
| - Fiji dollar | |
| - Falkland Islands pound | |
| - Pound sterling | |
| - Georgian lari | |
| - Ghanaian cedi | |
| - Gibraltar pound | |
| - Gambian dalasi | |
| - Guinean franc | |
| - Guatemalan quetzal | |
| - Guyanese dollar | |
| - Hong Kong dollar | |
| - Honduran lempira | |
| - Croatian kuna | |
| - Haitian gourde | |
| - Hungarian forint | |
| - Indonesian rupiah | |
| - Israeli new shekel | |
| - Indian rupee | |
| - Iraqi dinar | |
| - Iranian rial | |
| - "Icelandic kr\xF3na" | |
| - Jamaican dollar | |
| - Jordanian dinar | |
| - Japanese yen | |
| - Kenyan shilling | |
| - Kyrgyzstani som | |
| - Cambodian riel | |
| - Comoro franc | |
| - North Korean won | |
| - South Korean won | |
| - Kuwaiti dinar | |
| - Cayman Islands dollar | |
| - Kazakhstani tenge | |
| - Lao kip | |
| - Lebanese pound | |
| - Sri Lankan rupee | |
| - Liberian dollar | |
| - Lesotho loti | |
| - Libyan dinar | |
| - Moroccan dirham | |
| - Moldovan leu | |
| - Malagasy ariary | |
| - Macedonian denar | |
| - Myanmar kyat | |
| - "Mongolian t\xF6gr\xF6g" | |
| - Macanese pataca | |
| - Mauritanian ouguiya | |
| - Mauritian rupee | |
| - Maldivian rufiyaa | |
| - Malawian kwacha | |
| - Mexican peso | |
| - Mexican Unidad de Inversion | |
| - Malaysian ringgit | |
| - Mozambican metical | |
| - Namibian dollar | |
| - Nigerian naira | |
| - "Nicaraguan c\xF3rdoba" | |
| - Norwegian krone | |
| - Nepalese rupee | |
| - New Zealand dollar | |
| - Omani rial | |
| - Panamanian balboa | |
| - Peruvian sol | |
| - Papua New Guinean kina | |
| - Philippine piso | |
| - Pakistani rupee | |
| - "Polish z\u0142oty" | |
| - "Paraguayan guaran\xED" | |
| - Qatari riyal | |
| - Romanian leu | |
| - Serbian dinar | |
| - Russian ruble | |
| - Rwandan franc | |
| - Saudi riyal | |
| - Solomon Islands dollar | |
| - Seychelles rupee | |
| - Sudanese pound | |
| - Swedish krona/kronor | |
| - Singapore dollar | |
| - Saint Helena pound | |
| - Sierra Leonean leone | |
| - Somali shilling | |
| - Surinamese dollar | |
| - South Sudanese pound | |
| - "S\xE3o Tom\xE9 and Pr\xEDncipe dobra" | |
| - "Salvadoran col\xF3n" | |
| - Syrian pound | |
| - Swazi lilangeni | |
| - Thai baht | |
| - Tajikistani somoni | |
| - Turkmenistan manat | |
| - Tunisian dinar | |
| - Tongan pa'anga | |
| - Turkish lira | |
| - Trinidad and Tobago dollar | |
| - New Taiwan dollar | |
| - Tanzanian shilling | |
| - Ukrainian hryvnia | |
| - Ugandan shilling | |
| - United States dollar | |
| - United States dollar | |
| - Uruguay Peso en Unidades Indexadas | |
| - Uruguayan peso | |
| - Uzbekistan som | |
| - "Venezuelan bol\xEDvar" | |
| - "Vietnamese \u0111\u1ED3ng" | |
| - Vanuatu vatu | |
| - Samoan tala | |
| - CFA franc BEAC | |
| - Silver | |
| - Gold | |
| - European Composite Unit | |
| - European Monetary Unit | |
| - European Unit of Account | |
| - European Unit of Account | |
| - East Caribbean dollar | |
| - Special drawing rights | |
| - CFA franc BCEAO | |
| - Palladium | |
| - CFP franc | |
| - Platinum | |
| - SUCRE | |
| - ADB Unit of Account | |
| - Yemeni rial | |
| - South African rand | |
| - Zambian kwacha | |
| - Zimbabwean dollar | |
| fundingEnabled: | |
| description: Whether or not funding is enabled for this Txn | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Disabled | |
| - Enabled | |
| id: | |
| description: The ID of this resource. | |
| type: string | |
| imported: | |
| description: "Whether the txn was imported from a report or not. \nThis\ | |
| \ field is set automatically." | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| inactive: | |
| description: Whether this resource is marked as inactive. | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Active | |
| - Inactive | |
| ipCreated: | |
| description: The incoming ip address from which this Transaction was created. | |
| type: string | |
| ipModified: | |
| description: The incoming ip address from which this Transaction was last | |
| modified. | |
| type: string | |
| last: | |
| description: The last name associated with this Transaction. For eCheck | |
| transactions, either first or last is required. | |
| type: string | |
| merchant: | |
| description: The identifier of the Merchant associated with this Transaction. | |
| type: string | |
| middle: | |
| description: The middle name associated with this Transaction. | |
| type: string | |
| misused: | |
| description: Indicates if an authorization has been misused by not being | |
| captured or reversed within the timeframe. The timeframe varies per network, | |
| mcc and type of txn closing (capture/reverse auth). | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Not misused | |
| - Misused | |
| mobile: | |
| description: Indicates if a transaction is being processed through a Mobile | |
| POS | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Non-mobile POS | |
| - Mobile POS | |
| modified: | |
| description: The date and time at which this resource was modified. | |
| format: date-time | |
| type: string | |
| modifier: | |
| description: The identifier of the Login that last modified this resource. | |
| type: string | |
| networkTokenIndicator: | |
| description: Indicates if a transaction qualified for a network token through | |
| Network Payment Manager. | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - N | |
| - Y | |
| order: | |
| description: "The identifier of the Order associated with this Transaction.\ | |
| \ \nThis field is stored as a text string and must be between 0 and 1000\ | |
| \ characters long." | |
| type: string | |
| origin: | |
| description: The origin of this Transaction. | |
| enum: | |
| - '1' | |
| - '2' | |
| - '3' | |
| - '4' | |
| - '5' | |
| - '6' | |
| - '7' | |
| - '8' | |
| - '9' | |
| type: integer | |
| x-enum-descriptions: | |
| - Originated at a credit card terminal. | |
| - Originated through an eCommerce system. | |
| - Originated as a mail order or telephone order transaction. | |
| - '' | |
| - Originated as a Successful 3D Secure transaction. | |
| - Originated as an Attempted 3D Secure transaction. | |
| - Originated as a recurring transaction on the card. | |
| - Originated in a Payframe. | |
| - Originated as a transaction where authorization was received in writing. | |
| originalApproved: | |
| type: integer | |
| payment: | |
| $ref: '#/definitions/txnspaymentResponseFields' | |
| phone: | |
| description: "The phone number associated with this Transaction. \nThis\ | |
| \ field is stored as a text string and must be between 10 and 15 characters\ | |
| \ long." | |
| type: string | |
| pin: | |
| description: Whether this Transaction was verified with a PIN. | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| pinEntryCapability: | |
| description: Indicates the PIN entry capability of the device | |
| enum: | |
| - unknown | |
| - capable | |
| - notCapable | |
| - pinPadDown | |
| type: string | |
| x-enum-descriptions: | |
| - Unknown PIN Entry Capability | |
| - Terminal can accept PINs | |
| - Terminal cannot accept entry of PINs | |
| - Terminal PIN Pad is down | |
| platform: | |
| description: The platform used to process this Transaction. | |
| enum: | |
| - APPLE | |
| - ELAVON | |
| - FIRSTDATA | |
| - VANTIV | |
| - VCORE | |
| - WELLSACH | |
| - WELLSFARGO | |
| - WFSINGLE | |
| - WORLDPAY | |
| - TDBANKCA | |
| type: string | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| processedSequence: | |
| type: integer | |
| refunded: | |
| description: The amount of this Transaction that has been refunded. | |
| type: integer | |
| requestSequence: | |
| type: integer | |
| reserved: | |
| description: Indicates whether the Transaction is reserved and the action | |
| that will be taken as a result. | |
| enum: | |
| - '0' | |
| - '1' | |
| - '3' | |
| - '4' | |
| - '5' | |
| - '6' | |
| - '7' | |
| - '8' | |
| type: integer | |
| x-enum-descriptions: | |
| - No reserve | |
| - Transaction processing withheld. | |
| - Transaction capture withheld pending manual review. | |
| - Move all funds from this Transaction into a reserve. | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| returned: | |
| type: integer | |
| serviceCode: | |
| type: string | |
| settled: | |
| description: "A date indicating when this Transaction was settled. \nThis\ | |
| \ field is set automatically." | |
| type: integer | |
| settledCurrency: | |
| description: "The currency of the settled total. \nThis field is set automatically." | |
| enum: | |
| - AED | |
| - AFN | |
| - ALL | |
| - AMD | |
| - ANG | |
| - AOA | |
| - ARS | |
| - AUD | |
| - AWG | |
| - AZN | |
| - BAM | |
| - BBD | |
| - BDT | |
| - BGN | |
| - BHD | |
| - BIF | |
| - BMD | |
| - BND | |
| - BOB | |
| - BOV | |
| - BRL | |
| - BSD | |
| - BTN | |
| - BWP | |
| - BYN | |
| - BZD | |
| - CAD | |
| - CDF | |
| - CHE | |
| - CHF | |
| - CHW | |
| - CLF | |
| - CLP | |
| - CNY | |
| - COP | |
| - COU | |
| - CRC | |
| - CUC | |
| - CUP | |
| - CVE | |
| - CZK | |
| - DJF | |
| - DKK | |
| - DOP | |
| - DZD | |
| - EGP | |
| - ERN | |
| - ETB | |
| - EUR | |
| - FJD | |
| - FKP | |
| - GBP | |
| - GEL | |
| - GHS | |
| - GIP | |
| - GMD | |
| - GNF | |
| - GTQ | |
| - GYD | |
| - HKD | |
| - HNL | |
| - HRK | |
| - HTG | |
| - HUF | |
| - IDR | |
| - ILS | |
| - INR | |
| - IQD | |
| - IRR | |
| - ISK | |
| - JMD | |
| - JOD | |
| - JPY | |
| - KES | |
| - KGS | |
| - KHR | |
| - KMF | |
| - KPW | |
| - KRW | |
| - KWD | |
| - KYD | |
| - KZT | |
| - LAK | |
| - LBP | |
| - LKR | |
| - LRD | |
| - LSL | |
| - LYD | |
| - MAD | |
| - MDL | |
| - MGA | |
| - MKD | |
| - MMK | |
| - MNT | |
| - MOP | |
| - MRU | |
| - MUR | |
| - MVR | |
| - MWK | |
| - MXN | |
| - MXV | |
| - MYR | |
| - MZN | |
| - NAD | |
| - NGN | |
| - NIO | |
| - NOK | |
| - NPR | |
| - NZD | |
| - OMR | |
| - PAB | |
| - PEN | |
| - PGK | |
| - PHP | |
| - PKR | |
| - PLN | |
| - PYG | |
| - QAR | |
| - RON | |
| - RSD | |
| - RUB | |
| - RWF | |
| - SAR | |
| - SBD | |
| - SCR | |
| - SDG | |
| - SEK | |
| - SGD | |
| - SHP | |
| - SLL | |
| - SOS | |
| - SRD | |
| - SSP | |
| - STN | |
| - SVC | |
| - SYP | |
| - SZL | |
| - THB | |
| - TJS | |
| - TMT | |
| - TND | |
| - TOP | |
| - TRY | |
| - TTD | |
| - TWD | |
| - TZS | |
| - UAH | |
| - UGX | |
| - USD | |
| - USN | |
| - UYI | |
| - UYU | |
| - UZS | |
| - VEF | |
| - VND | |
| - VUV | |
| - WST | |
| - XAF | |
| - XAG | |
| - XAU | |
| - XBA | |
| - XBB | |
| - XBC | |
| - XBD | |
| - XCD | |
| - XDR | |
| - XOF | |
| - XPD | |
| - XPF | |
| - XPT | |
| - XSU | |
| - XUA | |
| - YER | |
| - ZAR | |
| - ZMW | |
| - ZWL | |
| type: string | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - United States dollars | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| settledTotal: | |
| description: "The total amount that was settled. \nThis field is specified\ | |
| \ as an integer in cents and is set automatically." | |
| type: integer | |
| shipping: | |
| description: The shipping fee pertaining to this transaction. | |
| type: integer | |
| signature: | |
| description: "Whether a signature was captured during this Transaction.\ | |
| \ \nYou can set this field if you took a signature for the Transaction.\ | |
| \ The API also sets this field automatically if you associate a signature\ | |
| \ to the Transaction by creating a 'txnDatas' resource." | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Not captured. | |
| - Captured. | |
| state: | |
| description: "The state associated with this Transaction. \nIf in the U.S.\ | |
| \ this is specified as the 2 character postal abbreviation for the state,\ | |
| \ if outside of the U.S. the full state name. \nThis field is stored as\ | |
| \ a text string and must be between 2 and 100 characters long." | |
| enum: | |
| - AB | |
| - BC | |
| - MB | |
| - NB | |
| - NL | |
| - NT | |
| - NS | |
| - NU | |
| - 'ON' | |
| - PE | |
| - QC | |
| - SK | |
| - YT | |
| type: string | |
| x-enum-descriptions: | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| - '' | |
| statement: | |
| type: string | |
| status: | |
| description: The status of the Transaction. | |
| enum: | |
| - '0' | |
| - '1' | |
| - '2' | |
| - '3' | |
| - '4' | |
| - '5' | |
| type: integer | |
| x-enum-descriptions: | |
| - Pending | |
| - Approved | |
| - Failed | |
| - Captured | |
| - Settled | |
| - Returned | |
| subscription: | |
| description: The identifier of the Subscription associated with this Transaction. | |
| type: string | |
| surcharge: | |
| description: "The amount of the total sum of this Transaction that is made\ | |
| \ up of surcharge. \nThis field is specified as an integer in cents." | |
| type: integer | |
| swiped: | |
| description: "Whether the card was swiped during this Transaction. \nThis\ | |
| \ field is set to '1' automatically if 'track' data was received." | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Not swiped. | |
| - Swiped. | |
| tax: | |
| description: "The amount of the total sum of this Transaction that is made\ | |
| \ up of tax. \nThis field is specified as an integer in cents." | |
| type: integer | |
| terminal: | |
| description: "The identifier of the terminal that processed this Transaction.\ | |
| \ \nThe identifier is taken from the terminal system and varies in format\ | |
| \ according to the type of terminal. \nThis field is stored as a text\ | |
| \ string and must be between 0 and 50 characters long." | |
| type: string | |
| terminalCapability: | |
| description: Capabilities of the terminal device. | |
| enum: | |
| - '1' | |
| - '2' | |
| - '3' | |
| - '4' | |
| type: integer | |
| x-enum-descriptions: | |
| - Key entry only terminal. | |
| - Can read magnetic stripe. | |
| - Integrated circuit reader. | |
| - '' | |
| token: | |
| description: The token of the Tokens resource this Transaction is associated | |
| with. | |
| type: string | |
| total: | |
| description: "The total amount of this Transaction. \nThis field is specified\ | |
| \ as an integer in cents." | |
| type: integer | |
| traceNumber: | |
| description: Sequencial number that uniquely identifies the txn. | |
| type: integer | |
| txnsession: | |
| type: string | |
| type: | |
| description: The type of Transaction. | |
| enum: | |
| - '1' | |
| - '2' | |
| - '3' | |
| - '4' | |
| - '5' | |
| - '7' | |
| - '8' | |
| - '11' | |
| - '12' | |
| type: integer | |
| x-enum-descriptions: | |
| - 'Credit Card Only: Sale Transaction. This is the most common type of Transaction, | |
| it processes a sale and charges the customer' | |
| - 'Credit Card Only: Auth Transaction. Authorizes and holds the requested | |
| total on the credit card' | |
| - 'Credit Card Only: Capture Transaction. Finalizes a prior Auth Transaction | |
| and charges the customer' | |
| - 'Credit Card Only: Reverse Authorization. Reverses a prior Auth or Sale | |
| Transaction and releases the credit hold.' | |
| - 'Credit Card Only: Refund Transaction. Refunds a prior Capture or Sale | |
| Transaction (total may be specified for a partial refund).' | |
| - 'Echeck Only: Echeck Sale Transaction. Sale Transaction for ECheck payment.' | |
| - 'Echeck Only: ECheck Refund Transaction. Refund Transaction for prior | |
| ECheck Sale Transaction.' | |
| - 'Echeck Only: Echeck Redeposit Transaction. Attempt to redeposit a prior | |
| failed eCheck Sale Transaction.' | |
| - 'Echeck Only: Echeck Account Verification Transaction. Attempt to verify | |
| eCheck payment details' | |
| unattended: | |
| description: "Whether the card was swiped at an unattended terminal during\ | |
| \ this Transaction. \nThis field is set to '0' by default." | |
| enum: | |
| - '0' | |
| - '1' | |
| type: integer | |
| x-enum-descriptions: | |
| - Attended terminal. | |
| - Unattended terminal. | |
| unauthReason: | |
| description: "The reason for the auth reversal. \n This field is set to\ | |
| \ 'customerCancelled' by default." | |
| enum: | |
| - incomplete | |
| - timeout | |
| - clerkCancelled | |
| - customerCancelled | |
| - misdispense | |
| - hardwareFailure | |
| - suspectedFraud | |
| type: string | |
| x-enum-descriptions: | |
| - Incomplete | |
| - Timeout | |
| - Clerk Cancelled | |
| - Customer Cancelled | |
| - Misdispense | |
| - Hardware Failure | |
| - Suspected Fraud | |
| zip: | |
| description: "The ZIP code in the address associated with this Transaction.\ | |
| \ \nThis field is stored as a text string and must be between 1 and 20\ | |
| \ characters long." | |
| type: string | |
| type: object | |
| txnsQueryResponseRest: | |
| properties: | |
| response: | |
| properties: | |
| data: | |
| description: The data object that the API returns for this request. | |
| items: | |
| $ref: '#/definitions/txnsQueryResponseFields' | |
| type: array | |
| details: | |
| description: An object describing the response, including the request | |
| ID and pagination indicators. | |
| properties: | |
| page: | |
| description: "Where the response lists multiple resources, the API\ | |
| \ splits the response into several 'pages'. \nThis object indicates\ | |
| \ the current and last available pages in the list." | |
| properties: | |
| current: | |
| description: The current page in the paginated resource list. | |
| type: integer | |
| last: | |
| description: The last available page in the paginated resource | |
| list. | |
| type: integer | |
| type: object | |
| requestId: | |
| description: "A unique identifier set by the API client, that is\ | |
| \ echoed by the response. \nThe request ID can be useful in troubleshooting\ | |
| \ and monitoring." | |
| type: string | |
| type: object | |
| errors: | |
| description: An array of zero or more errors that occurred when the | |
| API processed the request. | |
| items: | |
| properties: | |
| code: | |
| description: The error code associated with a particular error. | |
| type: integer | |
| errorCode: | |
| description: An identifying string code for this error. | |
| type: string | |
| message: | |
| description: The message associated with a particular error. | |
| type: string | |
| severity: | |
| description: "The severity level of a particular error. \nPossible\ | |
| \ values are '0' (informational), '1' (warning), '2' (error)\ | |
| \ and '4' (failure)." | |
| type: integer | |
| type: object | |
| type: array | |
| type: object | |
| type: object | |
| info: | |
| title: Payrix API | |
| version: 1.0.0 | |
| openapi: 3.0.0 | |
| paths: | |
| /txns: | |
| get: | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/xml | |
| - text/xml | |
| - multipart/form-data | |
| - application/x-www-form-urlencoded | |
| description: "Query a Transaction. \nTransactions hold all of the information\ | |
| \ relating to a particular credit card transaction, including the merchant,\ | |
| \ token, subscription, customer and card information." | |
| parameters: | |
| - description: "Set this path parameter to retrieve nested objects and return\ | |
| \ them as part of the response. \nThe parameter name that you specify determines\ | |
| \ the resources to return. \nFor example, set '?expand[login][]' to return\ | |
| \ a nested login resource." | |
| in: query | |
| name: expand | |
| type: string | |
| - description: "Set this header to filter or sort the list of resources that\ | |
| \ the method returns. \nFor example, to find all resources that have a property\ | |
| \ of 'public' set to '1', set this header to 'public[equals]=1'. You can\ | |
| \ use the operators 'equals', 'greater', 'less', 'like', 'in' and 'sort'.\ | |
| \ To sort the resources, use the keywords 'asc' (for an ascending sort)\ | |
| \ or 'desc' (for a descending sort).\nYou may also use explicit 'and/or'\ | |
| \ querying by passing arrays of or and arrays of and parameters. For example,\ | |
| \ to find all resources that have a property of 'public' set to '1' or a\ | |
| \ property of 'active' set to '0', set this header to 'or[][public][equals]=1&or[][active][equals]=0'." | |
| in: header | |
| name: search | |
| type: string | |
| - description: "Set this path parameter to request a specific page of records.\ | |
| \ \nFor example, set '?page[number]=2' to retrieve the second page of records\ | |
| \ for this request." | |
| in: query | |
| name: page[number] | |
| type: string | |
| - description: 'Set this path parameter to request up to a specific amount of | |
| records. By default 30 records are retrieved per page. The maximum limit | |
| that can be set is 100. | |
| For example, set ''?page[limit]=50'' to retrieve up to 50 records for this | |
| request.' | |
| in: query | |
| name: page[limit] | |
| type: string | |
| produces: | |
| - application/json | |
| - application/xml | |
| responses: | |
| '200': | |
| description: Response for query on txns resource | |
| schema: | |
| $ref: '#/definitions/txnsQueryResponseRest' | |
| post: | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/xml | |
| - text/xml | |
| - multipart/form-data | |
| - application/x-www-form-urlencoded | |
| description: "Create a Transaction. \nTransactions hold all of the information\ | |
| \ relating to a particular credit card transaction, including the merchant,\ | |
| \ token, subscription, customer and card information." | |
| parameters: | |
| - in: body | |
| name: body | |
| required: true | |
| schema: | |
| $ref: '#/definitions/txnsCreateRest' | |
| produces: | |
| - application/json | |
| - application/xml | |
| responses: | |
| '200': | |
| description: Response for create on txns resource | |
| schema: | |
| $ref: '#/definitions/txnsCreateResponseRest' | |
| x-examples: | |
| - request: | |
| merchant: p1_mer_5a1ef5e55656a739a85da21 | |
| origin: 2 | |
| token: e41272ec5464d9ec81cc85c854837472 | |
| total: 100 | |
| type: 1 | |
| response: | |
| address1: 123 Example St. | |
| address2: Suite 403 | |
| allowPartial: 0 | |
| approved: 100 | |
| authCode: null | |
| authDate: null | |
| authorization: '52703' | |
| batch: p1_bth_5a1ef5e55655f49b141d313 | |
| captured: null | |
| cashback: null | |
| city: New York | |
| company: null | |
| country: USA | |
| created: '2017-11-28 01:02:57' | |
| creator: p1_log_5a1ef5e55653ed720159d53 | |
| cvv: 0 | |
| description: null | |
| email: robert.johnson@example.com | |
| emv: 0 | |
| expiration: '0120' | |
| first: Robert | |
| fortxn: null | |
| frozen: 0 | |
| id: p1_txn_5a1ef5e55658af7cf012866 | |
| inactive: 0 | |
| ipCreated: 8.8.8.8 | |
| ipModified: 8.8.8.8 | |
| last: Johnson | |
| merchant: p1_mer_5a1ef5e55656a739a85da21 | |
| mid: 01170981 | |
| middle: '' | |
| modified: '2017-11-28 01:02:57' | |
| modifier: p1_log_5a1ef5e55653ed720159d53 | |
| order: '' | |
| origin: 2 | |
| phone: '1111111111' | |
| pin: 1 | |
| platform: VANTIV | |
| reserved: 0 | |
| signature: 0 | |
| state: NY | |
| subscription: null | |
| swiped: 0 | |
| tax: null | |
| terminal: null | |
| token: e41272ec5464d9ec81cc85c854837472 | |
| total: 100 | |
| type: 1 | |
| unattended: null | |
| zip: '10001' | |
| - request: | |
| expiration: '0120' | |
| merchant: p1_mer_5a1ef5e55656a739a85da21 | |
| origin: 2 | |
| payment: | |
| cvv: '111' | |
| method: 2 | |
| number: '4111111111111111' | |
| total: 100 | |
| type: 1 | |
| response: | |
| address1: null | |
| address2: null | |
| allowPartial: 0 | |
| approved: 100 | |
| authCode: null | |
| authDate: null | |
| authorization: '92962' | |
| batch: p1_bth_5a1ef5e55655f49b141d313 | |
| captured: null | |
| cashback: null | |
| city: null | |
| company: null | |
| country: null | |
| created: '2017-11-28 01:02:57' | |
| creator: p1_log_5a1ef5e55653ed720159d53 | |
| cvv: 1 | |
| description: null | |
| email: null | |
| emv: 0 | |
| expiration: '0120' | |
| first: null | |
| fortxn: null | |
| frozen: 0 | |
| id: p1_txn_5a1ef5e55658ea5275a3ec0 | |
| inactive: 0 | |
| ipCreated: 8.8.8.8 | |
| ipModified: 8.8.8.8 | |
| last: null | |
| merchant: p1_mer_5a1ef5e55656a739a85da21 | |
| mid: 01170981 | |
| middle: null | |
| modified: '2017-11-28 01:02:57' | |
| modifier: p1_log_5a1ef5e55653ed720159d53 | |
| order: '' | |
| origin: 2 | |
| payment: | |
| method: 2 | |
| number: '1111' | |
| payment: null | |
| routing: '0' | |
| phone: null | |
| pin: 1 | |
| platform: VANTIV | |
| reserved: 0 | |
| signature: 0 | |
| state: null | |
| subscription: null | |
| swiped: 0 | |
| tax: null | |
| terminal: null | |
| token: null | |
| total: 100 | |
| type: 1 | |
| unattended: null | |
| zip: null | |
| - request: | |
| fortxn: p1_txn_5a1ef5e55658ea5275a3ec0 | |
| type: 5 | |
| response: | |
| address1: null | |
| address2: null | |
| allowPartial: 0 | |
| approved: null | |
| authCode: null | |
| authDate: null | |
| authorization: null | |
| batch: null | |
| captured: null | |
| cashback: null | |
| city: null | |
| company: null | |
| country: null | |
| created: '2017-11-28 01:02:57' | |
| creator: p1_log_5a1ef5e55653ed720159d53 | |
| cvv: 0 | |
| description: null | |
| email: null | |
| emv: 0 | |
| expiration: null | |
| first: null | |
| fortxn: p1_txn_5a1ef5e55658ea5275a3ec0 | |
| frozen: 0 | |
| id: p1_txn_5a1ef5e55659100de282ca8 | |
| inactive: 0 | |
| ipCreated: 8.8.8.8 | |
| ipModified: 8.8.8.8 | |
| last: null | |
| merchant: p1_mer_5a1ef5e55656a739a85da21 | |
| mid: 01170981 | |
| middle: null | |
| modified: '2017-11-28 01:02:57' | |
| modifier: p1_log_5a1ef5e55653ed720159d53 | |
| order: '' | |
| origin: 2 | |
| phone: null | |
| pin: 1 | |
| platform: VANTIV | |
| reserved: 0 | |
| signature: 0 | |
| state: null | |
| subscription: null | |
| swiped: 0 | |
| tax: null | |
| terminal: null | |
| token: null | |
| total: 100 | |
| type: 5 | |
| unattended: null | |
| zip: null |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment