Evertec Unified API Developer Guide - Charge Anywhere Docs Dev

1. Overview

Evertec Unified API (EVUAPI) is a Charge Anywhere cloud integration service created for Evertec payment workflows. It provides a consistent API for a merchant application to submit payment transactions, track their progress, and retrieve their final result while keeping terminal-specific communication and processor interaction behind the EVUAPI boundary.

EVUAPI supports two fundamentally different execution models. Card-not-present transactions use a payment token and normally complete within the create request. Card-present transactions require a physical terminal and therefore progress asynchronously: the terminal completes the cardholder interaction, and the merchant application retrieves the result by RequestId.

Operation	Method and path	Use
API Health	GET /api/v1/health	Check service readiness.
CNP Transaction	POST /api/v1/transactions	Submit a token-based Credit Sale, PreAuth/AuthOnly, Force, IncrementalAuth, Return, or Void.
CNP Close Batch	POST /api/v1/transactions	Close/settle the current gateway batch using transactionType=12.
CP Transaction	POST /api/v1/transactions	Submit a Credit (credit or debit card), Cash, or ATH Móvil transaction to the configured physical terminal.
CP Close Batch	POST /api/v1/transactions	Close/settle the current terminal batch using transactionType=12.
Transaction Status	GET /api/v1/transactions/{RequestId}	Retrieve the current or final result by RequestId.

2. Getting started

2.1 Base URL and transport

Send requests over HTTPS to the base URL assigned for the target environment.

{{BaseUrl}}/api/v1/...

Sandbox BaseURL: https://webtest.chargeanywhere.com/evuapi
Production BaseURL: https://chargeanywhere.com/evuapi

Keep test and production base URLs in separate environment configurations.
Use application/json for request and response bodies.
Apply connection, read, and overall workflow deadlines appropriate to the merchant application.

2.2 Customer identity headers

Transaction requests use the following identity headers. The header values must represent the same merchant-terminal relationship as the corresponding JSON fields. Get Transaction Status sends the same three values as query parameters (see 6.4).

Header	Required	Description
Accept: application/json	Recommended	Requests a JSON representation.
Content-Type: application/json	POST only	Declares a JSON request body.
X-Merchant-Id	Yes	Merchant identifier issued for the integration.
X-Terminal-Id	Yes	Merchant terminal identifier; preserve leading zeros.
X-Identification	Yes	Configured terminal/device identification value.

Do not hard-code: Store environment values in a secret manager or private runtime configuration. Do not publish them in documentation, source code, screenshots, logs, or shared collections.

2.3 First integration sequence

Step	Action
1	Call API Health and confirm the service is ready.
2	Submit either a CNP or CP sale.
3	Persist `RequestId` with the merchant invoice or order.
4	If `Completed=false` or the outcome is uncertain, retrieve transaction status.
5	Persist the final response for reconciliation.

3. Transaction model

3.1 CNP and CP

Card not present (CNP). The merchant sends a payment token with cardPresent=false. Processing normally returns a final approval or decline in the create response.

Card present (CP). The merchant sends cardPresent=true. A physical terminal completes the cardholder interaction, so the initial response can be non-final and the merchant retrieves status until completion.

3.2 Transaction types

Transaction Type	Value
SALE	1
VOID	2
RETURN	3
FORCE	4
AUTH_ONLY	6
CLOSE_BATCH	12
INCREMENTAL_AUTH	13

Reversal (transactionType=11) is not supported. IncrementalAuth is available for CNP only.

Payment types

Payment Type	Value	Channel	Supported transactions
CREDIT (credit and debit cards)	2	CNP, CP	CNP: Sale, Auth, Force, IncrementalAuth, Void, Return. CP: Sale, Auth, Force, Void, Return
CASH	5	CP	Sale, Return
ATH_MOVIL	13	CP	Sale, Return
None (batch)	0	CNP, CP	Close Batch

There is no separate debit tender. Credit and debit cards both use paymentType=2; the terminal determines how a card is routed. paymentType=6 is accepted for backward compatibility and treated as 2. Close Batch uses paymentType=0 on both channels.

Follow-up transaction relationship

Force, IncrementalAuth, Void, and Return carry the original transaction’s context using values from the original response:

Request field	Take it from the original response
originalAmount	AuthorizedAmount
originalApprovalCode	ApprovalCode
originalGatewayReferenceNumber	GatewayReferenceNumber

Force, IncrementalAuth, and Void require all three values. Return requires them when it refers to a previous transaction (linked Return). Sale and Auth are originating transactions and do not send original-transaction fields. For a Void, EVUAPI uses originalGatewayReferenceNumber to locate the transaction being voided.

3.3 RequestId and completion

Field	Meaning	Developer rule
RequestId	EVUAPI tracking identifier for one transaction.	Persist it immediately and use it for status retrieval.
Status	Current business-processing state.	Do not treat an intermediate state as approval.
Completed	Whether the transaction has reached a final state.	Continue recovery/status handling while false.
timeOut	Wait/receive timeout whose behavior depends on CNP versus CP.	Do not interpret expiration of the HTTP wait as cancellation of a CP terminal transaction.

3.4 Transaction statuses

Status	Final?	Customer interpretation
Pending	No	EVUAPI persisted the CP request and terminal dispatch is pending/queued.
SentToTerminal	No	The CP request was accepted for delivery to the configured terminal.
ReceivedByTerminal	No	The terminal acknowledged the request.
Processing	No	Cardholder/payment processing is in progress.
Approved	Yes	The transaction was approved; verify `Completed=true`.
Declined	Yes	The processor declined the transaction; verify `Completed=true`.
Failed	Yes	Processing could not complete successfully.
TimedOut	Yes	The terminal workflow reached its processing deadline.
Cancelled	Yes	The transaction was cancelled before approval.

4. Customer workflows

4.1 CNP sale workflow

Figure 1. A token-based CNP sale normally returns its final result in the create response.

Send cardPresent=false and a valid tokenNumber.
Persist RequestId even when a final result is returned.
Use transaction status if the create response is missing, non-final, or uncertain.

4.2 CP sale workflow

Figure 2. A CP sale can return an intermediate state; the merchant retrieves status by RequestId. A configured terminal is required to complete an end-to-end CP test.

