Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-2647148658.0 KB
Transaction

Count transactions

Count transactions

get/api/v2/transactions/count

Query parameters

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.

amount'Amex' | 'JCB' | 'Mastercard' | 'Visa'

Amount of the transaction.

created_atstring

The time at which the transaction was created.

country_codestring

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

currency_codestring

Three-letter ISO 4217 alphabetical currency code. e.g. USD.

customerstring

The ID of a customer.

enity_idstring

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

invoice_numberstring

The invoice number used to track the order for POS transactions. For Ecommerce, use merchant_reference.

merchant_referencestring

A reference specified by the merchant to identify the transaction.

Example:7a1db7a8-6f24-4bc5-a51b-cef33fc05140
payment_product_type'Amex' | 'JCB' | 'Mastercard' | 'Visa'

Fees applied to the transaction, based on the payment product. e.g. For card transactions - interchange fees

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

Determines the point of sale of a customer.

status'INITIATED' | 'AUTHORIZED' | 'AUTHORIZATION_VOIDED' | 'REFUNDED' | 'FAILED' | 'PENDING' | 'DECLINED' | 'SETTLEMENT_CANCELLED' | 'SETTLEMENT_REQUESTED' | 'SETTLEMENT_SUBMITTED' | 'SETTLEMENT_COMPLETED' | 'SETTLEMENT_PARTIAL' | 'SETTLEMENT_DECLINED' | 'VOIDED' | 'UNKNOWN'
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.

reason_codestring

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

rrnstring

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

pos_device_idnumber

Identifier of the POS device used for the transaction.

stannumber

System Trace Audit Number.

idstring

The ID of the transaction

Response

Count transactions

countnumber

count of transaction