Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-2647148658.0 KB
Transaction

Read transaction

Get a transaction

get/api/v2/transaction/{id}

Path parameters

idstring required

transaction id

Response

Transaction

idstring

The unique transaction id. This is the identifier to be used for locating the transaction and for reconciliation and auditing.

amountstring

Amount including decimal place.

acquirer_authorizing_network_idstring

The Network ID returned in the original authorization response.

acquirer_authorizing_network_id_descriptorstring

The name or descriptor that corresponds with the acquirer_authorizing_network_id returned in the original authorization response.

acquirer_response_codestring

Acquirer response returned during the authorisation.

acquirer_response_messagestring

The response description generated by the acquirer corresponding to the acquirer response code.

currency_code'AUD'

Three-letter ISO 4217 alphabetical currency code. Supported values are: AUD

citystring

The city resolved from the customer's ip address.

country_codestring

The country code resolved from the customer's ip address.

created_atstring

The time at which the transaction was created

customerstring

The ID of a customer.

customer_ipstring

The IP Address v4 where the event originated.

geo_locationstring[]
payment_productstring

The payment product corresponding to this transaction.

payment_product_type'Amex' | 'JCB' | 'Mastercard' | 'Unknown' | 'Visa'

The payment product type corresponding to this transaction. Fees applied to the transaction, is based on the payment product

processor_referencestring

Reference identifying the transaction, as provided by the processor.

statusstring

Display transaction type and status, including if partial, of the related order transaction. E.g. 'PARTIAL CAPTURE AUTHORIZED'.

transaction_type'AUTHORISATION' | 'CANCEL' | 'CAPTURE' | 'CARD_VERIFICATION' | 'CASH_ADVANCE' | 'DECLINED' | 'DELAYED_CHARGE' | 'EXTEND' | 'PREAUTH' | 'PREAUTH_COMPLETION' | 'PREAUTH_INCREMENT' | 'REAUTHORISATION' | 'REFUND' | 'SALE' | 'VOID'

A type indicator for the main operation or service that was performed as part of the transaction event.

transaction_status'APPROVED' | 'AUTHENTICATING' | 'AUTHORISED' | 'AWAITING_INVOICE' | 'CANCELLED' | 'CONFIRMED' | 'COMPLETED' | 'CUSTOMER_ACCEPTED' | 'DECLINED' | 'DEFERRED' | 'DISPUTED' | 'EXCEPTION' | 'EXPIRED' | 'FAILED' | 'INITIATED' | 'ON_HOLD' | 'PARTIALLY_REFUNDED' | 'RECEIVED' | 'RECONCILED' | 'RECONCILIATION_FAILED' | 'REFUNDED' | 'REJECTED' | 'REPEATING' | 'REVERSED' | 'REVERSE_ERROR' | 'REVERSING' | 'ROUTING' | 'SENT' | 'SETTLED' | 'SETTLEMENT_FAILED' | 'SETTLEMENT_REQUESTED' | 'SUBMITTED' | 'TIMED_OUT' | 'UNMATCHED'

This represents the available states that a transaction may have. At any given point it may only have a single state.

parent_idstring

The transaction id of a parent transaction, where the current transaction is an action based on a previous transactions.

reason_codestring

A reason code assigned by the acquiring platform; '0000' in case of success.

card_brandstring

Represents a Card type or brand. It should correspond to a consistent name, the list of standard names is as follows:

ValueDescription
AMEXAmerican Express
JCBJapan Credit Bureau
MASTERCARDMasterCard
VISAVisa
merchant_referencestring

A reference specified by the merchant to identify the transaction.

user_agentstring

The full user agent string of the device the customer used to submit the transaction.

arnstring

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring

An authorization code assigned by the processing platform.

avs_result'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'I' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'R' | 'S' | 'T' | 'U' | 'W' | 'X' | 'Y' | 'Z'

Address verification services result, which provides information about the outcome of the AVS check. The full list of codes and descriptions can be found <a href="https://verifone.cloud/docs/online-payments/fraud-management/address-verification-service-avs">here</a>

created_bystring

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order.

cvv_presentboolean

True if the card was used with a cvv.

cvv_result'0' | '1' | '2' | '3'

CVV verification result, as returned by the processor. Refer to Key Concepts->Cards for understanding of the values.

processor_payer_idstring

This is the id used by the processor (e.g. an APM provider) for the payer.

pos_device_idstring

dentifier of the POS device used for the transaction.

rrnstring

Retrieval Reference Number, is a transaction identifying reference number that is designated by the card acceptor system.

shopper_interaction'ecommerce' | 'pos' | 'moto' | 'mail_order' | 'telephone_order' | 'unknown'

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth.

stanstring

A number assigned by a transaction initiator(originator) to assist in identifying a transaction uniquely. The trace identifier remains unchanged for all messages within a two-message exchange, e.g. request/repeat and response. This property can be used to store the System trace audit number (STAN) as used in the ISO8583 specification (DE 11). Note the contents of this field are mandatory in many specifications - ISO8583, AS2805 (DE11) and are often related to the Retrieval Reference Number (RRN) as also specified in ISO8583. Unfortunately due to the usage in these earlier specifications, a STAN was limited to 6 digits which means that it cannot be utilised as a general purpose unique id. In addition, this entry is often printed on the receipt at a POI. ISO8583 DE11.

masked_card_numberstring

Masked PAN number, the first 6 and last 4 digits of the card.

promo_codestring

A code defined by the merchant that affects the calculation of the total amount.

entity_idstring uuid-flexible

The identifier of merchant entity you want to process the transaciton is already processed.

acquirer_merchant_idstring

The Code identifying the card acceptor as issued by the Acquiring Institution. This may not be unique across institutions. Also referred to as the MID. ISO8583 - DE 42. This field is for the MID used between VF and a 3rd party acquirer or processor.

descriptionstring

The description/message associated with this transaction. This will contain the refund reason for refunds.

Example response

{
  "id": "63bbc548-d2de-4546-b106-880a5018461c",
  "acquirer_response_code": "0000",
  "status": "REFUND AUTHORIZED",
  "parent_id": "63bbc548-d2de-4546-b106-880a5018461c",
  "shipping_information": {
    "address": "3732  Metz Lane",
    "city": "West Roxbury",
    "country": "US",
    "postal_code": "1114",
    "first_name": "Thelma",
    "last_name": "Tatro",
    "phone": 8577532706,
    "state": "MA"
  },
  "customer_details": {
    "shipping": {
      "address": "3732  Metz Lane",
      "city": "West Roxbury",
      "country": "US",
      "postal_code": "1114",
      "first_name": "Thelma",
      "last_name": "Tatro",
      "phone": "8577532706",
      "state": "MA"
    }
  },
  "avs_result": "A",
  "processor_payer_id": "MLVAJGLDHNZ3G",
  "entity_id": "30b8bec8-5042-4e67-939c-5453fbe41711"
}