ALalloy
Transactions

Get a transaction.

Changed on

Retrieves a Transaction by external transaction ID.

Note: If you are using the Alloy Events API, you do not need to use any of the Transactions endpoints. All data should be sent through the Events API with a relevant event_type.

get/transactions/{transaction_id}

Request

Response

Returns the transaction matching the ID.

external_transaction_idstring

Unique external identifier for the transaction.

amountinteger

Amount in cents. +/- indicate direction of funds.

currencystring

3-character currency code (e.g. "USD")

entity_tokenstring
external_entity_idstring
external_account_idstring
external_session_idstring nullable

Optional identifier for correlating multiple events that belong to the same session.

category'Adjustment' | 'ATM Rebate' | 'Bill Pay' | 'Chargeback' | 'Deposit' | 'Direct Deposit Bonus' | 'Interest' | 'Overdraft Fee' | 'Payment' | 'Promo' | 'Purchase' | 'Purchase Return' | 'Return' | 'Service Charge' | 'Withdrawal' nullable

Splits process_method into more granular values. Allowed values are ("Adjustment", "ATM Rebate", "Bill Pay", "Chargeback", "Deposit", "Direct Deposit Bonus", "Interest", "Overdraft Fee", "Payment", "Promo", "Purchase", "Purchase Return", "Return", "Service Charge", "Withdrawal", null)

transaction_settled_atstring date-time nullable

The datetime the transaction was settled in the customer's system (Valid Format: YYYY-MM-DD'T'HH:MM:SS'Z'). Currently not used in decisioning.

descriptionstring nullable

A description of the transaction. Currently not used in decisioning.

type_codestring nullable

The raw type code of the transaction. There should be a 1:1 mapping from type_code to type_description provided to Alloy.

type_descriptionstring nullable

Description of the type code. There should be a 1:1 mapping from type_code to type_description provided to Alloy. Currently not used in decisioning.

is_approvedboolean nullable

If the transaction was approved by the customer

is_reversalboolean nullable

If the transaction is a refund

process_method'Card' | 'Internal' | 'Check' | 'P2P' | 'ACH' | 'Cash' | 'Wire' | 'Digital Wallet' nullable

Platform or process method of the transaction. Allowed values are ("Card", "Internal", "Check", "P2P", "ACH", "Cash", "Wire", RTP, "Digital Wallet", null)

is_triggered_by_userboolean nullable

Whether the transaction is initiated by the source entity. Mainly used to distinguish betweeh ACH push and pull

interaction_point'Android' | 'ATM' | 'Card Swipe Terminal' | 'iOS' | 'Mobile' | 'Online Form' | 'Point of Sale' | 'QR' | 'Teller' | '3rd Party App' nullable

Where the transaction took place. Allow values are ("Android", "ATM", "Card Swipe Terminal", "iOS", "Mobile", "Online Form", "Point of Sale", "QR", "Teller", "3rd Party App", null)

return_codestring nullable

This represents the Alphanumeric ACH return Code. (e.g. R01)

return_code_reason'Unauthorized' nullable

Allowed values are ("Unauthorized", null). Currently not used in decisioning.

status'Acknowledged' | 'Accepted' | 'Rejected' | 'Paused' | 'Pending' | 'Completed' | 'Declined' | 'Cancelled' nullable

Allowed values are ("Acknowledged", "Accepted", "Rejected", "Paused", "Pending", "Completed", "Declined", "Cancelled", null)

status_detailstring nullable

Additional description on transaction status. Currently not used in decisioning.

response_codenumber nullable

Response codes returned on card transactions

iso_messagenumber nullable

ISO standard value returned on card transactions

entry_modenumber nullable

POS entry modes on card transactions

timestampstring date-time

The datetime the transaction was created in the customer's system (Valid Format: YYYY-MM-DD'T'HH:MM:SS'Z').

Example response

{
  "counterparty": {
    "identity": {
      "device": {
        "ip_address_v4": "19.117.63.126",
        "ip_address_v6": "2001:db8::1"
      }
    }
  },
  "linked_transactions": [
    {
      "reason": "Chargeback"
    }
  ]
}

Changes

  • 615aa97a5ddbRevision changes
    • warning

      added the new Digital Wallet enum value to the response property for the response status

    • warning

      added the new QR enum value to the response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added subschema #3: Specify Typed Identity subschema #4: Specify Typed Instrument to the response property anyOf list for the response status