action increase_simulate_a_refund_on_a_card { label: "Simulate a refund on a card" description: "Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded." provider: increase method: POST path: "/simulations/card_refunds" encoding: json input: { type: "object" required: ["transaction_id"] properties: { transaction_id: { type: "string" description: "The identifier for the Transaction to refund. The Transaction's source must have a category of card_settlement." } } } output: { type: "object" description: "Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement." required: ["account_id", "amount", "created_at", "currency", "description", "id", "route_id", "route_type", "source", "type"] properties: { account_id: { type: "string" description: "The identifier for the Account the Transaction belongs to." } amount: { type: "integer" description: "The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents." } created_at: { type: "string" format: "date-time" description: "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transcation's Account." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } description: { type: "string" description: "For a Transaction related to a transfer, this is the description you provide. For a Transaction related to a payment, this is the description the vendor provides." } id: { type: "string" description: "The Transaction identifier." } route_id: { type: "string" description: "The identifier for the route this Transaction came through. Routes are things like cards and ACH details." } route_type: { type: "string" description: "The type of the route this Transaction came through." } source: { type: "object" description: "This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future." required: ["account_transfer_intention", "ach_check_conversion", "ach_check_conversion_return", "ach_transfer_intention", "ach_transfer_rejection", "ach_transfer_return", "card_dispute_acceptance", "card_refund", "card_route_refund", "card_route_settlement", "card_settlement", "category", "check_deposit_acceptance", "check_deposit_return", "check_transfer_intention", "check_transfer_rejection", "check_transfer_return", "check_transfer_stop_payment_request", "dispute_resolution", "empyreal_cash_deposit", "inbound_ach_transfer", "inbound_check", "inbound_international_ach_transfer", "inbound_real_time_payments_transfer_confirmation", "inbound_wire_drawdown_payment", "inbound_wire_drawdown_payment_reversal", "inbound_wire_reversal", "inbound_wire_transfer", "interest_payment", "internal_source", "sample_funds", "wire_drawdown_payment_intention", "wire_drawdown_payment_rejection", "wire_transfer_intention", "wire_transfer_rejection"] properties: { account_transfer_intention: { type: "object" description: "A Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`." required: ["amount", "currency", "description", "destination_account_id", "source_account_id", "transfer_id"] properties: { amount: { type: "integer" description: "The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } description: { type: "string" description: "The description you chose to give the transfer." } destination_account_id: { type: "string" description: "The identifier of the Account to where the Account Transfer was sent." } source_account_id: { type: "string" description: "The identifier of the Account from where the Account Transfer was sent." } transfer_id: { type: "string" description: "The identifier of the Account Transfer that led to this Pending Transaction." } } } ach_check_conversion: { type: "object" description: "A ACH Check Conversion object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion`." required: ["amount", "file_id"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } file_id: { type: "string" description: "The identifier of the File containing an image of the returned check." } } } ach_check_conversion_return: { type: "object" description: "A ACH Check Conversion Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion_return`." required: ["amount", "return_reason_code"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } return_reason_code: { type: "string" description: "Why the transfer was returned." } } } ach_transfer_intention: { type: "object" description: "A ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`." required: ["account_number", "amount", "routing_number", "statement_descriptor", "transfer_id"] properties: { account_number: { type: "string" } amount: { type: "integer" description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } routing_number: { type: "string" } statement_descriptor: { type: "string" } transfer_id: { type: "string" description: "The identifier of the ACH Transfer that led to this Transaction." } } } ach_transfer_rejection: { type: "object" description: "A ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`." required: ["transfer_id"] properties: { transfer_id: { type: "string" description: "The identifier of the ACH Transfer that led to this Transaction." } } } ach_transfer_return: { type: "object" description: "A ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`." required: ["created_at", "return_reason_code", "transaction_id", "transfer_id"] properties: { created_at: { type: "string" format: "date-time" description: "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created." } return_reason_code: { type: "string" description: "Why the ACH Transfer was returned." enum: ["insufficient_fund", "no_account", "account_closed", "invalid_account_number_structure", "account_frozen_entry_returned_per_ofac_instruction", "credit_entry_refused_by_receiver", "unauthorized_debit_to_consumer_account_using_corporate_sec_code", "corporate_customer_advised_not_authorized", "payment_stopped", "non_transaction_account", "uncollected_funds", "routing_number_check_digit_error", "customer_advised_unauthorized_improper_ineligible_or_incomplete", "amount_field_error", "authorization_revoked_by_customer", "invalid_ach_routing_number", "file_record_edit_criteria", "enr_invalid_individual_name", "returned_per_odfi_request", "addenda_error", "limited_participation_dfi", "incorrectly_coded_outbound_international_payment", "other"] } transaction_id: { type: "string" description: "The identifier of the Tranasaction associated with this return." } transfer_id: { type: "string" description: "The identifier of the ACH Transfer associated with this return." } } } card_dispute_acceptance: { type: "object" description: "A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`." required: ["accepted_at", "card_dispute_id", "transaction_id"] properties: { accepted_at: { type: "string" format: "date-time" description: "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted." } card_dispute_id: { type: "string" description: "The identifier of the Card Dispute that was accepted." } transaction_id: { type: "string" description: "The identifier of the Transaction that was created to return the disputed funds to your account." } } } card_refund: { type: "object" description: "A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`." required: ["amount", "card_settlement_transaction_id", "currency", "type"] properties: { amount: { type: "integer" description: "The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } card_settlement_transaction_id: { type: "string" description: "The identifier for the Transaction this refunds, if any." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } type: { type: "string" description: "A constant representing the object's type. For this resource it will always be `card_refund`." enum: ["card_refund"] } } } card_route_refund: { type: "object" description: "A Deprecated Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_route_refund`." required: ["amount", "currency", "merchant_acceptor_id", "merchant_category_code", "merchant_city", "merchant_country", "merchant_descriptor", "merchant_state"] properties: { amount: { type: "integer" description: "The refunded amount in the minor unit of the refunded currency. For dollars, for example, this is cents." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } merchant_acceptor_id: { type: "string" } merchant_category_code: { type: "string" } merchant_city: { type: "string" } merchant_country: { type: "string" } merchant_descriptor: { type: "string" } merchant_state: { type: "string" } } } card_route_settlement: { type: "object" description: "A Deprecated Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_route_settlement`." required: ["amount", "currency", "merchant_acceptor_id", "merchant_category_code", "merchant_city", "merchant_country", "merchant_descriptor", "merchant_state"] properties: { amount: { type: "integer" description: "The settled amount in the minor unit of the settlement currency. For dollars, for example, this is cents." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } merchant_acceptor_id: { type: "string" } merchant_category_code: { type: "string" } merchant_city: { type: "string" } merchant_country: { type: "string" } merchant_descriptor: { type: "string" } merchant_state: { type: "string" } } } card_settlement: { type: "object" description: "A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`." required: ["amount", "currency", "merchant_category_code", "merchant_city", "merchant_country", "merchant_name", "merchant_state", "pending_transaction_id", "presentment_amount", "presentment_currency", "type"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } merchant_category_code: { type: "string" } merchant_city: { type: "string" } merchant_country: { type: "string" } merchant_name: { type: "string" } merchant_state: { type: "string" } pending_transaction_id: { type: "string" description: "The identifier of the Pending Transaction associated with this Transaction." } presentment_amount: { type: "integer" description: "The amount in the minor unit of the transaction's presentment currency." } presentment_currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency." } type: { type: "string" description: "A constant representing the object's type. For this resource it will always be `card_settlement`." enum: ["card_settlement"] } } } category: { type: "string" description: "The type of transaction that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully." enum: ["account_transfer_intention", "ach_check_conversion_return", "ach_check_conversion", "ach_transfer_intention", "ach_transfer_rejection", "ach_transfer_return", "card_dispute_acceptance", "card_refund", "card_settlement", "check_deposit_acceptance", "check_deposit_return", "check_transfer_intention", "check_transfer_return", "check_transfer_rejection", "check_transfer_stop_payment_request", "dispute_resolution", "empyreal_cash_deposit", "inbound_ach_transfer", "inbound_ach_transfer_return_intention", "inbound_check", "inbound_international_ach_transfer", "inbound_real_time_payments_transfer_confirmation", "inbound_wire_drawdown_payment_reversal", "inbound_wire_drawdown_payment", "inbound_wire_reversal", "inbound_wire_transfer", "interest_payment", "internal_general_ledger_transaction", "internal_source", "card_route_refund", "card_route_settlement", "real_time_payments_transfer_acknowledgement", "sample_funds", "wire_drawdown_payment_intention", "wire_drawdown_payment_rejection", "wire_transfer_intention", "wire_transfer_rejection", "other"] } check_deposit_acceptance: { type: "object" description: "A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`." required: ["account_number", "amount", "auxiliary_on_us", "check_deposit_id", "currency", "routing_number", "serial_number"] properties: { account_number: { type: "string" description: "The account number printed on the check." } amount: { type: "integer" description: "The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents." } auxiliary_on_us: { type: "string" description: "An additional line of metadata printed on the check. This typically includes the check number for business checks." } check_deposit_id: { type: "string" description: "The ID of the Check Deposit that was accepted." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } routing_number: { type: "string" description: "The routing number printed on the check." } serial_number: { type: "string" description: "The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field." } } } check_deposit_return: { type: "object" description: "A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`." required: ["amount", "check_deposit_id", "currency", "return_reason", "returned_at", "transaction_id"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } check_deposit_id: { type: "string" description: "The identifier of the Check Deposit that was returned." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } return_reason: { type: "string" enum: ["ach_conversion_not_supported", "closed_account", "duplicate_submission", "insufficient_funds", "no_account", "not_authorized", "stale_dated", "stop_payment", "unknown_reason", "unmatched_details", "unreadable_image"] } returned_at: { type: "string" format: "date-time" description: "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned." } transaction_id: { type: "string" description: "The identifier of the transaction that reversed the original check deposit transaction." } } } check_transfer_intention: { type: "object" description: "A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`." required: ["address_city", "address_line1", "address_line2", "address_state", "address_zip", "amount", "currency", "recipient_name", "transfer_id"] properties: { address_city: { type: "string" description: "The city of the check's destination." } address_line1: { type: "string" description: "The street address of the check's destination." } address_line2: { type: "string" description: "The second line of the address of the check's destination." } address_state: { type: "string" description: "The state of the check's destination." } address_zip: { type: "string" description: "The postal code of the check's destination." } amount: { type: "integer" description: "The transfer amount in USD cents." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } recipient_name: { type: "string" description: "The name that will be printed on the check." } transfer_id: { type: "string" description: "The identifier of the Check Transfer with which this is associated." } } } check_transfer_rejection: { type: "object" description: "A Check Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_rejection`." required: ["transfer_id"] properties: { transfer_id: { type: "string" description: "The identifier of the Check Transfer that led to this Transaction." } } } check_transfer_return: { type: "object" description: "A Check Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_return`." required: ["file_id", "transfer_id"] properties: { file_id: { type: "string" description: "If available, a document with additional information about the return." } transfer_id: { type: "string" description: "The identifier of the returned Check Transfer." } } } check_transfer_stop_payment_request: { type: "object" description: "A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`." required: ["requested_at", "transaction_id", "transfer_id", "type"] properties: { requested_at: { type: "string" format: "date-time" description: "The time the stop-payment was requested." } transaction_id: { type: "string" description: "The transaction ID of the corresponding credit transaction." } transfer_id: { type: "string" description: "The ID of the check transfer that was stopped." } type: { type: "string" description: "A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`." enum: ["check_transfer_stop_payment_request"] } } } dispute_resolution: { type: "object" description: "A Dispute Resolution object. This field will be present in the JSON response if and only if `category` is equal to `dispute_resolution`." required: ["amount", "currency", "disputed_transaction_id"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } disputed_transaction_id: { type: "string" description: "The identifier of the Transaction that was disputed." } } } empyreal_cash_deposit: { type: "object" description: "A Empyreal Cash Deposit object. This field will be present in the JSON response if and only if `category` is equal to `empyreal_cash_deposit`." required: ["amount", "bag_id", "deposit_date"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } bag_id: { type: "string" } deposit_date: { type: "string" format: "date-time" } } } inbound_ach_transfer: { type: "object" description: "A Inbound ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`." required: ["amount", "originator_company_descriptive_date", "originator_company_discretionary_data", "originator_company_entry_description", "originator_company_id", "originator_company_name", "receiver_id_number", "receiver_name", "trace_number"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the destination account currency. For dollars, for example, this is cents." } originator_company_descriptive_date: { type: "string" } originator_company_discretionary_data: { type: "string" } originator_company_entry_description: { type: "string" } originator_company_id: { type: "string" } originator_company_name: { type: "string" } receiver_id_number: { type: "string" } receiver_name: { type: "string" } trace_number: { type: "string" } } } inbound_check: { type: "object" description: "A Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`." required: ["amount", "check_front_image_file_id", "check_number", "check_rear_image_file_id", "currency"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the destination account currency. For dollars, for example, this is cents." } check_front_image_file_id: { type: "string" } check_number: { type: "string" } check_rear_image_file_id: { type: "string" } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } } } inbound_international_ach_transfer: { type: "object" description: "A Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`." required: ["amount", "destination_country_code", "destination_currency_code", "foreign_exchange_indicator", "foreign_exchange_reference", "foreign_exchange_reference_indicator", "foreign_payment_amount", "foreign_trace_number", "international_transaction_type_code", "originating_currency_code", "originating_depository_financial_institution_branch_country", "originating_depository_financial_institution_id", "originating_depository_financial_institution_id_qualifier", "originating_depository_financial_institution_name", "originator_city", "originator_company_entry_description", "originator_country", "originator_identification", "originator_name", "originator_postal_code", "originator_state_or_province", "originator_street_address", "payment_related_information", "payment_related_information2", "receiver_city", "receiver_country", "receiver_identification_number", "receiver_postal_code", "receiver_state_or_province", "receiver_street_address", "receiving_company_or_individual_name", "receiving_depository_financial_institution_country", "receiving_depository_financial_institution_id", "receiving_depository_financial_institution_id_qualifier", "receiving_depository_financial_institution_name", "trace_number"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the destination account currency. For dollars, for example, this is cents." } destination_country_code: { type: "string" } destination_currency_code: { type: "string" } foreign_exchange_indicator: { type: "string" } foreign_exchange_reference: { type: "string" } foreign_exchange_reference_indicator: { type: "string" } foreign_payment_amount: { type: "integer" } foreign_trace_number: { type: "string" } international_transaction_type_code: { type: "string" } originating_currency_code: { type: "string" } originating_depository_financial_institution_branch_country: { type: "string" } originating_depository_financial_institution_id: { type: "string" } originating_depository_financial_institution_id_qualifier: { type: "string" } originating_depository_financial_institution_name: { type: "string" } originator_city: { type: "string" } originator_company_entry_description: { type: "string" } originator_country: { type: "string" } originator_identification: { type: "string" } originator_name: { type: "string" } originator_postal_code: { type: "string" } originator_state_or_province: { type: "string" } originator_street_address: { type: "string" } payment_related_information: { type: "string" } payment_related_information2: { type: "string" } receiver_city: { type: "string" } receiver_country: { type: "string" } receiver_identification_number: { type: "string" } receiver_postal_code: { type: "string" } receiver_state_or_province: { type: "string" } receiver_street_address: { type: "string" } receiving_company_or_individual_name: { type: "string" } receiving_depository_financial_institution_country: { type: "string" } receiving_depository_financial_institution_id: { type: "string" } receiving_depository_financial_institution_id_qualifier: { type: "string" } receiving_depository_financial_institution_name: { type: "string" } trace_number: { type: "string" } } } inbound_real_time_payments_transfer_confirmation: { type: "object" description: "A Inbound Real Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`." required: ["amount", "creditor_name", "currency", "debtor_account_number", "debtor_name", "debtor_routing_number", "remittance_information", "transaction_identification"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the transfer's currency. For dollars, for example, this is cents." } creditor_name: { type: "string" description: "The name the sender of the transfer specified as the recipient of the transfer." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be \"USD\" for a Real Time Payments transfer." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } debtor_account_number: { type: "string" description: "The account number of the account that sent the transfer." } debtor_name: { type: "string" description: "The name provided by the sender of the transfer." } debtor_routing_number: { type: "string" description: "The routing number of the account that sent the transfer." } remittance_information: { type: "string" description: "Additional information included with the transfer." } transaction_identification: { type: "string" description: "The Real Time Payments network identification of the transfer" } } } inbound_wire_drawdown_payment: { type: "object" description: "A Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`." required: ["amount", "beneficiary_address_line1", "beneficiary_address_line2", "beneficiary_address_line3", "beneficiary_name", "beneficiary_reference", "description", "input_message_accountability_data", "originator_address_line1", "originator_address_line2", "originator_address_line3", "originator_name", "originator_to_beneficiary_information"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } beneficiary_address_line1: { type: "string" } beneficiary_address_line2: { type: "string" } beneficiary_address_line3: { type: "string" } beneficiary_name: { type: "string" } beneficiary_reference: { type: "string" } description: { type: "string" } input_message_accountability_data: { type: "string" } originator_address_line1: { type: "string" } originator_address_line2: { type: "string" } originator_address_line3: { type: "string" } originator_name: { type: "string" } originator_to_beneficiary_information: { type: "string" } } } inbound_wire_drawdown_payment_reversal: { type: "object" description: "A Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`." required: ["amount", "description", "input_cycle_date", "input_message_accountability_data", "input_sequence_number", "input_source", "previous_message_input_cycle_date", "previous_message_input_message_accountability_data", "previous_message_input_sequence_number", "previous_message_input_source"] properties: { amount: { type: "integer" description: "The amount that was reversed." } description: { type: "string" description: "The description on the reversal message from Fedwire." } input_cycle_date: { type: "string" format: "date" description: "The Fedwire cycle date for the wire reversal." } input_message_accountability_data: { type: "string" description: "The Fedwire transaction identifier." } input_sequence_number: { type: "string" description: "The Fedwire sequence number." } input_source: { type: "string" description: "The Fedwire input source identifier." } previous_message_input_cycle_date: { type: "string" format: "date" description: "The Fedwire cycle date for the wire transfer that was reversed." } previous_message_input_message_accountability_data: { type: "string" description: "The Fedwire transaction identifier for the wire transfer that was reversed." } previous_message_input_sequence_number: { type: "string" description: "The Fedwire sequence number for the wire transfer that was reversed." } previous_message_input_source: { type: "string" description: "The Fedwire input source identifier for the wire transfer that was reversed." } } } inbound_wire_reversal: { type: "object" description: "A Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`." required: ["amount", "description", "financial_institution_to_financial_institution_information", "input_cycle_date", "input_message_accountability_data", "input_sequence_number", "input_source", "previous_message_input_cycle_date", "previous_message_input_message_accountability_data", "previous_message_input_sequence_number", "previous_message_input_source", "receiver_financial_institution_information"] properties: { amount: { type: "integer" description: "The amount that was reversed." } description: { type: "string" description: "The description on the reversal message from Fedwire." } financial_institution_to_financial_institution_information: { type: "string" description: "Additional financial institution information included in the wire reversal." } input_cycle_date: { type: "string" format: "date" description: "The Fedwire cycle date for the wire reversal." } input_message_accountability_data: { type: "string" description: "The Fedwire transaction identifier." } input_sequence_number: { type: "string" description: "The Fedwire sequence number." } input_source: { type: "string" description: "The Fedwire input source identifier." } previous_message_input_cycle_date: { type: "string" format: "date" description: "The Fedwire cycle date for the wire transfer that was reversed." } previous_message_input_message_accountability_data: { type: "string" description: "The Fedwire transaction identifier for the wire transfer that was reversed." } previous_message_input_sequence_number: { type: "string" description: "The Fedwire sequence number for the wire transfer that was reversed." } previous_message_input_source: { type: "string" description: "The Fedwire input source identifier for the wire transfer that was reversed." } receiver_financial_institution_information: { type: "string" description: "Information included in the wire reversal for the receiving financial institution." } } } inbound_wire_transfer: { type: "object" description: "A Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`." required: ["amount", "beneficiary_address_line1", "beneficiary_address_line2", "beneficiary_address_line3", "beneficiary_name", "beneficiary_reference", "description", "input_message_accountability_data", "originator_address_line1", "originator_address_line2", "originator_address_line3", "originator_name", "originator_to_beneficiary_information", "originator_to_beneficiary_information_line1", "originator_to_beneficiary_information_line2", "originator_to_beneficiary_information_line3", "originator_to_beneficiary_information_line4"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } beneficiary_address_line1: { type: "string" } beneficiary_address_line2: { type: "string" } beneficiary_address_line3: { type: "string" } beneficiary_name: { type: "string" } beneficiary_reference: { type: "string" } description: { type: "string" } input_message_accountability_data: { type: "string" } originator_address_line1: { type: "string" } originator_address_line2: { type: "string" } originator_address_line3: { type: "string" } originator_name: { type: "string" } originator_to_beneficiary_information: { type: "string" } originator_to_beneficiary_information_line1: { type: "string" } originator_to_beneficiary_information_line2: { type: "string" } originator_to_beneficiary_information_line3: { type: "string" } originator_to_beneficiary_information_line4: { type: "string" } } } interest_payment: { type: "object" description: "A Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`." required: ["accrued_on_account_id", "amount", "currency", "period_end", "period_start"] properties: { accrued_on_account_id: { type: "string" description: "The account on which the interest was accrued." } amount: { type: "integer" description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } period_end: { type: "string" format: "date-time" description: "The end of the period for which this transaction paid interest." } period_start: { type: "string" format: "date-time" description: "The start of the period for which this transaction paid interest." } } } internal_source: { type: "object" description: "A Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`." required: ["amount", "currency", "reason"] properties: { amount: { type: "integer" description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents." } currency: { type: "string" description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency." enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] } reason: { type: "string" enum: ["bank_migration", "cashback", "empyreal_adjustment", "error", "error_correction", "fees", "interest", "sample_funds", "sample_funds_return"] } } } sample_funds: { type: "object" description: "A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`." required: ["originator"] properties: { originator: { type: "string" description: "Where the sample funds came from." } } } wire_drawdown_payment_intention: { type: "object" description: "A Wire Drawdown Payment Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_intention`." required: ["account_number", "amount", "message_to_recipient", "routing_number", "transfer_id"] properties: { account_number: { type: "string" } amount: { type: "integer" description: "The transfer amount in USD cents." } message_to_recipient: { type: "string" } routing_number: { type: "string" } transfer_id: { type: "string" } } } wire_drawdown_payment_rejection: { type: "object" description: "A Wire Drawdown Payment Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_rejection`." required: ["transfer_id"] properties: { transfer_id: { type: "string" } } } wire_transfer_intention: { type: "object" description: "A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`." required: ["account_number", "amount", "message_to_recipient", "routing_number", "transfer_id"] properties: { account_number: { type: "string" description: "The destination account number." } amount: { type: "integer" description: "The transfer amount in USD cents." } message_to_recipient: { type: "string" description: "The message that will show on the recipient's bank statement." } routing_number: { type: "string" description: "The American Bankers' Association (ABA) Routing Transit Number (RTN)." } transfer_id: { type: "string" } } } wire_transfer_rejection: { type: "object" description: "A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`." required: ["transfer_id"] properties: { transfer_id: { type: "string" } } } } } type: { type: "string" description: "A constant representing the object's type. For this resource it will always be `transaction`." enum: ["transaction"] } } } }