Increase.WireDrawdownRequests.WireDrawdownRequest (Increase v1.0.0)

Copy Markdown View Source

Wire drawdown requests enable you to request that someone else send you a wire. Because there is nuance to making sure your counterparty's bank processes these correctly, we ask that you reach out to support@increase.com to enable this feature so we can help you plan your integration. For more information, see our [Wire Drawdown Requests documentation].

Fields

  • id - The Wire drawdown request identifier.
  • account_number_id - The Account Number to which the debtor—the recipient of this request—is being requested to send funds.
  • amount - The amount being requested in cents.
  • created_at - The ISO 8601 date and time at which the wire drawdown request was created.
  • creditor_address - The creditor's address.
  • creditor_name - The creditor's name.
  • currency - The ISO 4217 code for the amount being requested. Will always be "USD".
  • debtor_account_number - The debtor's account number.
  • debtor_address - The debtor's address.
  • debtor_external_account_id - The debtor's external account identifier.
  • debtor_name - The debtor's name.
  • debtor_routing_number - The debtor's routing number.
  • end_to_end_identification - A free-form reference string set by the sender, to be mirrored back in the subsequent wire transfer.
  • fulfillment_inbound_wire_transfer_id - If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction.
  • idempotency_key - The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
  • status - The lifecycle status of the drawdown request.
  • submission - After the drawdown request is submitted to Fedwire, this will contain supplemental details.
  • type - A constant representing the object's type. For this resource it will always be wire_drawdown_request.
  • unique_end_to_end_transaction_reference - The unique end-to-end transaction reference (UETR) of the drawdown request.
  • unstructured_remittance_information - Remittance information the debtor will see as part of the drawdown request.

Summary

Types

t()

Types

t()

@type t() :: %Increase.WireDrawdownRequests.WireDrawdownRequest{
  account_number_id: String.t(),
  amount: integer(),
  created_at: DateTime.t(),
  creditor_address:
    Increase.WireDrawdownRequests.WireDrawdownRequest.CreditorAddress.t(),
  creditor_name: String.t(),
  currency: String.t(),
  debtor_account_number: String.t(),
  debtor_address:
    Increase.WireDrawdownRequests.WireDrawdownRequest.DebtorAddress.t(),
  debtor_external_account_id: String.t() | nil,
  debtor_name: String.t(),
  debtor_routing_number: String.t(),
  end_to_end_identification: String.t() | nil,
  fulfillment_inbound_wire_transfer_id: String.t() | nil,
  id: String.t(),
  idempotency_key: String.t() | nil,
  status: String.t(),
  submission:
    Increase.WireDrawdownRequests.WireDrawdownRequest.Submission.t() | nil,
  type: String.t(),
  unique_end_to_end_transaction_reference: String.t() | nil,
  unstructured_remittance_information: String.t()
}