Sign in
Transactions

Update a transaction.

Updates 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.

patch/transactions/{transaction_id}

Request body

{"stackTrail":"paths:/transactions/{transaction_id}:patch:requestBody:content:application/json:schema:allOf:properties:transaction_id","oasType":"schema","type":"unknown","description":"Unique external identifier for the transaction. Required if using counterparty MLA."}
transaction_datestring

ISO 8601 date. Used as the transaction's date or date to look back from when evaluating an account.

amountinteger

Amount in cents

currencystring

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

source0 — unresolved $ref
destination0 — unresolved $ref
process_method'Card' | 'Internal' | 'Check' | 'P2P' | 'ACH' | 'Cash' | 'Wire' | 'RTP' nullable

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

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)

interaction_point'Android' | 'ATM' | 'Card Swipe Terminal' | 'iOS' | 'Mobile' | 'Online Form' | 'Point of Sale' | '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", "Teller", "3rd Party App", null)

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

is_triggered_by_userboolean nullable

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

is_international_overrideboolean nullable

True if the transaction is international

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.

entry_modenumber nullable

POS entry modes on card transactions

response_codenumber nullable

Response codes returned on card transactions

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.

iso_messagenumber nullable

ISO standard value returned on card transactions

settled_atstring nullable

ISO 8601 date. Currently not used in decisioning.

latest_transaction_datestring nullable

ISO 8601 date. Currently not used in decisioning.

descriptionstring nullable

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

approval_codestring nullable

The raw approval code provided by the customer. Currently not used in decisioning.

transaction_metaobject nullable

Object containing extra raw data not stored in other columns. Currently not used in decisioning.

Example request

{
  "transaction_date": "2021-10-24 18:02:00+00",
  "latest_transaction_date": "2021-10-24 18:02:00+00",
  "settled_at": "2021-10-24 18:03:00+00",
  "amount": 200,
  "category": "Deposit",
  "currency": "USD",
  "description": "Mobile App Deposit",
  "is_approved": true,
  "transaction_meta": {
    "customAttribute": "customValue"
  },
  "process_method": "ACH",
  "interaction_point": "iOS"
}

Response

Transaction updated successfully.

0 required— unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.