Increase.CheckTransfers.CheckTransfer.PhysicalCheck (Increase v1.0.0)

Copy Markdown View Source

Details relating to the physical check that Increase will print and mail. Will be present if and only if fulfillment_method is equal to physical_check.

Fields

  • attachment_file_id - The ID of the file for the check attachment.
  • check_voucher_image_file_id - The ID of the file for the check voucher image.
  • mailing_address - Details for where Increase will mail the check.
  • memo - The descriptor that will be printed on the memo field on the check.
  • note - The descriptor that will be printed on the letter included with the check.
  • payer - The payer of the check. This will be printed on the top-left portion of the check and defaults to the return address if unspecified.
  • recipient_name - The name that will be printed on the check.
  • return_address - The return address to be printed on the check.
  • shipping_method - The shipping method for the check.
  • signature - The signature that will appear on the check.
  • tracking_updates - Tracking updates relating to the physical check's delivery.

Summary

Types

t()

@type t() :: %Increase.CheckTransfers.CheckTransfer.PhysicalCheck{
  attachment_file_id: String.t() | nil,
  check_voucher_image_file_id: String.t() | nil,
  mailing_address:
    Increase.CheckTransfers.CheckTransfer.PhysicalCheck.MailingAddress.t(),
  memo: String.t() | nil,
  note: String.t() | nil,
  payer: [Increase.CheckTransfers.CheckTransfer.PhysicalCheck.Payer.t()],
  recipient_name: String.t(),
  return_address:
    Increase.CheckTransfers.CheckTransfer.PhysicalCheck.ReturnAddress.t() | nil,
  shipping_method: String.t(),
  signature: Increase.CheckTransfers.CheckTransfer.PhysicalCheck.Signature.t(),
  tracking_updates: [
    Increase.CheckTransfers.CheckTransfer.PhysicalCheck.TrackingUpdate.t()
  ]
}