Private API Reference

Hold Harmless Letters

A Hold Harmless Letter is sent to the receiving bank of one or more credit transfers to request the return of funds.

The Hold Harmless Letter object

{
  "ach_transfers": [
    {
      "id": "ach_transfer_uoxatyh3lt5evrsdvo7q"
    }
  ],
  "cancellation": null,
  "created_at": "2020-01-31T23:59:59Z",
  "id": "hold_harmless_letter_request_40r4hibgywrrd4mnysb4",
  "idempotency_key": null,
  "indemnified_bank_customer_name": "Ian Crease",
  "real_time_payments_transfers": null,
  "reason": "fraudulent",
  "recovery_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "source_account_id": "account_in71c4amph0vgo2qllky",
  "status": "submitted",
  "submission": {
    "file_id": "file_makxrc67oh9l6sg7w9yc",
    "submitted_at": "2020-01-31T23:59:59Z"
  },
  "type": "hold_harmless_letter",
  "wire_transfers": null
}

Attributes

ach_transfers

array

Nullable

The ACH Transfers associated with the request.

cancellation

dictionary

Nullable

If the Hold Harmless Letter was canceled, details of the cancellation.

created_at

string

The ISO 8601 date and time at which the Hold Harmless Letter was created.

string

The Hold Harmless Letter identifier.

idempotency_key

string

Nullable

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.

indemnified_bank_customer_name

string

The name of the customer of the receiving bank.

real_time_payments_transfers

array

Nullable

The Real-Time Payments Transfers associated with the request.

reason

enum

The reason provided in the return of funds request.

recovery_account_number_id

string

Nullable

The Account Number created to receive recovered funds when they are transferred from your partner bank.

More about Account Numbers.

source_account_id

string

The Account the referenced transfers were originated from.

More about Accounts.

status

enum

The status of the Hold Harmless Letter.

submission

dictionary

Nullable

If the Hold Harmless Letter was submitted to the indemnified bank, details of the submission.

type

string

A constant representing the object’s type. For this resource it will always be hold_harmless_letter.

wire_transfers

array

Nullable

The Wire Transfers associated with the request.

List Hold Harmless Letters

curl \
  --url "${INCREASE_URL}/hold_harmless_letters" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response:

{
  "data": [
    { /* Hold Harmless Letter object */ },
    { /* Hold Harmless Letter object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters

More parameters

Create a Hold Harmless Letter

curl -X "POST" \
  --url "${INCREASE_URL}/hold_harmless_letters" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "ach_transfers": [
      {
        "id": "ach_transfer_uoxatyh3lt5evrsdvo7q"
      }
    ],
    "indemnified_bank_customer_name": "National Phonograph Company",
    "reason": "fraudulent",
    "recovery_account_number_id": "account_number_v18nkfqm6afpsrvy82b2"
  }'

Parameters

ach_transfers

array

The ACH Transfers to request the return of funds for. All transfers must originate from the same Account and have been received by the same counterparty.

indemnified_bank_customer_name

string

Required

The name of the customer of the receiving bank.

Between 1 and 200 characters

real_time_payments_transfers

array

The Real-Time Payments Transfers to request the return of funds for. All transfers must originate from the same Account and have been received by the same counterparty.

reason

enum

Required

The reason provided in the return of funds request.

recovery_account_number_id

string

Required

The identifier of the Account Number that will receive any recovered funds not returned directly to the originating Account.

More about Account Numbers.

wire_transfers

array

The Wire Transfers to request the return of funds for. All transfers must originate from the same Account and have been received by the same counterparty.

Retrieve a Hold Harmless Letter

curl \
  --url "${INCREASE_URL}/hold_harmless_letters/hold_harmless_letter_request_40r4hibgywrrd4mnysb4" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

hold_harmless_letter_id

string

Required

The identifier of the Hold Harmless Letter.