v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Transactions

Retrieve a transaction

Every time you submit a payment request, including, card, recurring payments, Google Pay, Apple Pay, you are returned a transaction_id. Append the transaction_id to the URL to retrieve the transaction details.

get/transactions/{transaction_id}

Path parameters

transaction_idstring uuid required

Unique ID assigned by Acquired.com for the transaction.

Query parameters

filterstring

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

Response

OK

transaction_idstring uuid

Unique identifier assigned by Acquired.com for the transaction.

status'blocked' | 'declined' | 'success' | 'tds_error' | 'tds_expired' | 'tds_failed' | 'settled' | 'executed' | 'cancelled' | 'expired'

The current status of the transaction.

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'
mid'card' uuid

Unique ID assigned by Acquired.com for the associated MID.

payment_method'card' | 'apple_pay' | 'google_pay' | 'mastercard_send' | 'visa_direct' | 'faster_payment_send' | 'pay_by_bank' | 'direct_debit'

Detail of how the transaction has been executed.

transaction_type'sale' | 'authorisation' | 'capture' | 'refund' | 'void' | 'credit' | 'account_to_account' | 'reversal'

The detail of what type of transaction was performed (such as receiving or sending funds).

issuer_response_code'00' | '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '59' | '60' | '61' | '62' | '63' | '64' | '65' | '66' | '67' | '68' | '75' | '76' | '77' | '80' | '81' | '82' | '83' | '84' | '85' | '86' | '87' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '96' | '97' | '98' | '99' | 'N0' | 'N3' | 'N4' | 'N7' | 'P5' | 'P6' | 'XA' | 'XD'
authorisation_codestring

Credit card code to indicate whether the transaction has been approved or declined.

acquirer_reference_numberstring

Unique reference number assigned to the transaction as it moves through the payment flow.

scheme_reference_datastring

Unique reference generated by the card scheme.

card_idstring uuid

Unique ID assigned by Acquired.com for the card.

createdstring date-time

The date and time at which the customer was created.

last_updatedstring date-time

The date and time the customer record was last updated.

credential_on_file'first' | 'recurring'

Used to identify whether the transaction is the first or a subsequent transaction.

custom_datastring

Base64 encoded string detailing custom data passed in the request.

custom1string

Send additional data relating to the customer or another internal reference.

custom2string

Send additional data relating to the customer or another internal reference.

charge_datestring date

Populate this parameter if you want to set the initial Direct Debit collection for a date in the future, rather than the collection being processed on the next working day.

is_retryableboolean

Confirms whether the Direct Debit can be retried or not.

Example response

{
  "transaction_id": "a7e3fde5-5b83-44f4-9915-782bc7121717",
  "status": "success",
  "transaction": {
    "order_id": "1f1f2a61-5b68-4725-a0ce-9560514ec00b",
    "amount": 15.02,
    "currency": "gbp",
    "billing": {
      "subscription_id": "01JC4Z1YR25RSAFVHYY7GA1BRQ",
      "bill_id": "01JC4Z2BC9J1V1B8YHR4E0X4T5",
      "recovery_id": "01JC4Z2Y0Q4E7Q0YV5D3M6W9KA"
    }
  },
  "retry_advice": {
    "category": "retry_later",
    "detail": null,
    "retry_after": "2026-03-04T00:00:00Z",
    "acquirer_code": "25"
  },
  "issuer_response_code": "00",
  "authorisation_code": "123456",
  "acquirer_reference_number": "AA07071660000001",
  "scheme_reference_data": "987654321234567",
  "payment": {
    "reference": "Custom Ref 001",
    "payee_id": "4ebc5489-7b9f-4324-983e-07d4b2b00035"
  },
  "payer": {
    "account_name": "MR E JOHNSON",
    "account_number": "12345678",
    "sort_code": "010203"
  },
  "card": {
    "holder_name": "E Johnson",
    "scheme": "visa",
    "number": "8710",
    "expiry_month": 10,
    "expiry_year": 30
  },
  "bin": {
    "number": "424242",
    "type": "debit",
    "product": "consumer",
    "card_level": "standard",
    "issuer": "acquired.com",
    "issuer_country": "united kingdom",
    "issuer_country_code": "gb"
  },
  "customer": {
    "reference": "customer_number_00001",
    "first_name": "Edward",
    "last_name": "Johnson",
    "dob": "1988-10-03",
    "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh",
    "billing": {
      "address": {
        "line_1": "152 Aldgate Drive",
        "city": "London",
        "postcode": "E1 7RT",
        "country_code": "GB"
      },
      "email": "ejohnson@acquired.com",
      "phone": {
        "country_code": "44",
        "number": "2039826580"
      }
    },
    "shipping": {
      "address": {
        "line_1": "152 Aldgate Drive",
        "city": "London",
        "postcode": "E1 7RT",
        "country_code": "GB"
      },
      "email": "ejohnson@acquired.com",
      "phone": {
        "country_code": "44",
        "number": "2039826580"
      }
    }
  },
  "credential_on_file": "first",
  "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh",
  "custom1": "12345",
  "custom2": "123456",
  "charge_date": "2024-08-05",
  "detail": {
    "scheme": "bacs",
    "report": "ARUDD",
    "reason_code": "1"
  }
}