Retrieve a Pending Transaction

{
  "type": "object",
  "description": "Pending Transactions are potential future additions and removals of money from your bank account.",
  "required": [
    "account_id",
    "amount",
    "created_at",
    "currency",
    "description",
    "id",
    "route_id",
    "route_type",
    "source",
    "status",
    "type"
  ],
  "properties": {
    "account_id": {
      "type": "string",
      "description": "The identifier for the account this Pending Transaction belongs to."
    },
    "amount": {
      "type": "integer",
      "description": "The Pending 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 Pending Transaction occured."
    },
    "currency": {
      "type": "string",
      "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending Transaction's currency. This will match the currency on the Pending Transcation's Account.",
      "enum": [
        "CAD",
        "CHF",
        "EUR",
        "GBP",
        "JPY",
        "USD"
      ]
    },
    "description": {
      "type": "string",
      "description": "For a Pending Transaction related to a transfer, this is the description you provide. For a Pending Transaction related to a payment, this is the description the vendor provides."
    },
    "id": {
      "type": "string",
      "description": "The Pending Transaction identifier."
    },
    "route_id": {
      "type": "string",
      "description": "The identifier for the route this Pending Transaction came through. Routes are things like cards and ACH details."
    },
    "route_type": {
      "type": "string",
      "description": "The type of the route this Pending Transaction came through."
    },
    "source": {
      "type": "object",
      "description": "This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location.",
      "required": [
        "account_transfer_instruction",
        "ach_transfer_instruction",
        "card_authorization",
        "card_route_authorization",
        "category",
        "check_deposit_instruction",
        "check_transfer_instruction",
        "inbound_funds_hold",
        "wire_drawdown_payment_instruction",
        "wire_transfer_instruction"
      ],
      "properties": {
        "account_transfer_instruction": {
          "type": "object",
          "description": "A Account Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_instruction`.",
          "required": [
            "amount",
            "currency",
            "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"
              ]
            },
            "transfer_id": {
              "type": "string",
              "description": "The identifier of the Account Transfer that led to this Pending Transaction."
            }
          }
        },
        "ach_transfer_instruction": {
          "type": "object",
          "description": "A ACH Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_instruction`.",
          "required": [
            "amount",
            "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."
            },
            "transfer_id": {
              "type": "string",
              "description": "The identifier of the ACH Transfer that led to this Pending Transaction."
            }
          }
        },
        "card_authorization": {
          "type": "object",
          "description": "A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`.",
          "required": [
            "amount",
            "currency",
            "digital_wallet_token_id",
            "merchant_acceptor_id",
            "merchant_category_code",
            "merchant_city",
            "merchant_country",
            "merchant_descriptor",
            "network",
            "network_details",
            "real_time_decision_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 transaction's currency.",
              "enum": [
                "CAD",
                "CHF",
                "EUR",
                "GBP",
                "JPY",
                "USD"
              ]
            },
            "digital_wallet_token_id": {
              "type": "string",
              "description": "If the authorization was made via 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."
            },
            "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."
            }
          }
        },
        "card_route_authorization": {
          "type": "object",
          "description": "A Deprecated Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_route_authorization`.",
          "required": [
            "amount",
            "currency",
            "merchant_acceptor_id",
            "merchant_category_code",
            "merchant_city",
            "merchant_country",
            "merchant_descriptor",
            "merchant_state"
          ],
          "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 transaction's 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 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_instruction",
            "ach_transfer_instruction",
            "card_authorization",
            "check_deposit_instruction",
            "check_transfer_instruction",
            "inbound_funds_hold",
            "card_route_authorization",
            "real_time_payments_transfer_instruction",
            "wire_drawdown_payment_instruction",
            "wire_transfer_instruction",
            "other"
          ]
        },
        "check_deposit_instruction": {
          "type": "object",
          "description": "A Check Deposit Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_instruction`.",
          "required": [
            "amount",
            "back_image_file_id",
            "check_deposit_id",
            "currency",
            "front_image_file_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."
            },
            "back_image_file_id": {
              "type": "string",
              "description": "The identifier of the File containing the image of the back of the check that was deposited."
            },
            "check_deposit_id": {
              "type": "string",
              "description": "The identifier of the Check Deposit."
            },
            "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"
              ]
            },
            "front_image_file_id": {
              "type": "string",
              "description": "The identifier of the File containing the image of the front of the check that was deposited."
            }
          }
        },
        "check_transfer_instruction": {
          "type": "object",
          "description": "A Check Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_instruction`.",
          "required": [
            "amount",
            "currency",
            "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 check's currency.",
              "enum": [
                "CAD",
                "CHF",
                "EUR",
                "GBP",
                "JPY",
                "USD"
              ]
            },
            "transfer_id": {
              "type": "string",
              "description": "The identifier of the Check Transfer that led to this Pending Transaction."
            }
          }
        },
        "inbound_funds_hold": {
          "type": "object",
          "description": "A Inbound Funds Hold object. This field will be present in the JSON response if and only if `category` is equal to `inbound_funds_hold`.",
          "required": [
            "amount",
            "automatically_releases_at",
            "currency",
            "held_transaction_id",
            "released_at",
            "status"
          ],
          "properties": {
            "amount": {
              "type": "integer",
              "description": "The held amount in the minor unit of the account's currency. For dollars, for example, this is cents."
            },
            "automatically_releases_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the hold will be released automatically. Certain conditions may cause it to be released before this time."
            },
            "currency": {
              "type": "string",
              "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency.",
              "enum": [
                "CAD",
                "CHF",
                "EUR",
                "GBP",
                "JPY",
                "USD"
              ]
            },
            "held_transaction_id": {
              "type": "string",
              "description": "The ID of the Transaction for which funds were held."
            },
            "released_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the hold was released (if it has been released)."
            },
            "status": {
              "type": "string",
              "description": "The status of the hold.",
              "enum": [
                "held",
                "complete"
              ]
            }
          }
        },
        "wire_drawdown_payment_instruction": {
          "type": "object",
          "description": "A Wire Drawdown Payment Instruction object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_instruction`.",
          "required": [
            "account_number",
            "amount",
            "message_to_recipient",
            "routing_number"
          ],
          "properties": {
            "account_number": {
              "type": "string"
            },
            "amount": {
              "type": "integer",
              "description": "The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
            },
            "message_to_recipient": {
              "type": "string"
            },
            "routing_number": {
              "type": "string"
            }
          }
        },
        "wire_transfer_instruction": {
          "type": "object",
          "description": "A Wire Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_instruction`.",
          "required": [
            "account_number",
            "amount",
            "message_to_recipient",
            "routing_number",
            "transfer_id"
          ],
          "properties": {
            "account_number": {
              "type": "string"
            },
            "amount": {
              "type": "integer",
              "description": "The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
            },
            "message_to_recipient": {
              "type": "string"
            },
            "routing_number": {
              "type": "string"
            },
            "transfer_id": {
              "type": "string"
            }
          }
        }
      }
    },
    "status": {
      "type": "string",
      "description": "Whether the Pending Transaction has been confirmed and has an associated Transaction.",
      "enum": [
        "pending",
        "complete"
      ]
    },
    "type": {
      "type": "string",
      "description": "A constant representing the object's type. For this resource it will always be `pending_transaction`.",
      "enum": [
        "pending_transaction"
      ]
    }
  }
}