RecurlyClient.Types.Transaction

Contains the types generated from the schema Transaction

Documentation

data Transaction

Defines the object schema located at components.schemas.Transaction in the specification.

Constructors

Transaction

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

Instances

FromJSON Transaction

Defined in RecurlyClient.Types.Transaction

Methods

parseJSON :: Value -> Parser Transaction

parseJSONList :: Value -> Parser [Transaction]

ToJSON Transaction

Defined in RecurlyClient.Types.Transaction

Methods

toJSON :: Transaction -> Value

toEncoding :: Transaction -> Encoding

toJSONList :: [Transaction] -> Value

toEncodingList :: [Transaction] -> Encoding

Show Transaction

Defined in RecurlyClient.Types.Transaction

Methods

showsPrec :: Int -> Transaction -> ShowS

show :: Transaction -> String

showList :: [Transaction] -> ShowS

Eq Transaction

Defined in RecurlyClient.Types.Transaction

Methods

(==) :: Transaction -> Transaction -> Bool

(/=) :: Transaction -> Transaction -> Bool

mkTransaction :: Transaction

Create a new Transaction with all required fields.

data TransactionAvs_check

Defines the enum schema located at components.schemas.Transaction.properties.avs_check in the specification.

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

Constructors

TransactionAvs_checkOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

TransactionAvs_checkTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

TransactionAvs_checkEnumA

Represents the JSON value A

TransactionAvs_checkEnumB

Represents the JSON value B

TransactionAvs_checkEnumC

Represents the JSON value C

TransactionAvs_checkEnumD

Represents the JSON value D

TransactionAvs_checkEnumE

Represents the JSON value E

TransactionAvs_checkEnumF

Represents the JSON value F

TransactionAvs_checkEnumG

Represents the JSON value G

TransactionAvs_checkEnumH

Represents the JSON value H

TransactionAvs_checkEnumI

Represents the JSON value I

TransactionAvs_checkEnumJ

Represents the JSON value J

TransactionAvs_checkEnumK

Represents the JSON value K

TransactionAvs_checkEnumL

Represents the JSON value L

TransactionAvs_checkEnumM

Represents the JSON value M

TransactionAvs_checkEnumN

Represents the JSON value N

TransactionAvs_checkEnumO

Represents the JSON value O

TransactionAvs_checkEnumP

Represents the JSON value P

TransactionAvs_checkEnumQ

Represents the JSON value Q

TransactionAvs_checkEnumR

Represents the JSON value R

TransactionAvs_checkEnumS

Represents the JSON value S

TransactionAvs_checkEnumT

Represents the JSON value T

TransactionAvs_checkEnumU

Represents the JSON value U

TransactionAvs_checkEnumV

Represents the JSON value V

TransactionAvs_checkEnumW

Represents the JSON value W

TransactionAvs_checkEnumX

Represents the JSON value X

TransactionAvs_checkEnumY

Represents the JSON value Y

TransactionAvs_checkEnumZ

Represents the JSON value Z

Instances

FromJSON TransactionAvs_check

Defined in RecurlyClient.Types.Transaction

Methods

parseJSON :: Value -> Parser TransactionAvs_check

parseJSONList :: Value -> Parser [TransactionAvs_check]

ToJSON TransactionAvs_check

Defined in RecurlyClient.Types.Transaction

Methods

toJSON :: TransactionAvs_check -> Value

toEncoding :: TransactionAvs_check -> Encoding

toJSONList :: [TransactionAvs_check] -> Value

toEncodingList :: [TransactionAvs_check] -> Encoding

Show TransactionAvs_check

Defined in RecurlyClient.Types.Transaction

Methods

showsPrec :: Int -> TransactionAvs_check -> ShowS

show :: TransactionAvs_check -> String

showList :: [TransactionAvs_check] -> ShowS

Eq TransactionAvs_check

Defined in RecurlyClient.Types.Transaction

Methods

(==) :: TransactionAvs_check -> TransactionAvs_check -> Bool

(/=) :: TransactionAvs_check -> TransactionAvs_check -> Bool

data TransactionCollection_method

Defines the enum schema located at components.schemas.Transaction.properties.collection_method in the specification.

The method by which the payment was collected.

Constructors

TransactionCollection_methodOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

TransactionCollection_methodTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

TransactionCollection_methodEnumAutomatic

Represents the JSON value "automatic"

TransactionCollection_methodEnumManual

Represents the JSON value "manual"

Instances

FromJSON TransactionCollection_method

Defined in RecurlyClient.Types.Transaction

Methods

parseJSON :: Value -> Parser TransactionCollection_method

parseJSONList :: Value -> Parser [TransactionCollection_method]

ToJSON TransactionCollection_method

Defined in RecurlyClient.Types.Transaction