5. Common transaction contracts

5.1 Create-transaction request fields

CNP and CP use the same request model. The requirement changes for tokenNumber, cardPresent, and the expected handling of timeOut.

Field	Type	CNP	CP	Description
merchantId	string	Required	Required	Merchant identifier; must match X-Merchant-Id.
identification	string	Required	Required	Configured terminal/device identity; must match X-Identification.
terminalId	string	Required	Required	Merchant terminal ID; must match X-Terminal-Id and preserve leading zeros.
terminalDateTime	datetime	Required	Required	Initiator local date/time in YYYY-MM-DDTHH:mm:ss form.
paymentType	integer	Required	Required	Type of payment method used (see 3.2). 2 covers credit and debit cards; 6 is treated as 2. 0 for Close Batch.
transactionType	integer	Required	Required	Type of transaction (see 3.2).
stationNumber	integer	Recommended	Recommended	Station/register number. Returned in EvertecResponse.station_number.
cashierId	integer	Recommended	Recommended	Cashier/clerk identifier. Returned in EvertecResponse.cashier_id.
cardPresent	boolean	false	true	Selects token processing or physical-terminal processing.
tokenNumber	string	Required	Empty	Payment token for CNP. Treat as sensitive.
fullName	string	Optional	Optional	Customer/cardholder display name.
amountOfSale	decimal	Required	Required	Base sale amount before tax, tips, cashback, and fee.
tax	decimal	Calculated	Calculated	Total tax amount: stateTax + cityTax + reducedTax.
baseStateTax	decimal	Optional	Optional	Taxable base for state and municipal taxes.
baseReducedTax	decimal	Optional	Optional	Taxable base for reduced tax.
stateTax	decimal	Optional	Optional	State tax amount.
cityTax	decimal	Optional	Optional	Municipal/city tax amount.
reducedTax	decimal	Optional	Optional	Reduced-rate tax amount.
subTotal	decimal	Calculated	Calculated	Set to amountOfSale, before tax, tips, cashback, and fee.
tips	decimal	Optional	Optional	Tip or gratuity amount.
cashBack	decimal	Optional	Optional	Cashback amount.
fee	decimal	Optional	Optional	Additional fee amount.
grandTotal	decimal	Calculated	Calculated	subTotal + tax + tips + cashBack + fee.
originalAmount	decimal	Follow-up only	Follow-up only	AuthorizedAmount of the original transaction. Required for Force, IncrementalAuth, and Void; for a linked Return. Omit for Sale and Auth.
originalApprovalCode	string	Follow-up only	Follow-up only	ApprovalCode of the original transaction. Same rules as originalAmount.
originalGatewayReferenceNumber	string	Follow-up only	Follow-up only	GatewayReferenceNumber of the original transaction. Same rules as originalAmount; required for Void.
appVersion	string	Recommended	Recommended	Calling-application version for support and compatibility.
timeOut	integer	Optional	Optional	Maximum milliseconds to wait before returning the latest state; does not cancel processing. 0 uses the default (CNP) or returns immediately (CP).

The fields customerNumber, clerkNumber, clerkName, invoiceNumber, and transactionHash are not part of the request.

Money: Use fixed-precision decimal arithmetic. Before sending, validate grandTotal = subTotal + tax + tips + cashBack + fee and tax = stateTax + cityTax + reducedTax when those components are supplied.

5.2 Transaction response fields

Response properties are returned in PascalCase (for example RequestId, Status). Properties inside EvertecResponse use snake_case. Parse property names case-insensitively and ignore properties you do not recognize.

Field	Type	Description
RequestId	string	EVUAPI correlation ID. Persist immediately.
Status	string	Current transaction lifecycle state (see 3.4).
Completed	boolean	true only when the state/result is final.
ResponseCode	string/null	EVUAPI-normalized result code (see 5.3); preserve leading zeros.
ProcessorResponseCode	string/null	Raw processor/terminal response code; preserve leading zeros. Empty when the processor was not reached.
ResponseText	string/null	Human-readable processor or application result.
EvertecResponse	object/null	Processor-specific response container (see 5.5). null while the transaction is not final.
ApprovalCode	string/null	Processor authorization code. It can also be present on a decline; decide approval from Status.
GatewayReferenceNumber	string/null	Gateway transaction reference. Use it as originalGatewayReferenceNumber in follow-ups.
AuthorizedAmount	decimal/null	Amount authorized by the processor. 0 for an approved Void.
TokenNumber	string/null	Returned payment token for CNP; null for CP. Treat as sensitive.
CardType	string/null	Card brand or tender code (see 5.4).
StatusUrl	string/null	Relative status-retrieval URL. Add the identity query parameters from 6.4.
ErrorId	string/null	Support correlation identifier when returned.

5.3 Response codes

ResponseCode	Meaning	Developer action
000	Approved.	Complete the sale.
010	Approved with terminal code 10 (partial approval).	Compare AuthorizedAmount with the requested grandTotal and collect any balance another way.
FFE	Declined by the processor.	Ask for another payment method; do not retry unchanged.
FFF	Other non-approved card-present result.	Treat as not approved; check ResponseText.
FE6	Invalid transaction data; rejected by the gateway before the processor.	Correct the request data (for example stale original-transaction values).

Base business decisions on Status and Completed. Use ResponseCode and ProcessorResponseCode for reporting and troubleshooting.

5.4 Card type codes

CardType	Brand / tender
1	Visa
2	Mastercard
3	American Express
4	Discover
994	ATH Móvil
999	Cash

5.5 EvertecResponse

CNP. EVUAPI returns a stable, normalized object. All of the properties below are always present, in this order; unavailable values are null.

