| POST | /api/v1/force/credit | Creates a new credit card force based on the passed in amounts | This endpoint supports QuickChip/PreRead functionality. See QuickChip/PreRead documentation for more information. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApprovalNumber | body | string | No | The approval number of a voice authorization |
| Configuration | body | ForceCreditRequestConfiguration | No | Any value included in this section will override the corresponding value set in the triPOS.config |
| TransactionAmount | body | string | No | The total transaction amount. This is the amount of funds to move on the card |
| Lodging | body | LodgingTransactionCompletion | No | The lodging parameters to be passed in for a lodging transaction. more» |
| SalesTaxAmount | body | decimal? | No | The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt. |
| CommercialCardCustomerCode | body | string | No | The commercial card customer code for the transaction. This is for Level II. |
| RecurringPaymentType | body | RecurringPaymentType? | No | Intent of why the credentials are being stored.Allowable Values
|
| SubmissionType | body | SubmissionType? | No | Specifies the type of transaction.Allowable Values
|
| NetworkTransactionID | body | string | No | The card brand specific transaction ID that should be stored by the integrator. |
| Address | body | Address | No | The cardholder address information for the transaction. |
| AutoRental | body | AutoRental | No | The auto rental parameters to be passed in for an auto rental transaction. more» |
| InokeManualEntry | body | bool | No | Invokes manual card entry. |
| DisplayTransactionAmount | body | bool | No | Display the transaction amount during card read. |
| QuickChip | body | bool | No | Flag indicating desire to process force credit as QuickChip (i.e. - Pre-Read has been previously performed) more». |
| PreRead | body | bool | No | Flag indicating desire to process force credit as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) more». |
| PreReadId | body | Guid | No | The preReadId returned in the pre-read response. This value should be a GUID.more». |
| IsCscSupported | body | string | No | Invokes prompt for cardholder to enter card security code for manual keyed card entry. |
| CheckForPreReadId | body | bool? | No | Flag to support 'PreReadId feature in quick chip' transaction request. This will take precedence over triPOS.config flag. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CardHolderPresentCode | form | CardHolderPresentCode? | No | Defines whether the cardholder is present at the transaction. This value is optional, but recommended to be set. If this value is not set in the request, it will be automatically set based on the market code.Allowable Values
|
| ClerkNumber | form | string | No | An optional clerk number for reference. |
| LaneId | form | int | No | Specifies which lane to use. |
| ReferenceNumber | form | string | No | A user defined reference number. |
| ShiftId | form | string | No | An optional shift id for reference. |
| TicketNumber | form | string | No | An optional ticket number. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PromptForSignature | form | BasicSignaturePromptOption | No | Specifies how the signature prompt should be handled for the request. If a value is not provided, Never will be used. See Signature Prompt.Allowable Values
|
| ProvisionalAmount | form | string | No | Override provisional amount used for QC transactions, which is $1.00 by default |
| IsManualEntryAllowed | form | string | No | Use this parameter to allow manual entry of card account numbers on the PIN pad. |
| CardReadRetries | form | int? | No | Number of retries in case of bad card read. The default value is 1. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowPartialApprovals | form | bool? | No | If set to false, partial approvals are not allowed |
| CheckForDuplicateTransactions | form | bool? | No | If set to true, enables duplicate checking logic for the transaction at the host. |
| MarketCode | form | MarketCode | No | The market code of the transaction. Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerName | form | string | No | The lodging customer name. |
| AgreementNumber | form | string | No | The lodging agreement number. |
| CheckInDate | form | string | No | The check-in date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD. |
| CheckOutDate | form | string | No | The check-out date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD. |
| RoomAmount | form | decimal | No | The nightly rate for one room. |
| NoShow | form | bool | No | Set to true to indicate no show. Otherwise, value defaults to false. |
| ExtraChargesDetail | form | LodgingExtraChargesDetail[] | No | Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NotUsed.Allowable Values
|
| PrestigiousPropertyCode | form | LodgingPrestigiousPropertyCode | No | The lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant.Allowable Values
|
| SpecialProgramCode | form | LodgingSpecialProgramCode | No | The lodging special program code. For an empty or invalid value, this parameter defaults to Default.Allowable Values
|
| ChargeType | form | LodgingChargeType | No | The lodging charge type. For an empty or invalid value, this parameter defaults to Default.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Duration | form | int | No | The number of hotel stay days. Set to 1 for no show. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BillingAddress1 | form | string | No | The street address used for billing purposes. |
| BillingAddress2 | form | string | No | The street address used for billing purposes. |
| BillingCity | form | string | No | The name of the city used for billing purposes. |
| BillingEmail | form | string | No | The e-mail address used for billing purposes. |
| BillingName | form | string | No | The name used for billing purposes. |
| BillingPhone | form | string | No | The phone number used for billing purposes. The recommended format is (800)555-1212. |
| BillingPostalCode | form | string | No | The postal code used for billing purposes. |
| BillingState | form | string | No | The name of the state used for billing purposes. This value may be any 2 character state code or the full state name. |
| ShippingAddress1 | form | string | No | The street address used for shipping purposes. |
| ShippingAddress2 | form | string | No | The street address used for shipping purposes. |
| ShippingCity | form | string | No | The name of the city used for shipping purposes. |
| ShippingEmail | form | string | No | The e-mail address used for shipping purposes. |
| ShippingName | form | string | No | The name used for shipping purposes. |
| ShippingPhone | form | string | No | The phone number used for shipping purposes. The recommended format is (800)555-1212 |
| ShippingPostalCode | form | string | No | The postal code used for shipping purposes. |
| ShippingState | form | string | No | The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerName | form | string | No | Customer Name. |
| AgreementNumber | form | string | No | Agreement number. |
| VehicleClassCode | form | AutoRentalVehicleClassCode? | No | Classification of rental vehicleAllowable Values
|
| NoShowIndicator | form | AutoRentalNoShowIndicator? | No | No show indicator. Indicates whether rental vehicle was reserved, but not actually rented.Allowable Values
|
| AdjustmentData | form | AutoRentalAdjustmentData | No | Data related to any auto rental adjustments. |
| PickupData | form | AutoRentalPickupData | No | Data related to autorental pickup. |
| ReturnData | form | AutoRentalReturnData | No | Data related to autorental return. |
| DailyRentalRate | form | decimal | No | Rate charged per day Visa/MC – Daily rate required for Corp T&E rate III. |
| WeeklyRentalRate | form | decimal | No | Rate charged per week Visa/MC – Weekly rate required for Corp T&E rate III. |
| InsuranceCharges | form | decimal | No | If insurance is charged, the insurance amount should be provided. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Duration | form | int | No | The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | decimal | No | Adjustment amount. |
| Code | form | AutoRentalAuditAdjustmentCode? | No | Indicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.Allowable Values
|
| ExtraChargesDetail | form | AutoRentalExtraChargesDetail[] | No | Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| City | form | string | No | Auto rental pickup city. |
| CountryCode | form | string | No | Country code where vehicle was picked up. For US, use 840. |
| Date | form | string | No | return date in yyyy-MM-ddTHH:mm:ss format. |
| Location | form | string | No | Name of business where vehicle was picked up. |
| State | form | string | No | Abbreviation of state, province, or other country subdivision where vehicle was picked up. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| City | form | string | No | Auto rental return city. |
| CountryCode | form | string | No | Country code where vehicle was returned. For US, use 840. |
| Date | form | string | No | return date in yyyy-MM-ddTHH:mm:ss format. |
| LocationId | form | string | No | Auto Rental location ID where vehicle was returned. |
| State | form | string | No | Auto rental return state. |
| Distance | form | int | No | Numeric distance traveled during rental period. |
| DistanceUnit | form | AutoRentalDistanceUnit? | No | Unit of measurement applicable to distance traveled.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| QuickChipMessage | form | string | No | The message unique to QuickChip pre-read functionality only. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountNumber | form | string | No | The card account number. |
| BinValue | form | string | No | The BIN entry that matched the account number. |
| CardHolderName | form | string | No | The cardholder name. |
| CardLogo | form | string | No | The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other. |
| CurrencyCode | form | CurrencyCode | No | The currency code used in the transaction.Allowable Values
|
| CountryCode | form | CountryCode? | No | The country code used in the transaction.Allowable Values
|
| Language | form | LanguageCode? | No | The language used in the transaction.Allowable Values
|
| DebitAccountType | form | DebitAccountType? | No | The account type selected and used in the transaction.Allowable Values
|
| EntryMode | form | string | No | Description of how card was entered.Allowable Values
|
| ExpirationYear | form | string | No | The card's expiration year |
| ExpirationMonth | form | string | No | The card's expiration month |
| NetworkLabel | form | string | No | Label that shows the network where the transaction was routed for authorization |
| PaymentType | form | PaymentType | No | Description of payment type utilized.Allowable Values
|
| PinVerified | form | bool | No | True if the PIN was verified, false if not verified or undetermined. |
| Signature | form | Signature | No | The signature data. |
| TerminalId | form | string | No | The ID of the terminal used during the transaction |
| TotalAmount | form | decimal | No | The total amount of the transaction. |
| EBTType | form | EbtTypeSelection? | No | The type of the EBT card |
| BalanceAmount | form | decimal? | No | The balance of the gift card. |
| BalanceCurrencyCode | form | CurrencyCode? | No | The balance currency code. |
| PreReadId | form | Guid | No | Unique ID. If checkForPreReadId field is true, then this ID will be required for the Quick Chip portion of the transaction to be successful. |
| ForeignCurrencyCode | form | string | No | Currency code of the foreign currency. |
| ForeignTransactionAmount | form | string | No | Transaction amount shown in the foreign currency. |
| ConversionRate | form | string | No | Conversion rate for the ForeignCurrencyCode. |
| Odometer | form | string | No | Fleet Odometer Input On The Device |
| FleetUserID | form | string | No | Fleet UserID Input On The Device |
| FleetJobNumber | form | string | No | Fleet Job Number Input On The Device |
| PurchaseDeviceSequenceNumber | form | string | No | Fleet Purchase Device Sequence Number from the card |
| VehicleID | form | string | No | Fleet Vehicle ID Input On The Device |
| BinAttributes | form | Dictionary<string, bool> | No | Available binAttributes of card. more» |
| DriverID | form | string | No | Fleet DriverID Input On The Device |
| IsFleetOdometerPrint | form | bool | No | is Fleet Odometer value Print On the Receipt or not |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApprovalNumber | form | string | No | Approval number from the processor. Depending on card type and processor an approval number might not be returned. |
| IsApproved | form | bool | No | Set to true if the host approved the transaction. |
| Processor | form | Processor | No | Response information from the processor. |
| StatusCode | form | TransactionFlowStatus | No | The status code for the transaction.Allowable Values
|
| TransactionDateTime | form | string | No | Transaction date/time in ISO8601 format |
| TransactionId | form | string | No | The transaction ID from the processor |
| MerchantId | form | string | No | The Merchant used to process the transaction. |
| IsOffline | form | bool | No | A boolean value indicating whether triPOS is disconnected from the host. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Errors | form | List<ApiError> | No | A list of errors that occurred. |
| HasErrors | form | bool | No | Indicates if there are errors. |
| Links | form | IEnumerable<ApiLink> | No | A list of resource links |
| Logs | form | List<string> | No | A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose. |
| Type | form | string | No | The type of object held in the result. |
| Warnings | form | List<ApiWarning> | No | A list of warnings that occurred. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserMessage | form | string | No | An error message targeted at the end user of the integrated business application. |
| DeveloperMessage | form | string | No | An error message targeted at the developer of the integrated business application. |
| ErrorType | form | string | No | Code associated with the error if it exists. |
| ExceptionMessage | form | string | No | The body of the exception message. |
| ExceptionTypeFullName | form | string | No | The full name of the exception. |
| ExceptionTypeShortName | form | string | No | The short name of the exception. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Href | form | string | No | A target (a URI) |
| Method | form | string | No | The HTTP method to access the HREF target |
| Relation | form | string | No | The relation aka. 'rel' (the name of the link) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeveloperMessage | form | string | No | A warning message targeted at the developer of the integrated business application. |
| UserMessage | form | string | No | A warning message targeted at the end user of the integrated business application. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProcessorLogs | form | List<string> | No | [DEPRECATED] Use logs. |
| ProcessorRawResponse | form | string | No | [DEPRECATED] Use rawResponse. |
| ProcessorReferenceNumber | form | string | No | [DEPRECATED] Use the same reference number passed in the request. |
| ProcessorRequestFailed | form | bool | No | [DEPRECATED] Use top level properties (e.g. hasErrors). |
| ProcessorRequestWasApproved | form | bool | No | [DEPRECATED] Use top level properties (e.g isApproved). |
| ProcessorResponseCode | form | ProcessorResponseCode | No | [DEPRECATED] Use expressResponseCode.Allowable Values
|
| ProcessorResponseMessage | form | string | No | [DEPRECATED] Use expressResponseMessage. |
| ExpressResponseCode | form | string | No | The response code received from Express. |
| ExpressResponseMessage | form | string | No | The response message received from Express. |
| HostResponseCode | form | string | No | The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host. |
| HostResponseMessage | form | string | No | The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host. |
| Logs | form | List<string> | No | A list of messages pertaining processing the transaction. |
| RawResponse | form | string | No | The raw processor response. In the case of Express, this is the raw XML returned by the Express platform. |
| RawRequest | form | string | No | |
| ProcessorName | form | ProcessorName | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SignatureData | form | byte[] | No | The byte array of the signature in the format specified by Format. |
| SignatureFormat | form | string | No | The format of the signature.Allowable Values
|
| SignatureStatusCode | form | SignatureStatusCode | No | Indicates why a signature is or is not present.Allowable Values
|
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/ForceCreditRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{"approvalNumber":"String","configuration":{"promptForSignature":"Always","provisionalAmount":"String","cardReadRetries":0,"allowPartialApprovals":false,"checkForDuplicateTransactions":false,"marketCode":"Default"},"transactionAmount":"String","lodging":{"customerName":"String","agreementNumber":"String","checkInDate":"String","checkOutDate":"String","roomAmount":0,"noShow":false,"extraChargesDetail":["NotUsed"],"prestigiousPropertyCode":"NonParticipant","specialProgramCode":"Default","chargeType":"Default","duration":0},"salesTaxAmount":0,"commercialCardCustomerCode":"String","recurringPaymentType":"NotUsed","submissionType":"NotUsed","networkTransactionID":"String","address":{"billingAddress1":"String","billingAddress2":"String","billingCity":"String","billingEmail":"String","billingName":"String","billingPhone":"String","billingPostalCode":"String","billingState":"String","shippingAddress1":"String","shippingAddress2":"String","shippingCity":"String","shippingEmail":"String","shippingName":"String","shippingPhone":"String","shippingPostalCode":"String","shippingState":"String"},"autoRental":{"CustomerName":"String","AgreementNumber":"String","VehicleClassCode":"Unused","NoShowIndicator":"NotApplicable","AdjustmentData":{"Amount":0,"Code":"NoAdjustments","ExtraChargesDetail":["NoExtraCharge"]},"PickupData":{"City":"String","CountryCode":"String","Date":"String","Location":"String","State":"String"},"ReturnData":{"City":"String","CountryCode":"String","Date":"String","LocationId":"String","State":"String","Distance":0,"DistanceUnit":"Unused"},"DailyRentalRate":0,"WeeklyRentalRate":0,"InsuranceCharges":0,"Duration":0},"invokeManualEntry":false,"displayTransactionAmount":false,"quickChip":false,"preRead":false,"preReadId":"00000000000000000000000000000000","isCscSupported":"String","checkForPreReadId":false,"cardHolderPresentCode":"Default","clerkNumber":"String","laneId":0,"referenceNumber":"String","shiftId":"String","ticketNumber":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"quickChipMessage":"String","accountNumber":"String","binValue":"String","cardHolderName":"String","cardLogo":"String","currencyCode":"None","countryCode":"0","language":"English","accountType":"None","entryMode":"String","expirationYear":"String","expirationMonth":"String","networkLabel":"String","paymentType":"None","pinVerified":false,"signature":{"data":"AA==","format":"String","statusCode":"Unknown"},"terminalId":"String","totalAmount":0,"ebtType":"None","balanceAmount":0,"balanceCurrencyCode":"None","foreignCurrencyCode":"String","foreignTransactionAmount":"String","conversionRate":"String","odometer":"String","fleetUserID":"String","fleetJobNumber":"String","purchaseDeviceSequenceNumber":"String","vehicleID":"String","binAttributes":{"String":false},"driverID":"String","approvalNumber":"String","isApproved":false,"_processor":{"processorLogs":["String"],"processorRawResponse":"String","processorReferenceNumber":"String","processorRequestFailed":false,"processorRequestWasApproved":false,"processorResponseCode":"Unknown","processorResponseMessage":"String","expressResponseCode":"String","expressResponseMessage":"String","hostResponseCode":"String","hostResponseMessage":"String","logs":["String"],"rawResponse":"String","rawRequest":"String","processorName":"Unknown"},"statusCode":"None","transactionDateTime":"String","transactionId":"String","merchantId":"String","isOffline":false,"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}