---
title: "Get Pay Run Payable Schema"
method: GET
path: "/pay-runs/payables/schema"
tags: ["Pay Runs"]
---

# Get Pay Run Payable Schema

`GET /pay-runs/payables/schema`

Creates the payable JSON schema for the requested country and currency.

## Query parameters

- `Country` string, required — The country of the beneficiary's bank account. This is an ISO 3166-1 alpha-2 code.
- `Currency` string, required — The currency of the beneficiary's bank account. This is an ISO 4217:2015 Alpha-3 currency code.

## Headers

- `Crezco-Version` string

## Response `200`

OK

- PayableJsonSchemaVersion4
  - `type` string
  - `title` string, required — A Human readable title of the schema.
  - `description` string, required — A Human readable description of the schema.
  - `properties` object, required — The properties of the schema.
  - `required` string[], required — The required properties of the schema.
  - `$defs` PayableJsonSchemaDefinitionsVersion4, required
    - `beneficiary` PayableBeneficiaryJsonSchemaDefinitionVersion4, required
      - `type` string
      - `oneOf` JsonObjectSchemaVersion4[], required — Possible schemas for the beneficiary of the payable.
        - `type` string
        - `title` string, required — A Human readable title of the schema.
        - `description` string, required — A Human readable description of the schema.
        - `properties` object, required — The properties of the schema.
        - `required` string[], required — The required properties of the schema.
    - `beneficiaryAddress` JsonObjectSchemaVersion4, required
      - `type` string
      - `title` string, required — A Human readable title of the schema.
      - `description` string, required — A Human readable description of the schema.
      - `properties` object, required — The properties of the schema.
      - `required` string[], required — The required properties of the schema.
    - `bankAccount` PayableBeneficiaryBankAccountJsonSchemaDefinitionVersion4, required
      - `type` string
      - `oneOf` JsonObjectSchemaVersion4[], required — Possible schemas for the beneficiaries bank account of the payable.
        - `type` string
        - `title` string, required — A Human readable title of the schema.
        - `description` string, required — A Human readable description of the schema.
        - `properties` object, required — The properties of the schema.
        - `required` string[], required — The required properties of the schema.
    - `purposeCode` PayablePurposeCodeJsonSchemaDefinitionVersion4, required
      - `title` string — A Human readable title of the schema.
      - `description` string — A Human readable description of the schema.
      - `oneOf` JsonPurposeCodeSchemaConstVersion4[], required — Possible schemas for purpose codes.
        - `const` string, nullable, required — Value for the purpose code.
        - `title` string, nullable, required — The title of the purpose code.
      - `not` PayableNotPurposeCodeJsonSchemaVersion4, required
        - `anyOf` JsonPurposeCodeSchemaConstVersion4[], required — Purpose code schemas that are not allowed.
          - `const` string, nullable, required — Value for the purpose code.
          - `title` string, nullable, required — The title of the purpose code.

## Other responses

- `401` — You do not have access. Check your API key is correct.
- `403` — You do not have access to this organisation.
- `406` — The version of the API that you requested is not available. Check your Crezco-Version header. If you omit this header you will use the latest version of the API.
- `429` — You have made too many requests to the API in too short a period. Wait a while and try again.

---

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