---
title: "Get vendor configuration"
method: GET
path: "/v3/vendors/{vendorId}/configuration"
tags: ["vendors"]
---

# Get vendor configuration

`GET /v3/vendors/{vendorId}/configuration`

Get international payments (not USD) configuration after vendor creation. This configuration is required for compliance with international payment rules of a vendor country and vendor bank account.

In the response, the required `paymentPurpose` and `regulatoryFields` information is retrieved for the vendor.

**Note**: If you are adding `paymentPurpose` and `regulatoryFields` information during international vendor creation, use `GET /v3/vendors/configuration/international-payments` to get the required configuration before vendor creation.

See [Create an international vendor](https://developer.bill.com/docs/creating-an-international-vendor) for more information on how to set `paymentPurpose` and `regulatoryFields`.

## Path parameters

- `vendorId` string, required — BILL-generated ID of the vendor. The value begins with `009`.

## Headers

- `sessionId` string, nullable — API session ID generated with `/v3/login`
- `devKey` string, nullable — Developer key generated with your BILL developer account

## Response `200`

Get vendor configuration response

- VendorConfigurationResponseDto — Vendor configuration response.
  - `internationalPayments` IntlPmtsConfigurationResponseDto — International payments configuration response.
    - `paymentPurpose` object — Payment purpose information
      - `required` boolean — Set as `true` if payment purpose information is required. If `required` is set as `false`, `paymentPurpose` information is not required in your create vendor or payment API request.
      - `type` 'CODE' | 'TEXT' — Payment purpose type. This field specifies whether the `text` field or `code` object is required in your `POST /v3/vendors` and `POST /v3/payments` API requests.
      - `codes` NameValue[] — Available payment purpose codes
        - `name` string — Name field
        - `value` string — Value field
    - `validations` object — International bank account regulatory fields information
      - `fields` Field[]
        - `name` string — Regulatory field name
        - `description` string — Regulatory field value description
        - `regularExpression` string — Regular expression that BILL uses to validate the regulatory field
        - `required` boolean — Set as `true` if the regulatory field is required

## Other responses

- `4XX` — List of errors.
- `5XX` — List of errors.

---

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