Property	Description
trace_number	System trace audit number.
batch_number	Gateway batch number.
card_acceptor_id	Always NONE.
special_account	Credit cards: VC, MC, AX, DC. Debit cards: AT. Other tenders: IC Cash, AM ATH Móvil.
merchant_id / merchant_vid	Evertec merchant ID (same value in both).
pan_card_number	Last four digits of the card number.
reference	Gateway reference. On a Void, the reference of the voided transaction.
receipt_output	{ merchant, customer }; both null for CNP.
amounts	{ total, base_state_tax, tip, reduced_tax, base_reduced_tax, state_tax, city_tax } as decimal strings.
authorization_code	Processor authorization code.
emv_data	Always {}.
signature_indicator	Always NOSIGN.
transaction_time / transaction_date	HHmmss / MMddyyyy.
payment_host	Always ATH1.
invoice_number	Always null.
terminal_id / terminal_vid	Evertec terminal ID (same value in both).
approval_code	Raw processor response code (00 = approved).
cashier_id / station_number	The request’s cashierId / stationNumber, as strings.
manual_entry_indicator	Always yes.
ivu	{ control_line1, control_line2 }: IVU control lines when returned.
process_cashback	yes / no.
card_bin_type	VISA, MASTERCARD, AMEX, DISCOVER, or null.
response_message	Processor or gateway message.
receipt_email	Always no.
transaction_type_indicator	C credit card D debit card I Cash E EBT A ATH Móvil
entry_type	Always MANUAL.
fallback	no, or null.

CP. EvertecResponse is the terminal’s final result. The properties present depend on the tender, entry mode, and operation, so treat every property as optional. Common additions to the CNP list are: target_reference (Force/Void: reference of the original transaction), emv_data tags (chip/contactless reads), receipt_output HTML receipts, entry_type (for example CTLS), ath_trans_id (ATH Móvil), and settlement_data (Close Batch, see 6.3.11; also returned by CNP Close Batch). Receipts can contain masked card data, EMV data, and a signature image; store them securely.

5.6 HTTP status codes

HTTP status	Meaning	Developer action
200	Request processed; the body contains the current or final state. A decline is also returned with 200.	Read Completed and Status.
202	CP request accepted; the result is not final.	Retrieve transaction status.
4xx	Validation, identity, or authorization failure, or unknown resource.	Correct the request; do not retry unchanged.
5xx	Service or dependency failure.	Keep RequestId/ErrorId and check status before any retry.

6. API reference

Postman collection

Every request in this guide is available in the EVUAPI Postman collection, with example responses for each one. Import the collection together with the sandbox environment, set your credentials in the environment, and run the requests in order. The collection scripts calculate tax, subTotal and grandTotal, and carry RequestId and the original-transaction values into Force, IncrementalAuth, Void and Return automatically.

6.1 Get API Health

Attribute	Specification
Method	GET
Path	/api/v1/health
Audience	Merchant applications and monitoring systems
Authentication	None for this endpoint; environment network controls may still apply
Purpose	Confirm EVUAPI readiness before sending transactions.

No request body is required. Send Accept: application/json.

GET {{BaseUrl}}/api/v1/health
Accept: application/json

HTTP status	Meaning
200	EVUAPI reports a healthy/ready state.
503	EVUAPI is reachable but one or more required dependencies are degraded.

{
  "status": "Healthy",
  "message": "EVUAPI is ready."
}

Usage: Use health for readiness and monitoring. Do not use it as evidence that a specific payment will be approved.

6.2 CNP Transactions

Attribute	Specification
Method	POST
Path	/api/v1/transactions
Audience	Merchant/POS or ecommerce application
Authentication	X-Merchant-Id, X-Terminal-Id, X-Identification
Purpose	Submit a token-based card-not-present Sale, PreAuth/AuthOnly, Force, IncrementalAuth, Return, Void, or Close Batch.

CNP discriminator	Required value
cardPresent	false
tokenNumber	A valid payment token (not sent for Close Batch)
transactionType	1 Sale, 6 PreAuth/AuthOnly, 4 Force, 13 IncrementalAuth, 3 Return, 2 Void, 12 Close Batch
paymentType	2 (Credit); 0 for Close Batch

6.2.1 CNP Sale Request example

POST {{BaseUrl}}/api/v1/transactions
Content-Type: application/json
Accept: application/json
X-Merchant-Id: {{MerchantId}}
X-Terminal-Id: {{TerminalId}}
X-Identification: {{Identification}}

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-09-03T14:30:00",
  "paymentType": 2,
  "transactionType": 1,
  "stationNumber": 1,
  "cashierId": 1,
  "cardPresent": false,
  "tokenNumber": "TOKEN_REDACTED",
  "fullName": "John Smith",
  "amountOfSale": 25.00,
  "tax": 2.88,
  "baseStateTax": 25.00,
  "baseReducedTax": 0.00,
  "stateTax": 2.63,
  "cityTax": 0.25,
  "reducedTax": 0.00,
  "subTotal": 25.00,
  "tips": 0.00,
  "cashBack": 0.00,
  "fee": 0.00,
  "grandTotal": 27.88,
  "appVersion": "1.0.0",
  "timeOut": 30000
}

A CNP create response normally contains the final Approved or Declined result with Completed=true. Persist RequestId regardless of outcome. If the response is missing or non-final, use Get Transaction Status before deciding whether another payment attempt is appropriate.

Example response: Appendix A.1.

6.2.2 CNP PreAuth / AuthOnly Request example

Use transactionType=6 to authorize funds without completing the sale. Complete it later with a Force (6.2.3).

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 2,
  "transactionType": 6,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": false,
  "tokenNumber": "{{TokenNumber}}",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

Example declined response: Appendix A.4.

6.2.3 CNP Force / PreAuth Completion Request example

Use transactionType=4 to complete a prior PreAuth/AuthOnly. Supply the original authorization context.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 2,
  "transactionType": 4,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": false,
  "tokenNumber": "{{TokenNumber}}",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "originalAmount": {{OriginalAmount}},
  "originalApprovalCode": "{{OriginalApprovalCode}}",
  "originalGatewayReferenceNumber": "{{OriginalGatewayReferenceNumber}}",
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

Example gateway rejection (ResponseCode FE6): Appendix A.8.

6.2.4 CNP IncrementalAuth Request example

Use transactionType=13 to increase the amount held by a prior PreAuth/AuthOnly, for example when the expected total grows after the original authorization. The request is identical to Force (6.2.3) except for transactionType. Supply the original authorization context, then complete the authorization later with a Force. IncrementalAuth is not available for card-present.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 2,
  "transactionType": 13,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": false,
  "tokenNumber": "{{TokenNumber}}",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "originalAmount": {{OriginalAmount}},
  "originalApprovalCode": "{{OriginalApprovalCode}}",
  "originalGatewayReferenceNumber": "{{OriginalGatewayReferenceNumber}}",
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

