Documentation

Fields

• transactionAccount :: Maybe AccountMini

  account

• transactionAction_result :: Maybe Object

  action_result: Action result params to be used in Recurly-JS to complete a payment when using asynchronous payment methods, e.g., Boleto, iDEAL and Sofort.

• transactionAmount :: Maybe Float

  amount: Total transaction amount sent to the payment gateway.

• transactionAvs_check :: Maybe TransactionAvs_check

  avs_check: When processed, result from checking the overall AVS on the transaction.

• transactionBackup_payment_method_used :: Maybe Bool

  backup_payment_method_used: Indicates if the transaction was completed using a backup payment

• transactionBilling_address :: Maybe AddressWithName

  billing_address

• transactionCollected_at :: Maybe JsonDateTime

  collected_at

• transactionCollection_method :: Maybe TransactionCollection_method

  collection_method: The method by which the payment was collected.

• transactionCreated_at :: Maybe JsonDateTime

  created_at

• transactionCurrency :: Maybe Text

  currency: 3-letter ISO 4217 currency code.

  Constraints:

  • Maximum length of 3
• transactionCustomer_message :: Maybe Text

  customer_message: For declined (`success=false`) transactions, the message displayed to the customer.

• transactionCustomer_message_locale :: Maybe Text

  customer_message_locale

• transactionCvv_check :: Maybe TransactionCvv_check

  cvv_check: When processed, result from checking the CVV/CVC value on the transaction.

• transactionFraud_info :: Maybe TransactionFraudInfo

  fraud_info

• transactionGateway_approval_code :: Maybe Text

  gateway_approval_code

• transactionGateway_message :: Maybe Text

  gateway_message: Transaction message from the payment gateway.

• transactionGateway_reference :: Maybe Text

  gateway_reference: Transaction reference number from the payment gateway.

• transactionGateway_response_code :: Maybe Text

  gateway_response_code

• transactionGateway_response_time :: Maybe Float

  gateway_response_time: Time, in seconds, for gateway to process the transaction.

• transactionGateway_response_values :: Maybe Object

  gateway_response_values: The values in this field will vary from gateway to gateway.

• transactionId :: Maybe Text

  id

  Constraints:

  • Maximum length of 13
• transactionIndicator :: Maybe TransactionIndicator

  indicator: 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`.

• transactionInvoice :: Maybe InvoiceMini

  invoice

• transactionIp_address_country :: Maybe Text

  ip_address_country

• transactionIp_address_v4 :: Maybe Text

  ip_address_v4: 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.
• transactionMerchant_reason_code :: Maybe TransactionMerchant_reason_code

  merchant_reason_code: 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.

• transactionObject :: Maybe Text

  object

• transactionOrigin :: Maybe TransactionOrigin

  origin: Describes how the transaction was triggered.

• transactionOriginal_transaction_id :: Maybe Text

  original_transaction_id: If this transaction is a refund (`type=refund`), this will be the ID of the original transaction on the invoice being refunded.

  Constraints:

  • Maximum length of 13
• transactionPayment_gateway :: Maybe TransactionPayment_gateway

  payment_gateway

• transactionPayment_method :: Maybe PaymentMethod

  payment_method

• transactionRefunded :: Maybe Bool

  refunded: Indicates if part or all of this transaction was refunded.

• transactionStatus :: Maybe TransactionStatus

  status: The current transaction status. Note that the status may change, e.g. a `pending` transaction may become `declined` or `success` may later become `void`.

• transactionStatus_code :: Maybe Text

  status_code

• transactionStatus_message :: Maybe Text

  status_message: For declined (`success=false`) transactions, the message displayed to the merchant.

• transactionSubscription_ids :: Maybe [Text]

  subscription_ids: If the transaction is charging or refunding for one or more subscriptions, these are their IDs.

• transactionSuccess :: Maybe Bool

  success: Did this transaction complete successfully?

• transactionType :: Maybe TransactionType

  type: - `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.

• transactionUpdated_at :: Maybe JsonDateTime

  updated_at

• transactionUuid :: Maybe Text

  uuid: The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.

  Constraints:

  • Maximum length of 32
• transactionVat_number :: Maybe Text

  vat_number: VAT number for the customer on this transaction. If the customer's Billing Info country is BR or AR, then this will be their Tax Identifier. For all other countries this will come from the VAT Number field in the Billing Info.

• transactionVoided_at :: Maybe JsonDateTime

  voided_at

• transactionVoided_by_invoice :: Maybe InvoiceMini

  voided_by_invoice

Fields

• transactionPayment_gatewayId :: Maybe Text

  id

• transactionPayment_gatewayName :: Maybe Text

  name

• transactionPayment_gatewayObject :: Maybe Text

  object

• transactionPayment_gatewayType :: Maybe Text

  type