---
title: "Get contracts for a Merchant"
method: GET
path: "/merchants/{merchant_id}/contracts"
tags: ["Contracts"]
---

# Get contracts for a Merchant

`GET /merchants/{merchant_id}/contracts`

Called by the Independent Software Vendor. Returns all contracts of a Merchant.

## Path parameters

- `merchant_id` string, required

## Query parameters

- `page_size` integer
- `page_number` integer

## Headers

- `Authorization` string, api_id:api_token, required
- `Accept` string, required
- `Content-Type` string, required

## Response `200`

Success

- object
  - `contracts` Contract[]
    - `customer_id` string — Customer identifier associated to a transaction
    - `bill_amount` string — Sets the monetary amount to charge on each cycle. This is NOT the "initial" charge or "setup" charge, this is only the "recurring" charge. Described in USD up to 6 decimals, its last 4 digits must be 0. (e.g. "1", "1.00", "1.01", "1.2", "1.230000").
    - `status` 'enabled' | 'disabled' | 'completed' — Description of contract status.
    - `start_date` string — Date formatted as YYYYMMDD.
    - `end_date` string — Date formatted as YYYYMMDD. The end_date is the next day after the last installment. For example if last installment was on 20210305 then the end_date will be 20210306. For a contract with unlimited number of installments the end_date will be `"none"`.
    - `schedule` string — Frequency of recurring billing schedule. Allowed values - `"daily"`,`"weekly"`,`"bi-weekly"`,`"monthly"`,`"bi-monthly"`,`"quarterly"`,`"bi-annually"`,`"annually"`.
    - `num_left` string — Number of transactions remaining in recurring billing cycle. When a contract is completed, the num_left will be returned as `0` When the contract is created with unlimited number of installments, the num_left will be returned as `*`
  - `pagination` object
    - `current_page_number` integer — The number of the returned page with contracts.
    - `page_size` integer — The number of contracts returned on the current page.
    - `total_record_count` integer — The total number of contracts for the requested merchant.
  - `v` string — The API version that was used to handle the request.

## Other responses

- `4XX` — Possible errors - 1, 6, 189, 304, 305, 307, 309, 310, 311, 312
- `5XX` — Possible errors - 8

---

[API](https://skmtc.net/bankofamerica/apis/transaction-broker-api.md) · [All operations](https://skmtc.net/bankofamerica/apis/transaction-broker-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bankofamerica/transaction-broker-api/revisions/6097bc689e41/schema)