Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Transactions

List all transactions

Use the GET transactions endpoint to retrieve all transactions. Utilise the specified query parameters - start_date, end_date, order_id, status, currency, reason, payment_method, transaction_type, recurring_type, charge_date and acquirer_reference_number - to filter the returned transactions as needed. If no filters are provided, only transactions from the current day will be returned.

get/transactions

Query parameters

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

filterstring

Filter the parameters that you want to return within the response.

start_datestring date
Example:2024-01-01

The start date and time for filtering results.

end_datestring date
Example:2024-01-31

The end date and time for filtering results.

order_idstring
Example:1c033b5e-4815-4df7-813e-9381aaea06b3

Return all transactions associated with the specified order_id.

status'executed' | 'settled' | 'cancelled' | 'pending' | 'expired' | 'success' | 'blocked' | 'declined' | 'error' | 'tds_pending' | 'tds_expired' | 'tds_failed' | 'tds_error' | 'tds_failed' | 'tds_error' | 'server_error'
Example:success

Filter transactions by status.

currency'aed' | 'aud' | 'cad' | 'chf' | 'cny' | 'dkk' | 'eur' | 'gbp' | 'hkd' | 'jpy' | 'mxn' | 'sek' | 'usd' | 'zar'
Example:gbp

Filter by the required currency.

reason'6012_data' | 'above_max_amount' | 'above_max_refund_amount' | 'above_max_transactions' | 'acs_technical_issue' | 'bad_gateway' | 'below_min_amount' | 'below_min_refund_amount' | 'bin_bank' | 'bin_country' | 'bin_level' | 'bin_product' | 'bin_scheme' | 'blocklist_bin' | 'blocklist_card' | 'blocklist_email' | 'blocklist_ip' | 'blocklist_phone' | 'card_authentication_failed' | 'card_not_active' | 'cardholder_cancellation' | 'cardholder_cancelled' | 'challenge_failed' | 'challenge_limit_exceeded' | 'challenge_not_completed' | 'challenge_time_out' | 'closed_account' | 'exceeds_authentication_frequency_limit' | 'exceeds_max_amount' | 'exceeds_max_refund_amount' | 'exceeds_max_transactions' | 'expired_card' | 'fraud_scoring' | 'fraud_scoring_error' | 'generic_decline' | 'insufficient_funds' | 'invalid_avs' | 'invalid_card_number' | 'invalid_cvv' | 'invalid_pin' | 'invalid_transaction' | 'low_confidence' | 'lost_or_stolen' | 'max_amount_day' | 'max_amount_month' | 'max_card_attempts' | 'max_card_success' | 'max_daily_refunds_amount' | 'max_daily_refunds_count' | 'max_email_day' | 'max_email_month' | 'max_ip_day' | 'max_ip_month' | 'max_monthly_refunds_amount' | 'max_monthly_refunds_count' | 'max_phone_day' | 'max_phone_month' | 'max_post_day' | 'max_post_month' | 'max_refunds_count' | 'medium_confidence' | 'no_card_record' | 'restricted_card' | 'scheme_status_reason' | 'security_failure' | 'suspected_fraud' | 'transaction_disputed' | 'transaction_fraud' | 'transaction_not_permitted_to_cardholder'
Example:suspected_fraud

Filter transactions by reason.

payment_method'card' | 'apple_pay' | 'google_pay' | 'pay_by_bank' | 'direct_debit' | 'faster_payment_receive' | 'faster_payment_send' | 'bacs_receive'
Example:card

Filter transactions by payment method.

transaction_type'authorisation' | 'sale' | 'refund' | 'void' | 'capture' | 'account_to_account'
Example:sale

Filter transactions by transaction type.

recurring_type'store_card' | 'recurring' | 'returning'
Example:recurring

Filter transactions by recurring type.

charge_datestring date
Example:2024-01-31

Filter transactions by the Direct Debit charge date.

acquirer_reference_numberstring
Example:74501876168541699649367

Return all transactions associated with the specified Acquirer Reference Number (ARN).

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Midstring uuid

Unique ID assigned by Acquired.com connecting to a specific acquiring bank.

Response

List of transactions.