6.2.5 CNP Return Request example

Use transactionType=3 to process a return/refund. When the Return references a previous transaction, supply its original authorization context.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 2,
  "transactionType": 3,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": false,
  "tokenNumber": "{{TokenNumber}}",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "originalAmount": {{OriginalAmount}},
  "originalApprovalCode": "{{OriginalApprovalCode}}",
  "originalGatewayReferenceNumber": "{{OriginalGatewayReferenceNumber}}",
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

6.2.6 CNP Void Request example

Use transactionType=2 to void a prior transaction.

A Void must send:

the original originalAmount
the original originalApprovalCode
the original originalGatewayReferenceNumber

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 2,
  "transactionType": 2,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": false,
  "tokenNumber": "{{TokenNumber}}",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "originalAmount": {{OriginalAmount}},
  "originalApprovalCode": "{{OriginalApprovalCode}}",
  "originalGatewayReferenceNumber": "{{OriginalGatewayReferenceNumber}}",
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

EVUAPI rejects a Void when originalGatewayReferenceNumber is missing or does not identify a transaction for the same merchant/terminal. In the response, AuthorizedAmount is 0 and EvertecResponse.reference is the reference of the voided transaction. Example response: Appendix A.5.

6.2.7 CNP Close Batch Request example

Use transactionType=12 with paymentType=0 to close/settle the current gateway batch. Do not send tokenNumber, amounts, or original-transaction fields. timeOut=0 applies a 60-second default.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 0,
  "transactionType": 12,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": false,
  "appVersion": "{{AppVersion}}",
  "timeOut": 0
}

A successful close returns Status=Approved and ResponseCode=000. EvertecResponse has the same settlement shape as CP Close Batch (see 6.3.11): payment_host=SETTLEMENT_ALL, settlement_data.<HOST>.Credit (credit and debit cards combined) and .Cash, and no Debit section. receipt_output.settle is null because no settlement receipt is generated for card-not-present.

Totals cover every transaction since the previous successful CNP Close Batch for the same merchantId, terminalId, and identification, up to this request. Successfully voided transactions are excluded. Example response: Appendix A.9.

6.3 CP Transactions

Attribute	Specification
Method	POST
Path	/api/v1/transactions
Audience	Merchant or POS application connected to a configured payment terminal
Authentication	X-Merchant-Id, X-Terminal-Id, X-Identification
Purpose	Start a card-present transaction on the configured physical terminal.

CP discriminator	Required value
cardPresent	true
tokenNumber	Empty string
transactionType	1 Sale, 6 PreAuth/AuthOnly, 4 Force, 3 Return, 2 Void, 12 Close Batch
paymentType	2 Credit (credit and debit cards), 5 Cash, 13 ATH Móvil; 0 for Close Batch

Debit cards: there is no separate debit tender. Send paymentType=2 for every card; the terminal determines how the card is routed. paymentType=6 is accepted for backward compatibility and treated as 2. A debit card still appears as special_account=AT and transaction_type_indicator=D in the response.

6.3.1 timeOut behavior

Value	Behavior	Required client action
0	Return the current state immediately after the CP request is accepted.	Persist RequestId and begin status retrieval when Completed=false.
30000	Wait for up to 30 seconds for a later state or final result.	If Completed=false when returned, continue status retrieval.

Important: timeOut controls how long the HTTP request waits. It does not cancel the terminal transaction and does not guarantee completion within that period.

6.3.2 CP Sale Request example

POST {{BaseUrl}}/api/v1/transactions
Content-Type: application/json
Accept: application/json
X-Merchant-Id: {{MerchantId}}
X-Terminal-Id: {{TerminalId}}
X-Identification: {{Identification}}

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-09-03T14:35:00",
  "paymentType": 2,
  "transactionType": 1,
  "stationNumber": 1,
  "cashierId": 1,
  "cardPresent": true,
  "tokenNumber": "",
  "fullName": "John Smith",
  "amountOfSale": 25.00,
  "tax": 2.88,
  "baseStateTax": 25.00,
  "baseReducedTax": 0.00,
  "stateTax": 2.63,
  "cityTax": 0.25,
  "reducedTax": 0.00,
  "subTotal": 25.00,
  "tips": 0.00,
  "cashBack": 0.00,
  "fee": 0.00,
  "grandTotal": 27.88,
  "appVersion": "1.0.0",
  "timeOut": 0
}

The response may be intermediate or final. When Completed=false, processor fields can be null and the merchant application must continue with Get Transaction Status. Do not create another sale solely because the first response is pending.

Example responses: Appendix A.2 (intermediate) and A.6 (final).

6.3.3 CP PreAuth / AuthOnly

Use transactionType=6 to request authorization without completing the sale.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 2,
  "transactionType": 6,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": true,
  "tokenNumber": "",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

6.3.4 CP Force / PreAuth Completion

Use transactionType=4 to complete a prior CP PreAuth/AuthOnly and send the original authorization context.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 2,
  "transactionType": 4,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": true,
  "tokenNumber": "",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "originalAmount": {{OriginalAmount}},
  "originalApprovalCode": "{{OriginalApprovalCode}}",
  "originalGatewayReferenceNumber": "{{OriginalGatewayReferenceNumber}}",
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

6.3.5 CP Return

Use transactionType=3 for a card-present return/refund. When it references a prior transaction, send the original authorization context.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 2,
  "transactionType": 3,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": true,
  "tokenNumber": "",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "originalAmount": {{OriginalAmount}},
  "originalApprovalCode": "{{OriginalApprovalCode}}",
  "originalGatewayReferenceNumber": "{{OriginalGatewayReferenceNumber}}",
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

6.3.6 CP Void

Use transactionType=2 to void a prior card-present transaction. Send the original authorization context; EVUAPI locates the original transaction by originalGatewayReferenceNumber. In the response, EvertecResponse.target_reference identifies the voided transaction.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 2,
  "transactionType": 2,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": true,
  "tokenNumber": "",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "originalAmount": {{OriginalAmount}},
  "originalApprovalCode": "{{OriginalApprovalCode}}",
  "originalGatewayReferenceNumber": "{{OriginalGatewayReferenceNumber}}",
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

