latestOpenAPI 3.0.22026-08-21530310.0 KB

54f4fe726d8f

Customers

Archive a Customer

Archiving a Customer refunds any remaining balance, closes all of their active Synthetic and Custodial Accounts and closes their Debit Cards. This process can take up to 8 business days to complete as the Transfers take place.

When archiving a customer, you can prevent them from reapplying to your program by setting can_apply_again to false. If you do not set any value, can_apply_again defaults to true.

When a request to archive a Customer is first received, the customer status will update to pending_archival and their accounts will be locked. When the archival process is complete, their customer status will update to archived. For a customer to move to the archived status, they must carry a $0 balance and have no pending transactions.

If the Customer has a positive balance across any accounts and a connected external account, Newline will initiate an ACH transfer to zero out the account balance and move the customer to the archived status.

If the Customer does not have an external account or the ACH transfer fails, Newline will mail a paper check to the Customer address on file to zero out the account balance and move the customer to the archived status.

If the Customer has a negative balance across any accounts, the negative account balances must be brought up to or greater than $0.00 before the archival workflow can continue.

Once archived, a Customer's records will still be available for historical purposes (according to the bank’s record retention schedule), but they will not be able to open any new Accounts. The Customer can still apply again as long as can_apply_again is not set to false.

delete/customers/{uid}

Parameters

#/paths/~1auth/parameters/0 — unresolved $ref

Request body

archive_notestring nullable
can_apply_againboolean nullable
destination_synthetic_account_uidstring

UID of an active external Synthetic Account to which the Customer's funds should be sent, if any. Required if the Customer has multiple active external Synthetic Accounts.

Example request

{
  "archive_note": "for inactivity",
  "destination_synthetic_account_uid": "oBASVwLQB4RojU5X"
}

Response

Customer has begun the archive process.

Schema required— unresolved $ref