Retrieve a Declined Transaction

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "declined_transaction_id": {
      "type": "string",
      "description": "The identifier of the Declined Transaction."
    }
  },
  "required": [
    "declined_transaction_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.",
  "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 Declined Transaction belongs to."
    },
    "amount": {
      "type": "integer",
      "description": "The Declined 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 Declined Transaction's currency. This will match the currency on the Declined Transcation's Account.",
      "enum": [
        "CAD",
        "CHF",
        "EUR",
        "GBP",
        "JPY",
        "USD"
      ]
    },
    "description": {
      "type": "string",
      "description": "This is the description the vendor provides."
    },
    "id": {
      "type": "string",
      "description": "The Declined Transaction identifier."
    },
    "route_id": {
      "type": "string",
      "description": "The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details."
    },
    "route_type": {
      "type": "string",
      "description": "The type of the route this Declined Transaction came through."
    },
    "source": {
      "type": "object",
      "description": "This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. 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": [
        "ach_decline",
        "card_decline",
        "card_route_decline",
        "category",
        "check_decline",
        "inbound_real_time_payments_transfer_decline",
        "international_ach_decline"
      ],
      "properties": {
        "ach_decline": {
          "type": "object",
          "description": "A ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.",
          "required": [
            "amount",
            "originator_company_descriptive_date",
            "originator_company_discretionary_data",
            "originator_company_id",
            "originator_company_name",
            "reason",
            "receiver_id_number",
            "receiver_name",
            "trace_number"
          ],
          "properties": {
            "amount": {
              "type": "integer",
              "description": "The declined 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_id": {
              "type": "string"
            },
            "originator_company_name": {
              "type": "string"
            },
            "reason": {
              "type": "string",
              "description": "Why the ACH transfer was declined.",
              "enum": [
                "ach_route_canceled",
                "ach_route_disabled",
                "breaches_limit",
                "credit_entry_refused_by_receiver",
                "duplicate_return",
                "entity_not_active",
                "transaction_not_allowed",
                "group_locked",
                "insufficient_funds",
                "no_ach_route",
                "originator_request"
              ]
            },
            "receiver_id_number": {
              "type": "string"
            },
            "receiver_name": {
              "type": "string"
            },
            "trace_number": {
              "type": "string"
            }
          }
        },
        "card_decline": {
          "type": "object",
          "description": "A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.",
          "required": [
            "amount",
            "currency",
            "digital_wallet_token_id",
            "merchant_acceptor_id",
            "merchant_category_code",
            "merchant_city",
            "merchant_country",
            "merchant_descriptor",
            "merchant_state",
            "network",
            "network_details",
            "real_time_decision_id",
            "reason"
          ],
          "properties": {
            "amount": {
              "type": "integer",
              "description": "The declined amount in the minor unit of the destination account 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"
              ]
            },
            "digital_wallet_token_id": {
              "type": "string",
              "description": "If the authorization was attempted using a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used."
            },
            "merchant_acceptor_id": {
              "type": "string",
              "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with."
            },
            "merchant_category_code": {
              "type": "string",
              "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with."
            },
            "merchant_city": {
              "type": "string",
              "description": "The city the merchant resides in."
            },
            "merchant_country": {
              "type": "string",
              "description": "The country the merchant resides in."
            },
            "merchant_descriptor": {
              "type": "string",
              "description": "The merchant descriptor of the merchant the card is transacting with."
            },
            "merchant_state": {
              "type": "string",
              "description": "The state the merchant resides in."
            },
            "network": {
              "type": "string",
              "description": "The payment network used to process this card authorization",
              "enum": [
                "visa"
              ]
            },
            "network_details": {
              "type": "object",
              "description": "Fields specific to the `network`",
              "required": [
                "visa"
              ],
              "properties": {
                "visa": {
                  "type": "object",
                  "description": "Fields specific to the `visa` network",
                  "required": [
                    "electronic_commerce_indicator",
                    "point_of_service_entry_mode"
                  ],
                  "properties": {
                    "electronic_commerce_indicator": {
                      "type": "string",
                      "description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.",
                      "enum": [
                        "mail_phone_order",
                        "recurring",
                        "installment",
                        "unknown_mail_phone_order",
                        "secure_electronic_commerce",
                        "non_authenticated_security_transaction_at_3ds_capable_merchant",
                        "non_authenticated_security_transaction",
                        "non_secure_transaction"
                      ]
                    },
                    "point_of_service_entry_mode": {
                      "type": "string",
                      "description": "The method used to enter the cardholder's primary account number and card expiration date",
                      "enum": [
                        "manual",
                        "magnetic_stripe_no_cvv",
                        "optical_code",
                        "integrated_circuit_card",
                        "contactless",
                        "credential_on_file",
                        "magnetic_stripe",
                        "contactless_magnetic_stripe",
                        "integrated_circuit_card_no_cvv"
                      ]
                    }
                  }
                }
              }
            },
            "real_time_decision_id": {
              "type": "string",
              "description": "The identifier of the Real-Time Decision sent to approve or decline this transaction."
            },
            "reason": {
              "type": "string",
              "description": "Why the transaction was declined.",
              "enum": [
                "card_not_active",
                "entity_not_active",
                "group_locked",
                "insufficient_funds",
                "cvv2_mismatch",
                "transaction_not_allowed",
                "breaches_limit",
                "webhook_declined",
                "webhook_timed_out",
                "declined_by_stand_in_processing"
              ]
            }
          }
        },
        "card_route_decline": {
          "type": "object",
          "description": "A Deprecated Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_route_decline`.",
          "required": [
            "amount",
            "currency",
            "merchant_acceptor_id",
            "merchant_category_code",
            "merchant_city",
            "merchant_country",
            "merchant_descriptor",
            "merchant_state"
          ],
          "properties": {
            "amount": {
              "type": "integer",
              "description": "The declined amount in the minor unit of the destination account 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"
              ]
            },
            "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"
            }
          }
        },
        "category": {
          "type": "string",
          "description": "The type of decline 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": [
            "ach_decline",
            "card_decline",
            "check_decline",
            "inbound_real_time_payments_transfer_decline",
            "international_ach_decline",
            "card_route_decline",
            "other"
          ]
        },
        "check_decline": {
          "type": "object",
          "description": "A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.",
          "required": [
            "amount",
            "auxiliary_on_us",
            "reason"
          ],
          "properties": {
            "amount": {
              "type": "integer",
              "description": "The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
            },
            "auxiliary_on_us": {
              "type": "string"
            },
            "reason": {
              "type": "string",
              "description": "Why the check was declined.",
              "enum": [
                "ach_route_canceled",
                "ach_route_disabled",
                "breaches_limit",
                "entity_not_active",
                "group_locked",
                "insufficient_funds",
                "unable_to_locate_account",
                "unable_to_process",
                "refer_to_image",
                "stop_payment_requested",
                "returned"
              ]
            }
          }
        },
        "inbound_real_time_payments_transfer_decline": {
          "type": "object",
          "description": "A Inbound Real Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.",
          "required": [
            "amount",
            "creditor_name",
            "currency",
            "debtor_account_number",
            "debtor_name",
            "debtor_routing_number",
            "reason",
            "remittance_information",
            "transaction_identification"
          ],
          "properties": {
            "amount": {
              "type": "integer",
              "description": "The declined amount in the minor unit of the destination account 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 declined 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."
            },
            "reason": {
              "type": "string",
              "description": "Why the transfer was declined.",
              "enum": [
                "account_number_canceled",
                "account_number_disabled",
                "group_locked",
                "entity_not_active",
                "real_time_payments_not_enabled"
              ]
            },
            "remittance_information": {
              "type": "string",
              "description": "Additional information included with the transfer."
            },
            "transaction_identification": {
              "type": "string",
              "description": "The Real Time Payments network identification of the declined transfer."
            }
          }
        },
        "international_ach_decline": {
          "type": "object",
          "description": "A International ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `international_ach_decline`.",
          "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 declined 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"
            }
          }
        }
      }
    },
    "type": {
      "type": "string",
      "description": "A constant representing the object's type. For this resource it will always be `declined_transaction`.",
      "enum": [
        "declined_transaction"
      ]
    }
  }
}