6.3.7 CP Cash Sale

Use paymentType=5, transactionType=1, and cardPresent=true to submit a Cash sale through the terminal path. Sale does not include original-transaction fields.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 5,
  "transactionType": 1,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": true,
  "tokenNumber": "",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

6.3.8 CP Cash Return

Use paymentType=5, transactionType=3, and cardPresent=true for a Cash return/refund through the terminal path. Include original-transaction fields for a linked Return.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 5,
  "transactionType": 3,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": true,
  "tokenNumber": "",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "originalAmount": {{OriginalAmount}},
  "originalApprovalCode": "{{OriginalApprovalCode}}",
  "originalGatewayReferenceNumber": "{{OriginalGatewayReferenceNumber}}",
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

6.3.9 CP ATH Movil Sale

Use paymentType=13, transactionType=1, and cardPresent=true for an ATH Movil sale through the terminal path. Sale does not include original-transaction fields.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 13,
  "transactionType": 1,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": true,
  "tokenNumber": "",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

Store EvertecResponse.ath_trans_id for reconciliation. Example final status response: Appendix A.3.

6.3.10 CP ATH Movil Return

Use paymentType=13, transactionType=3, and cardPresent=true for an ATH Movil return/refund through the terminal path. Include original-transaction fields for a linked Return.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 13,
  "transactionType": 3,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": true,
  "tokenNumber": "",
  "fullName": "John Smith",
  "amountOfSale": {{AmountOfSale}},
  "tax": {{Tax}},
  "baseStateTax": {{BaseStateTax}},
  "baseReducedTax": {{BaseReducedTax}},
  "stateTax": {{StateTax}},
  "cityTax": {{CityTax}},
  "reducedTax": {{ReducedTax}},
  "subTotal": {{SubTotal}},
  "tips": {{Tips}},
  "cashBack": {{CashBack}},
  "fee": {{Fee}},
  "grandTotal": {{GrandTotal}},
  "originalAmount": {{OriginalAmount}},
  "originalApprovalCode": "{{OriginalApprovalCode}}",
  "originalGatewayReferenceNumber": "{{OriginalGatewayReferenceNumber}}",
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

6.3.11 CP Close Batch

Use transactionType=12, paymentType=0, and cardPresent=true to close/settle the current terminal batch. This is a batch operation, not a tender-specific purchase. Do not send tokenNumber, amounts, or original-transaction fields.

{
  "merchantId": "{{MerchantId}}",
  "identification": "{{Identification}}",
  "terminalId": "{{TerminalId}}",
  "terminalDateTime": "2026-08-14T18:30:00",
  "paymentType": 0,
  "transactionType": 12,
  "stationNumber": {{StationNumber}},
  "cashierId": {{CashierId}},
  "cardPresent": true,
  "appVersion": "{{AppVersion}}",
  "timeOut": 30000
}

The terminal settles its batch and returns the totals in EvertecResponse. Settlement can take longer than a payment; continue status retrieval while Completed=false.

Property	Description
approval_code	00 = settlement approved.
payment_host	SETTLEMENT_ALL.
receipt_output.settle	HTML settlement report (CP). null for CNP Close Batch.
settlement_data.<HOST>	Totals per processing host (for example ATH1), with terminal_vid, merchant_vid, and response_message (for example BALANCED … BATCH COMPLETE).
settlement_data.<HOST>.Credit	Card sales and refunds count and amount, for example credSalesCount, credSalesAmt, credRefundsCount, credRefundsAmt. Includes debit cards; there is no separate Debit section.
settlement_data.<HOST>.Cash	Cash sales and refunds count and amount: cashSalesCount, cashSalesAmt, cashRefundsCount, cashRefundsAmt.

Example response: Appendix A.7.

6.4 Get Transaction Status

Attribute	Specification
Method	GET
Path	/api/v1/transactions/{RequestId}
Audience	Merchant/POS or ecommerce application
Authentication	merchantId, terminalId, and identification query parameters with the values used for creation
Purpose	Retrieve the latest state and available result for an existing transaction.

Path parameters

Parameter	Type	Required	Description
RequestId	string	Yes	The `RequestId` returned by Create Transaction.

Query parameters

Parameter	Required	Description
merchantId	Yes	Merchant identity used to authorize access to the transaction.
terminalId	Yes	Merchant terminal identifier used to authorize access to the transaction.
identification	Yes	Physical terminal identity; same logical identity as SerialNumber/ManNumber.

GET {{BaseUrl}}/api/v1/transactions/{{RequestId}}?merchantId={{MerchantId}}&terminalId={{TerminalId}}&identification={{Identification}}
Accept: application/json

The response uses the same fields as the create response (5.2). Example: Appendix A.3.

Observed result	Developer action
Completed=false	Persist the latest state and poll again using the agreed integration cadence.
Completed=true	Persist the final response and stop polling.
Status request times out	Retry this GET with bounded backoff; do not submit a replacement sale.
Transaction not found	Verify environment, RequestId, and merchant-terminal identity before escalating.

Polling: Use the polling cadence and rate limits agreed for your integration profile. Do not busy-loop. Apply bounded backoff, jitter, and an overall reconciliation deadline.

7. Error handling and reconciliation

Condition	Required handling
HTTP success; Completed=false	The request was served but the payment is not final. Retrieve status.
HTTP success; Completed=true	Use Status and processor fields to determine the final payment result.
Create request times out after RequestId was received	Retrieve status; do not create a replacement sale.
Create request outcome is unknown	Use invoice/order correlation and status/support procedures before retrying.
Status GET fails transiently	Retry the GET with bounded exponential backoff and jitter.
Authorization or validation failure	Correct configuration or request data; do not retry unchanged.
Service failure	Recheck health, preserve correlation data (RequestId, ErrorId), and follow the agreed support path.

7.1 What to retain

Merchant invoice/order reference and RequestId.
Status transitions and timestamps.
Final ResponseCode, ProcessorResponseCode, ApprovalCode, and GatewayReferenceNumber when present.
CP receipts, IVU control lines, and (ATH Móvil) ath_trans_id.
Calling application version and environment name.

