increase-test
POST/lockbox_recipients

Create a Lockbox Recipient

Creates a Lockbox Recipient inbox at a Lockbox Address and directs checks received there to an Account. Provide account_id and lockbox_address_id; the Lockbox Address must have an active status. You can also supply a recipient name and description, each limited to 200 characters.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Lockbox Recipient details, including the Account where received checks should be deposited and the Lockbox Address where mail may be received.

account_idstringrequired
The Account that checks sent to this Lockbox Recipient should be deposited into.
descriptionstringoptional
The description you choose for the Lockbox Recipient.
lockbox_address_idstringrequired
The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox Address must have a `status` of `active`.
recipient_namestringoptional
The name of the Lockbox Recipient.

3 status codes
200Returns the created Lockbox Recipient object, including its identifier, associated Account and Lockbox Address, recipient name, status, and mail stop code.
account_idstringrequired
The identifier for the Account that checks sent to this Lockbox Recipient will be deposited into.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox Recipient was created.
descriptionstringrequired
The description of the Lockbox Recipient.
idstringrequired
The Lockbox Recipient identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
lockbox_address_idstringrequired
The identifier for the Lockbox Address where this Lockbox Recipient may receive physical mail.
mail_stop_codestringrequired
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_namestringrequired
The name of the Lockbox Recipient.
statusstringrequired
The status of the Lockbox Recipient.
Allowed:activedisabledcanceled
typestringrequired
A constant representing the object's type. For this resource it will always be `lockbox_recipient`.
Allowed:lockbox_recipient
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when the request cannot be completed because of a server-side error.

Error handling

account_id and lockbox_address_id are required. The Lockbox Address identified by lockbox_address_id must have an active status; recipient_name and description, if provided, must each be 1 to 200 characters.