---
title: "Create a Batch Settlement Schedule"
method: POST
path: "/customers/{customerID}/batch_settlement_schedules"
tags: ["Batch Settlements"]
deprecated: true
---

# Create a Batch Settlement Schedule

`POST /customers/{customerID}/batch_settlement_schedules`

> **Deprecated.**

Creates a Batch Settlement Schedule that can be used as the destination of a liquidation address.

## Path parameters

- `customerID` string, required — A UUID that uniquely identifies a resource

## Headers

- `Idempotency-Key` string, required

## Request body

- CreateBatchSettlementSchedule
  - `destination` TransferDestination, required
    - `currency` 'brl' | 'cop' | 'eur' | 'eurc' | 'gbp' | 'mxn' | 'pyusd' | 'usd' | 'usdb' | 'usdc' | 'usdt', required
    - `payment_rail` 'ach' | 'wire' | 'ach_push' | 'ach_same_day' | 'arbitrum' | 'avalanche_c_chain' | 'base' | 'bre_b' | 'co_bank_transfer' | 'celo' | 'ethereum' | 'fiat_deposit_return' | 'optimism' | 'polygon' | 'sepa' | 'solana' | 'spei' | 'stellar' | 'swift' | 'tempo' | 'tron', required
    - `external_account_id` string — A UUID that uniquely identifies a resource
    - `bridge_wallet_id` string — A UUID that uniquely identifies a resource
    - `omad` string — (Wire only) The OMAD of a wire transfer, if available
    - `imad` string — (Wire only) The IMAD of a wire transfer, if available
    - `trace_number` string — The trace number of an ACH transfer
    - `end_to_end_id` string — The end-to-end ID of the FedNow transaction, assigned by the sending bank, and is not guaranteed to be unique across payments.
    - `wire_message` string — A message to be sent with a wire transfer. It can have up to 140 characters. This message will be validated against 4 lines, each with a max length of 35 characters according to the Fedwire standard.
    - `sepa_reference` string — A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are `a-z`, `A-Z`, `0-9`, spaces, ampersand (`&`), hyphen (`-`), full stop (`.`), and solidus (`/`). If not populated, the default value is "Payment via Bridge {unique_token}".
    - `swift_reference` string — A payment reference message or remittance information to be included in a SWIFT transaction. It can have at most 4 lines (separated by "\n"), each line with a max length of 35 chars. The allowed characters are `a-z`, `A-Z`, `0-9`, special characters (`/` `-` `?` `:` `(` `)` `.` `,` `'` `+`), and space
    - `spei_reference` string — A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric `a-z`, `A-Z`, `0-9`, and space
    - `reference` union — A payment reference message for newer payment rails (e.g. Pix and Faster Payments).
      - string
      - string
    - `swift_charges` 'our' | 'sha' | 'ben' — **Deprecated**: this schema is the type of the deprecated `swift_charges` field and will be removed in a future release. Prefer `charge_bearer`, which is typed by `ChargeBearer`. Which party bears the SWIFT transaction charges (MT 103 field 71A). - `our`: the sender (ordering customer) pays all charges. - `sha`: charges are shared — the sender pays their own bank's charges; intermediary/beneficiary bank charges are deducted from the transferred amount. - `ben`: the receiver (beneficiary) pays all charges, deducted from the transferred amount.
    - `charge_bearer` 'our' | 'sha' | 'ben' — Which party bears the SWIFT transaction charges. - `our`: the sender (ordering customer) pays all charges. - `sha`: charges are shared — the sender pays their own bank's charges; intermediary/beneficiary bank charges are deducted from the transferred amount. - `ben`: the receiver (beneficiary) pays all charges, deducted from the transferred amount.
    - `ach_reference` string — A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces.
    - `uetr` string — Deprecated: use tracking_number instead. The unique end-to-end transaction reference, for tracing purposes.
    - `blockchain_memo` string — The memo to include when sending funds on chain. Only allowed for blockchains that support memos such as Stellar
    - `deposit_id` string — A UUID that uniquely identifies a deposit
    - `tracking_number` string — The primary tracking identifier for this fiat transaction. Format varies by payment rail (e.g., UETR for SEPA/FPS, clave de rastreo for SPEI, end-to-end ID for PIX).
    - `transaction_id` string — Deprecated: use tracking_number instead. The unique transaction identifier for this payment.
    - `sending_institution_name` string — The name of the institution sending the funds

## Response `200`

Batch Settlement Schedule object created

- object
  - `id` string, required — A UUID that uniquely identifies a resource

## Other responses

- `400` — Request containing missing or invalid parameters.
- `401` — Missing or invalid API key
- `500` — Unexpected error. User may try and send the request again.

---

[API](https://skmtc.net/bridge/apis/bridge-api.md) · [All operations](https://skmtc.net/bridge/apis/bridge-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bridge/bridge-api/revisions/570998bde3b5/schema)