Never log: Payment tokens, live identity-header values, raw credentials, or unnecessary personal data.

Appendix A. Sanitized response examples

Examples: Values are sanitized illustrations of the documented response model. Receipt HTML is shortened.

A.1 Final CNP response

CNP Credit Sale, approved. Returned with HTTP 200.

{
  "RequestId": "cce63469efe14a32a1d2a31ea48316df",
  "Status": "Approved",
  "Completed": true,
  "ResponseCode": "000",
  "ProcessorResponseCode": "00",
  "ResponseText": "APPROVED",
  "EvertecResponse": {
    "trace_number": "041954",
    "batch_number": "009267001",
    "card_acceptor_id": "NONE",
    "special_account": "MC",
    "merchant_id": "4549000000123",
    "pan_card_number": "0013",
    "reference": "000004587981",
    "receipt_output": {
      "merchant": null,
      "customer": null
    },
    "amounts": {
      "total": "26.00",
      "base_state_tax": "10.00",
      "tip": "0.00",
      "reduced_tax": "3.00",
      "base_reduced_tax": "10.00",
      "state_tax": "1.00",
      "city_tax": "2.00"
    },
    "authorization_code": "124094",
    "emv_data": {},
    "signature_indicator": "NOSIGN",
    "transaction_time": "041955",
    "payment_host": "ATH1",
    "invoice_number": null,
    "terminal_id": "CAWW000000001",
    "merchant_vid": "4549000000123",
    "transaction_date": "09232026",
    "approval_code": "00",
    "cashier_id": "1",
    "manual_entry_indicator": "yes",
    "ivu": {
      "control_line1": "CONTROL: S1QM2-DGJP2",
      "control_line2": "ET                  "
    },
    "process_cashback": "no",
    "card_bin_type": "MASTERCARD",
    "terminal_vid": "CAWW000000001",
    "station_number": "1",
    "response_message": "APPROVED",
    "receipt_email": "no",
    "transaction_type_indicator": "C",
    "entry_type": "MANUAL",
    "fallback": "no"
  },
  "ApprovalCode": "124094",
  "GatewayReferenceNumber": "000004587981",
  "AuthorizedAmount": 26,
  "TokenNumber": "0000000000001234",
  "CardType": "2",
  "StatusUrl": "/api/v1/transactions/cce63469efe14a32a1d2a31ea48316df",
  "ErrorId": null
}

A.2 Intermediate CP response

CP Credit PreAuth accepted by the terminal but not final. Returned with HTTP 202; retrieve status.

{
  "RequestId": "09ed5df8b43c42afa1e3d92735f764db",
  "Status": "Processing",
  "Completed": false,
  "ResponseCode": null,
  "ProcessorResponseCode": null,
  "ResponseText": "Evertec accepted the transaction. trx_id=09612e18-703c-413d-b720-c85aee48bed3",
  "EvertecResponse": null,
  "ApprovalCode": null,
  "GatewayReferenceNumber": null,
  "AuthorizedAmount": null,
  "TokenNumber": null,
  "CardType": null,
  "StatusUrl": "/api/v1/transactions/09ed5df8b43c42afa1e3d92735f764db",
  "ErrorId": null
}

A.3 Final status response

Get Transaction Status for a CP ATH Móvil Sale that reached its final state.

{
  "RequestId": "29ed372d095c4073b39e144e2a6ab0ab",
  "Status": "Approved",
  "Completed": true,
  "ResponseCode": "000",
  "ProcessorResponseCode": "00",
  "ResponseText": "APPROVED.",
  "EvertecResponse": {
    "trace_number": "000016",
    "batch_number": "2",
    "card_acceptor_id": "NONE",
    "special_account": "AM",
    "merchant_id": "4549000000123",
    "pan_card_number": "1208",
    "reference": "38",
    "receipt_output": {
      "merchant": "<html><body><!-- Receipt HTML shortened for documentation --><p>MERCHANT COPY</p></body></html>"
    },
    "amounts": {
      "total": "26.00",
      "base_state_tax": "10.00",
      "tip": "0.00",
      "reduced_tax": "3.00",
      "base_reduced_tax": "10.00",
      "state_tax": "1.00",
      "city_tax": "2.00"
    },
    "authorization_code": "104892",
    "signature_indicator": "NOSIGN",
    "transaction_time": "080737",
    "payment_host": "ATH1",
    "invoice_number": "000945",
    "terminal_id": "40000001",
    "transaction_date": "09242026",
    "approval_code": "00",
    "cashier_id": "1",
    "manual_entry_indicator": "no",
    "ivu": {
      "control_line1": "CONTROL: HVS3F-FF6VU",
      "control_line2": "ET                  "
    },
    "process_cashback": "no",
    "card_bin_type": "ATH_MOVIL",
    "station_number": "1",
    "response_message": "APPROVED.",
    "receipt_email": "yes",
    "transaction_type_indicator": "A",
    "ath_trans_id": "0000000000420862",
    "entry_type": "MANUAL"
  },
  "ApprovalCode": "104892",
  "GatewayReferenceNumber": "000004588693",
  "AuthorizedAmount": 26,
  "TokenNumber": null,
  "CardType": "994",
  "StatusUrl": "/api/v1/transactions/29ed372d095c4073b39e144e2a6ab0ab",
  "ErrorId": null
}

A.4 CNP declined response

CNP PreAuth declined by the processor. Returned with HTTP 200; ApprovalCode is present even though the transaction is declined.

