Create a new payments Vendor | Ottimate Developer Documentation

curl -X POST https://api.ottimate.com/v1/payments/vendor \
     -H "X-Api-Key: your-api-key-here" \
     -H "X-API-Version: 1.0.0" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Example",
  "erp_vendor_id": "EXAMPLE-VENDOR-1",
  "ottimate_company_id": "1234",
  "invite_electronic_payments": true,
  "estimated_monthly_volume": 1000,
  "email": "Example",
  "contact_name": "Example",
  "phone_number": "+1 (999) 888-7777",
  "address_line_1": "123 Test St.",
  "address_line_2": "Suite 1",
  "city": "Test Town",
  "state": "NY",
  "zipcode": "55555",
  "country": "US",
  "care_of": "Example",
  "admin_email": "admin.email@example.com",
  "admin_phone": "+1 (999) 888-7777",
  "admin_name": "Admin Name"
}'

Create a new accounting vendor for use in payments.

Authentication

AuthorizationBearer

OAuth2 authentication flows. Auth server URLs will vary by environment

Headers

Idempotency-KeystringOptionalformat: "^[A-Za-z0-9._\-+=/]{1,128}$"1-128 characters

Client-generated unique key (UUID/ULID recommended). JSON requests: the first 2xx response is cached for 24h and replayed on a same-key retry with a matching body; a different body returns 422. Non-JSON requests (e.g. file uploads): the key is single-use — any same-key retry returns 422 regardless of body. See Idempotency for full details.

Request

namestringOptional

The vendor's business name.

erp_vendor_idstringOptional

The vendor's unique identifier in your ERP system.

ottimate_company_idstringOptional

The Ottimate company ID to associate this vendor with.

invite_electronic_paymentsbooleanOptional

Whether Ottimate should invite this vendor to enroll in electronic payments.

estimated_monthly_volumeintegerOptional

Estimated monthly payment volume to this vendor in dollars.

emailstringOptional

The vendor's primary email address.

contact_namestringOptional

The vendor's primary contact name.

phone_numberstringOptional

The vendor's primary phone number.

address_line_1stringOptional

The first line of the vendor's mailing address.

address_line_2stringOptional

The second line of the vendor's mailing address.

citystringOptional

The city of the vendor's mailing address.

statestringOptional

The two-letter state code of the vendor’s mailing address.

zipcodestringOptional

The ZIP code of the vendor's mailing address.

countrystringOptional

The two-letter ISO country code of the vendor’s mailing address.

care_ofstringOptional

The care-of name for the vendor’s mailing address.

admin_emailstringOptional

The email address of the vendor's admin contact.

admin_phonestringOptional

The phone number of the vendor's admin contact.

admin_namestringOptional

The name of the vendor's admin contact.

Response

Successfully created

idstring

The unique identifier of the newly created vendor.

Errors

400

Bad Request Error

1	{
2	"id": "1234"
3	}