Methods

toJSON :: TransactionCollection_method -> Value

toEncoding :: TransactionCollection_method -> Encoding

toJSONList :: [TransactionCollection_method] -> Value

toEncodingList :: [TransactionCollection_method] -> Encoding

Show TransactionCollection_method

Defined in RecurlyClient.Types.Transaction

Methods

showsPrec :: Int -> TransactionCollection_method -> ShowS

show :: TransactionCollection_method -> String

showList :: [TransactionCollection_method] -> ShowS

Eq TransactionCollection_method

Defined in RecurlyClient.Types.Transaction

Methods

(==) :: TransactionCollection_method -> TransactionCollection_method -> Bool

(/=) :: TransactionCollection_method -> TransactionCollection_method -> Bool

data TransactionCvv_check

Defines the enum schema located at components.schemas.Transaction.properties.cvv_check in the specification.

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

Constructors

TransactionCvv_checkOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

TransactionCvv_checkTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

TransactionCvv_checkEnumD

Represents the JSON value D

TransactionCvv_checkEnumI

Represents the JSON value I

TransactionCvv_checkEnumM

Represents the JSON value M

TransactionCvv_checkEnumN

Represents the JSON value N

TransactionCvv_checkEnumP

Represents the JSON value P

TransactionCvv_checkEnumS

Represents the JSON value S

TransactionCvv_checkEnumU

Represents the JSON value U

TransactionCvv_checkEnumX

Represents the JSON value X

Instances

FromJSON TransactionCvv_check

Defined in RecurlyClient.Types.Transaction

Methods

parseJSON :: Value -> Parser TransactionCvv_check

parseJSONList :: Value -> Parser [TransactionCvv_check]

ToJSON TransactionCvv_check

Defined in RecurlyClient.Types.Transaction

Methods

toJSON :: TransactionCvv_check -> Value

toEncoding :: TransactionCvv_check -> Encoding

toJSONList :: [TransactionCvv_check] -> Value

toEncodingList :: [TransactionCvv_check] -> Encoding

Show TransactionCvv_check

Defined in RecurlyClient.Types.Transaction

Methods

showsPrec :: Int -> TransactionCvv_check -> ShowS

show :: TransactionCvv_check -> String

showList :: [TransactionCvv_check] -> ShowS

Eq TransactionCvv_check

Defined in RecurlyClient.Types.Transaction

Methods

(==) :: TransactionCvv_check -> TransactionCvv_check -> Bool

(/=) :: TransactionCvv_check -> TransactionCvv_check -> Bool

data TransactionOrigin

Defines the enum schema located at components.schemas.Transaction.properties.origin in the specification.

Describes how the transaction was triggered.

Constructors

TransactionOriginOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

TransactionOriginTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

TransactionOriginEnumApi

Represents the JSON value "api"

TransactionOriginEnumChargeback

Represents the JSON value "chargeback"

TransactionOriginEnumExternal_recovery

Represents the JSON value "external_recovery"

TransactionOriginEnumForce_collect

Represents the JSON value "force_collect"

TransactionOriginEnumHpp

Represents the JSON value "hpp"

TransactionOriginEnumMerchant

Represents the JSON value "merchant"

TransactionOriginEnumRecurly_admin

Represents the JSON value "recurly_admin"

TransactionOriginEnumRecurlyjs

Represents the JSON value "recurlyjs"

TransactionOriginEnumRecurring

Represents the JSON value "recurring"

TransactionOriginEnumRefunded_externally

Represents the JSON value "refunded_externally"

TransactionOriginEnumTransparent

Represents the JSON value "transparent"

Instances

FromJSON TransactionOrigin

Defined in RecurlyClient.Types.Transaction

Methods

parseJSON :: Value -> Parser TransactionOrigin

parseJSONList :: Value -> Parser [TransactionOrigin]

ToJSON TransactionOrigin

Defined in RecurlyClient.Types.Transaction

Methods

toJSON :: TransactionOrigin -> Value

toEncoding :: TransactionOrigin -> Encoding

toJSONList :: [TransactionOrigin] -> Value

toEncodingList :: [TransactionOrigin] -> Encoding

Show TransactionOrigin

Defined in RecurlyClient.Types.Transaction

Methods

showsPrec :: Int -> TransactionOrigin -> ShowS

show :: TransactionOrigin -> String

showList :: [TransactionOrigin] -> ShowS

Eq TransactionOrigin

Defined in RecurlyClient.Types.Transaction

Methods

(==) :: TransactionOrigin -> TransactionOrigin -> Bool

(/=) :: TransactionOrigin -> TransactionOrigin -> Bool

data TransactionPayment_gateway

Defines the object schema located at components.schemas.Transaction.properties.payment_gateway in the specification.