{
  "RequestId": "91d45593e2344ca1bca8f867673707b1",
  "Status": "Declined",
  "Completed": true,
  "ResponseCode": "FFE",
  "ProcessorResponseCode": "68",
  "ResponseText": "Response received too late",
  "EvertecResponse": {
    "trace_number": "042245",
    "batch_number": "009267001",
    "card_acceptor_id": "NONE",
    "special_account": "MC",
    "merchant_id": "4549000000123",
    "pan_card_number": "0013",
    "reference": "000004587982",
    "receipt_output": {
      "merchant": null,
      "customer": null
    },
    "amounts": {
      "total": "26.00",
      "base_state_tax": "10.00",
      "tip": "0.00",
      "reduced_tax": "3.00",
      "base_reduced_tax": "10.00",
      "state_tax": "1.00",
      "city_tax": "2.00"
    },
    "authorization_code": "419596",
    "emv_data": {},
    "signature_indicator": "NOSIGN",
    "transaction_time": "042300",
    "payment_host": "ATH1",
    "invoice_number": null,
    "terminal_id": "CAWW000000001",
    "merchant_vid": "4549000000123",
    "transaction_date": "09232026",
    "approval_code": "68",
    "cashier_id": "1",
    "manual_entry_indicator": "yes",
    "ivu": {
      "control_line1": null,
      "control_line2": null
    },
    "process_cashback": "no",
    "card_bin_type": "MASTERCARD",
    "terminal_vid": "CAWW000000001",
    "station_number": "1",
    "response_message": "Response received too late",
    "receipt_email": "no",
    "transaction_type_indicator": "C",
    "entry_type": "MANUAL",
    "fallback": "no"
  },
  "ApprovalCode": "419596",
  "GatewayReferenceNumber": "000004587982",
  "AuthorizedAmount": null,
  "TokenNumber": "",
  "CardType": "2",
  "StatusUrl": "/api/v1/transactions/91d45593e2344ca1bca8f867673707b1",
  "ErrorId": null
}

A.5 CNP Void response

CNP Void, approved. AuthorizedAmount is 0; EvertecResponse.reference is the voided Sale’s reference.

{
  "RequestId": "8309e32267244602a8e68c0cc64a6b8b",
  "Status": "Approved",
  "Completed": true,
  "ResponseCode": "000",
  "ProcessorResponseCode": "00",
  "ResponseText": "APPROVED",
  "EvertecResponse": {
    "trace_number": "042459",
    "batch_number": "009267001",
    "card_acceptor_id": "NONE",
    "special_account": "MC",
    "merchant_id": null,
    "pan_card_number": "0013",
    "reference": "000004587981",
    "receipt_output": {
      "merchant": null,
      "customer": null
    },
    "amounts": {
      "total": "0.00",
      "base_state_tax": "10.00",
      "tip": "0.00",
      "reduced_tax": "3.00",
      "base_reduced_tax": "10.00",
      "state_tax": "1.00",
      "city_tax": "2.00"
    },
    "authorization_code": null,
    "emv_data": {},
    "signature_indicator": "NOSIGN",
    "transaction_time": "042500",
    "payment_host": "ATH1",
    "invoice_number": null,
    "terminal_id": "CAWW000000001",
    "merchant_vid": null,
    "transaction_date": "09232026",
    "approval_code": "00",
    "cashier_id": "1",
    "manual_entry_indicator": "yes",
    "ivu": {
      "control_line1": null,
      "control_line2": null
    },
    "process_cashback": "no",
    "card_bin_type": "MASTERCARD",
    "terminal_vid": "CAWW000000001",
    "station_number": "1",
    "response_message": "APPROVED",
    "receipt_email": "no",
    "transaction_type_indicator": "C",
    "entry_type": "MANUAL",
    "fallback": "no"
  },
  "ApprovalCode": "",
  "GatewayReferenceNumber": "000004587983",
  "AuthorizedAmount": 0,
  "TokenNumber": "0000000000001234",
  "CardType": "2",
  "StatusUrl": "/api/v1/transactions/8309e32267244602a8e68c0cc64a6b8b",
  "ErrorId": null
}

A.6 Final CP card response

CP Credit Sale, contactless, approved within timeOut.

{
  "RequestId": "304668afcdb240e0802c1c658bb5d3f2",
  "Status": "Approved",
  "Completed": true,
  "ResponseCode": "000",
  "ProcessorResponseCode": "00",
  "ResponseText": "APPROVED.",
  "EvertecResponse": {
    "trace_number": "000005",
    "batch_number": "2",
    "card_acceptor_id": "NONE",
    "special_account": "VC",
    "merchant_id": "4549000000123",
    "pan_card_number": "3005",
    "reference": "11",
    "receipt_output": {
      "merchant": "<html><body><!-- Receipt HTML shortened for documentation --><p>MERCHANT COPY</p></body></html>",
      "customer": "<html><body><!-- Receipt HTML shortened for documentation --><p>CUSTOMER COPY</p></body></html>"
    },
    "amounts": {
      "total": "26.00",
      "base_state_tax": "10.00",
      "tip": "0.00",
      "reduced_tax": "3.00",
      "base_reduced_tax": "10.00",
      "state_tax": "1.00",
      "city_tax": "2.00"
    },
    "authorization_code": "124543",
    "emv_data": {
      "84": "A0000000031010",
      "95": "0000000000",
      "9F12": "VISA CREDIT",
      "9B": "0000",
      "9F26": "1C727DD5FA1F3DDC",
      "9F37": "B9FB787C"
    },
    "signature_indicator": "SIGN",
    "transaction_time": "080307",
    "payment_host": "ATH1",
    "invoice_number": "000938",
    "terminal_id": "40000001",
    "merchant_vid": "4549000000123",
    "transaction_date": "09242026",
    "approval_code": "00",
    "cashier_id": "1",
    "manual_entry_indicator": "no",
    "ivu": {
      "control_line1": "CONTROL: 8LGJP-4VNZF",
      "control_line2": "ET                  "
    },
    "process_cashback": "no",
    "card_bin_type": "VISA",
    "terminal_vid": "40000001",
    "station_number": "1",
    "response_message": "APPROVED.",
    "receipt_email": "yes",
    "transaction_type_indicator": "C",
    "entry_type": "CTLS",
    "fallback": "no"
  },
  "ApprovalCode": "124543",
  "GatewayReferenceNumber": "000004588675",
  "AuthorizedAmount": 26,
  "TokenNumber": null,
  "CardType": "1",
  "StatusUrl": "/api/v1/transactions/304668afcdb240e0802c1c658bb5d3f2",
  "ErrorId": null
}

A.7 CP Close Batch response

CP Close Batch, settled. Credit totals include debit cards; there is no Debit section.

