Pick the List Transactions action (under transaction).
Fill in the fields below, then reference the result from later steps as {{listTransactions.response.data}}.
Request
Query parameters
idsarray<string>
Filter results by their IDs. Up to 200 IDs can be passed at once using
commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.
**Important notes:**
* The `ids` parameter cannot be used with any other ordering or filtering
parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
limitinteger
Limit number of records 1-200.
Default 20
orderstring
Sort order.
One ofascdescDefault "desc"
sortstring
Sort field. You *really* only want to sort by `updated_at` in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
One ofcreated_atupdated_atDefault "created_at"
begin_timestring (date-time)
Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
end_timestring (date-time)
Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
typestring
Filter by type field. The value `payment` will return both `purchase` and `capture` transactions.
One ofauthorizationcapturepaymentpurchaserefundverify
successstring
Filter by success field.
One oftrue
Response
Returns 200 with an object. Read it in later steps with {{listTransactions.response.data.<field>}}.
objectstring
Will always be List.
has_moreboolean
Indicates there are more results on subsequent pages.
nextstring
Path to subsequent page of results.
dataarray<object>
idstring
objectstring
uuidstring
The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
original_transaction_idstring
If this transaction is a refund (`type=refund`), this will be the ID of the original transaction on the invoice being refunded.
accountobject10 fields
initiatorstring
Must be sent for one-time transactions in order to provide context on which entity is submitting the transaction to ensure proper fraud checks are observed, such as 3DS. If the customer is in session, send `customer`. If this is a merchant initiated one-time transaction, send `merchant`.
One ofcustomermerchant
invoiceobject6 fields
merchant_reason_codestring
This conditional parameter is useful for merchants in specific industries who need to submit one-time Merchant Initiated transactions in specific cases.
Not all gateways support these methods, but will support a generic one-time Merchant Initiated transaction.
Only use this if the initiator value is "merchant". Otherwise, it will be ignored.
- Incremental: Send `incremental` with an additional purchase if the original authorization amount is not sufficient to cover the costs of your service or product. For example, if the customer adds goods or services or there are additional expenses.
- No Show: Send `no_show` if you charge customers a fee due to an agreed-upon cancellation policy in your industry.
- Resubmission: Send `resubmission` if you need to attempt collection on a declined transaction. You may also use the force collection behavior which has the same effect.
- Service Extension: Send `service_extension` if you are in a service industry and the customer has increased/extended their service in some way. For example: adding a day onto a car rental agreement.
- Split Shipment: Send `split_shipment` if you sell physical product and need to split up a shipment into multiple transactions when the customer is no longer in session.
- Top Up: Send `top_up` if you process one-time transactions based on a pre-arranged agreement with your customer where there is a pre-arranged account balance that needs maintaining. For example, if the customer has agreed to maintain an account balance of 30.00 and their current balance is 20.00, the MIT amount would be at least 10.00 to meet that 30.00 threshold.
One ofincrementalno_showresubmissionservice_extensionsplit_shipmenttop_upDefault "none"
voided_by_invoiceobject6 fields
subscription_idsarray<string>
If the transaction is charging or refunding for one or more subscriptions, these are their IDs.
typestring
- `authorization` – verifies billing information and places a hold on money in the customer's account.
- `capture` – captures funds held by an authorization and completes a purchase.
- `purchase` – combines the authorization and capture in one transaction.
- `refund` – returns all or a portion of the money collected in a previous transaction to the customer.
- `verify` – a $0 or $1 transaction used to verify billing information which is immediately voided.
One ofauthorizationcapturepurchaserefundverify
originstring
Describes how the transaction was triggered.
One ofapichargebackexternal_recoveryforce_collecthppmerchantrecurly_adminrecurlyjsrecurringrefunded_externallytransparenttoken_apiapi_force_collectapi_sub_changeapi_verify_cardrefund_balanceamazon_v2_ipn
currencystring
3-letter ISO 4217 currency code.
descriptionstring
The description that gets sent to the gateway.
amountnumber (float)
Total transaction amount sent to the payment gateway.
statusstring
The current transaction status. Note that the status may change, e.g. a `pending` transaction may become `declined` or `success` may later become `void`.
One ofchargebackdeclinederrorpendingprocessingscheduledsuccessvoid
successboolean
Did this transaction complete successfully?
backup_payment_method_usedboolean
Indicates if the transaction was completed using a backup payment
refundedboolean
Indicates if part or all of this transaction was refunded.
billing_addressobject2 fields
collection_methodstring
The method by which the payment was collected.
One ofautomaticmanual
payment_methodobject19 fields
ip_address_v4string
IP address provided when the billing information was collected:
- When the customer enters billing information into the Recurly.js or Hosted Payment Pages, Recurly records the IP address.
- When the merchant enters billing information using the API, the merchant may provide an IP address.
- When the merchant enters billing information using the UI, no IP address is recorded.
ip_address_countrystring
status_codestring
status_messagestring
For declined (`success=false`) transactions, the message displayed to the merchant.
customer_messagestring
For declined (`success=false`) transactions, the message displayed to the customer.
customer_message_localestring
payment_gatewayobject4 fields
gateway_messagestring
Transaction message from the payment gateway.
gateway_referencestring
Transaction reference number from the payment gateway.
gateway_approval_codestring
gateway_response_codestring
gateway_response_timenumber (float)
Time, in seconds, for gateway to process the transaction.
gateway_response_valuesobject
The values in this field will vary from gateway to gateway.
cvv_checkstring
When processed, result from checking the CVV/CVC value on the transaction.
One ofDIMNPSUX
avs_checkstring
When processed, result from checking the overall AVS on the transaction.