Constructors

TransactionPayment_gateway

Fields

• transactionPayment_gatewayId :: Maybe Text

  id

• transactionPayment_gatewayName :: Maybe Text

  name

• transactionPayment_gatewayObject :: Maybe Text

  object

• transactionPayment_gatewayType :: Maybe Text

  type

Instances

FromJSON TransactionPayment_gateway

Defined in RecurlyClient.Types.Transaction

Methods

parseJSON :: Value -> Parser TransactionPayment_gateway

parseJSONList :: Value -> Parser [TransactionPayment_gateway]

ToJSON TransactionPayment_gateway

Defined in RecurlyClient.Types.Transaction

Methods

toJSON :: TransactionPayment_gateway -> Value

toEncoding :: TransactionPayment_gateway -> Encoding

toJSONList :: [TransactionPayment_gateway] -> Value

toEncodingList :: [TransactionPayment_gateway] -> Encoding

Show TransactionPayment_gateway

Defined in RecurlyClient.Types.Transaction

Methods

showsPrec :: Int -> TransactionPayment_gateway -> ShowS

show :: TransactionPayment_gateway -> String

showList :: [TransactionPayment_gateway] -> ShowS

Eq TransactionPayment_gateway

Defined in RecurlyClient.Types.Transaction

Methods

(==) :: TransactionPayment_gateway -> TransactionPayment_gateway -> Bool

(/=) :: TransactionPayment_gateway -> TransactionPayment_gateway -> Bool

mkTransactionPayment_gateway :: TransactionPayment_gateway

Create a new TransactionPayment_gateway with all required fields.

data TransactionStatus

Defines the enum schema located at components.schemas.Transaction.properties.status in the specification.

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

Constructors

TransactionStatusOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

TransactionStatusTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

TransactionStatusEnumChargeback

Represents the JSON value "chargeback"

TransactionStatusEnumDeclined

Represents the JSON value "declined"

TransactionStatusEnumError

Represents the JSON value "error"

TransactionStatusEnumPending

Represents the JSON value "pending"

TransactionStatusEnumProcessing

Represents the JSON value "processing"

TransactionStatusEnumScheduled

Represents the JSON value "scheduled"

TransactionStatusEnumSuccess

Represents the JSON value "success"

TransactionStatusEnumVoid

Represents the JSON value "void"

Instances

FromJSON TransactionStatus

Defined in RecurlyClient.Types.Transaction

Methods

parseJSON :: Value -> Parser TransactionStatus

parseJSONList :: Value -> Parser [TransactionStatus]

ToJSON TransactionStatus

Defined in RecurlyClient.Types.Transaction

Methods

toJSON :: TransactionStatus -> Value

toEncoding :: TransactionStatus -> Encoding

toJSONList :: [TransactionStatus] -> Value

toEncodingList :: [TransactionStatus] -> Encoding

Show TransactionStatus

Defined in RecurlyClient.Types.Transaction

Methods

showsPrec :: Int -> TransactionStatus -> ShowS

show :: TransactionStatus -> String

showList :: [TransactionStatus] -> ShowS

Eq TransactionStatus

Defined in RecurlyClient.Types.Transaction

Methods

(==) :: TransactionStatus -> TransactionStatus -> Bool

(/=) :: TransactionStatus -> TransactionStatus -> Bool

data TransactionType

Defines the enum schema located at components.schemas.Transaction.properties.type in the specification.

• `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.

Constructors

TransactionTypeOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

TransactionTypeTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

TransactionTypeEnumAuthorization

Represents the JSON value "authorization"

TransactionTypeEnumCapture

Represents the JSON value "capture"

TransactionTypeEnumPurchase

Represents the JSON value "purchase"

TransactionTypeEnumRefund

Represents the JSON value "refund"

TransactionTypeEnumVerify

Represents the JSON value "verify"

Instances

FromJSON TransactionType

Defined in RecurlyClient.Types.Transaction

Methods

parseJSON :: Value -> Parser TransactionType

parseJSONList :: Value -> Parser [TransactionType]

ToJSON TransactionType

Defined in RecurlyClient.Types.Transaction

Methods

toJSON :: TransactionType -> Value

toEncoding :: TransactionType -> Encoding

toJSONList :: [TransactionType] -> Value

toEncodingList :: [TransactionType] -> Encoding

Show TransactionType

Defined in RecurlyClient.Types.Transaction

Methods

showsPrec :: Int -> TransactionType -> ShowS

show :: TransactionType -> String

showList :: [TransactionType] -> ShowS

Eq TransactionType

Defined in RecurlyClient.Types.Transaction

Methods

(==) :: TransactionType -> TransactionType -> Bool

(/=) :: TransactionType -> TransactionType -> Bool