Increase.LockboxRecipients.LockboxRecipient (Increase v1.0.0)

Copy Markdown View Source

Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for a Lockbox Recipient are deposited into its associated Account.

Fields

  • id - The Lockbox Recipient identifier.
  • account_id - The identifier for the Account that checks sent to this Lockbox Recipient will be deposited into.
  • created_at - The ISO 8601 time at which the Lockbox Recipient was created.
  • description - The description of the Lockbox Recipient.
  • 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.
  • lockbox_address_id - The identifier for the Lockbox Address where this Lockbox Recipient may receive physical mail.
  • mail_stop_code - The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox Address. It should be included in the mailing address intended for this Lockbox Recipient.
  • recipient_name - The name of the Lockbox Recipient.
  • status - The status of the Lockbox Recipient.
  • type - A constant representing the object's type. For this resource it will always be lockbox_recipient.

Summary

Types

t()

Types

t()

@type t() :: %Increase.LockboxRecipients.LockboxRecipient{
  account_id: String.t(),
  created_at: DateTime.t(),
  description: String.t() | nil,
  id: String.t(),
  idempotency_key: String.t() | nil,
  lockbox_address_id: String.t(),
  mail_stop_code: String.t(),
  recipient_name: String.t() | nil,
  status: String.t() | nil,
  type: String.t()
}