{
  "RequestId": "1ce21c52a97b4983b643863ac83ec5ab",
  "Status": "Approved",
  "Completed": true,
  "ResponseCode": "000",
  "ProcessorResponseCode": "00",
  "ResponseText": "APPROVED.",
  "EvertecResponse": {
    "approval_code": "00",
    "cashier_id": "1",
    "batch_number": "",
    "settlement_data": {
      "ATH1": {
        "terminal_vid": "40000001",
        "Credit": {
          "credSalesAmt": "52.00",
          "credRefundsAmt": "26.00",
          "credRefundsCount": "1",
          "credSalesCount": "2"
        },
        "response_message": "\" BALANCED  002       BATCH COMPLETE     \"",
        "Cash": {
          "cashSalesCount": "1",
          "cashRefundsAmt": "26.00",
          "cashRefundsCount": "1",
          "cashSalesAmt": "26.00"
        },
        "merchant_vid": "4549000000123"
      }
    },
    "merchant_id": "4549000000123",
    "reference": "13",
    "station_number": "1",
    "receipt_output": {
      "settle": "<html><body><!-- Receipt HTML shortened for documentation --><p>SETTLEMENT REPORT</p></body></html>"
    },
    "response_message": "APPROVED.",
    "authorization_code": "000000",
    "payment_host": "SETTLEMENT_ALL",
    "terminal_id": "40000001"
  },
  "ApprovalCode": "000000",
  "GatewayReferenceNumber": null,
  "AuthorizedAmount": null,
  "TokenNumber": null,
  "CardType": null,
  "StatusUrl": "/api/v1/transactions/1ce21c52a97b4983b643863ac83ec5ab",
  "ErrorId": null
}

A.8 Gateway validation response (FE6)

CNP Force rejected by the gateway before reaching the processor.

{
  "RequestId": "afc0460cbd6740a1b815122ae661aad0",
  "Status": "Declined",
  "Completed": true,
  "ResponseCode": "FE6",
  "ProcessorResponseCode": "",
  "ResponseText": "Invalid Transaction Data.",
  "EvertecResponse": {
    "trace_number": null,
    "batch_number": "-001267001",
    "card_acceptor_id": "NONE",
    "special_account": null,
    "merchant_id": null,
    "pan_card_number": null,
    "reference": null,
    "receipt_output": {
      "merchant": null,
      "customer": null
    },
    "amounts": {
      "total": "26.00",
      "base_state_tax": "10.00",
      "tip": "0.00",
      "reduced_tax": "3.00",
      "base_reduced_tax": "10.00",
      "state_tax": "1.00",
      "city_tax": "2.00"
    },
    "authorization_code": null,
    "emv_data": {},
    "signature_indicator": "NOSIGN",
    "transaction_time": "183000",
    "payment_host": "ATH1",
    "invoice_number": null,
    "terminal_id": null,
    "merchant_vid": null,
    "transaction_date": "08142026",
    "approval_code": null,
    "cashier_id": "1",
    "manual_entry_indicator": "yes",
    "ivu": {
      "control_line1": null,
      "control_line2": null
    },
    "process_cashback": "no",
    "card_bin_type": null,
    "terminal_vid": null,
    "station_number": "1",
    "response_message": "Invalid Transaction Data.",
    "receipt_email": "no",
    "transaction_type_indicator": null,
    "entry_type": "MANUAL",
    "fallback": null
  },
  "ApprovalCode": "",
  "GatewayReferenceNumber": "",
  "AuthorizedAmount": null,
  "TokenNumber": "",
  "CardType": "2",
  "StatusUrl": "/api/v1/transactions/afc0460cbd6740a1b815122ae661aad0",
  "ErrorId": null
}

A.9 CNP Close Batch response

CNP Close Batch, settled. Same shape as A.7, with receipt_output.settle = null. Illustrative: this example follows the documented contract and should be replaced with a captured response.

{
  "RequestId": "8990e2fac0984ed395cc2ab3c8d57e80",
  "Status": "Approved",
  "Completed": true,
  "ResponseCode": "000",
  "ProcessorResponseCode": "00",
  "ResponseText": "APPROVED.",
  "EvertecResponse": {
    "approval_code": "00",
    "cashier_id": "1",
    "batch_number": "",
    "settlement_data": {
      "ATH1": {
        "terminal_vid": "40000001",
        "Credit": {
          "credSalesCount": "4",
          "credSalesAmt": "104.00",
          "credRefundsCount": "1",
          "credRefundsAmt": "26.00"
        },
        "response_message": "\" BALANCED  002       BATCH COMPLETE     \"",
        "Cash": {
          "cashSalesCount": "0",
          "cashSalesAmt": "0.00",
          "cashRefundsCount": "0",
          "cashRefundsAmt": "0.00"
        },
        "merchant_vid": "4549000000123"
      }
    },
    "merchant_id": "4549000000123",
    "reference": "1",
    "station_number": "1",
    "receipt_output": {
      "settle": null
    },
    "response_message": "APPROVED.",
    "authorization_code": "000000",
    "payment_host": "SETTLEMENT_ALL",
    "terminal_id": "40000001"
  },
  "ApprovalCode": "000000",
  "GatewayReferenceNumber": null,
  "AuthorizedAmount": null,
  "TokenNumber": null,
  "CardType": null,
  "StatusUrl": "/api/v1/transactions/8990e2fac0984ed395cc2ab3c8d57e80",
  "ErrorId": null
}

Appendix B. Glossary

Term	Definition
CNP	Card not present; a token-based transaction without physical card interaction at a terminal.
CP	Card present; a transaction completed through the configured physical payment terminal.
EVUAPI	Evertec Unified API customer integration service.
RequestId	Correlation identifier used to retrieve the state and result of a transaction.
GatewayReferenceNumber	Gateway reference used to identify the original transaction in Force, IncrementalAuth, Void, and Return.
TokenNumber	Sensitive payment token used for a CNP transaction.
Identification	Configured terminal/device identification value used in customer requests.
Completed	Boolean indicating whether a transaction has reached a final state.
IVU	Impuesto sobre Ventas y Uso; Puerto Rico sales and use tax.
IncrementalAuth	Increase of the amount held by a prior authorization; card-not-present only.

Subscribe to Documentation Updates

Receive a monthly summary of new and updated technical documents.