Create or update a payee by identifier

curl --request PUT \
  --url https://api.withacclaim.com/v1/payees/{identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "given_name": "John",
  "family_name": "Doe",
  "middle_name": "<string>",
  "company": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "entity_type": "Individual",
  "active": true,
  "identifier": "<string>",
  "preferred_language": "<string>",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  }
}
'

import requests

url = "https://api.withacclaim.com/v1/payees/{identifier}"

payload = {
    "given_name": "John",
    "family_name": "Doe",
    "middle_name": "<string>",
    "company": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "entity_type": "Individual",
    "active": True,
    "identifier": "<string>",
    "preferred_language": "<string>",
    "metadata": {
        "custom_field": "value",
        "source": "api"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    given_name: 'John',
    family_name: 'Doe',
    middle_name: '<string>',
    company: '<string>',
    name: '<string>',
    email: 'jsmith@example.com',
    phone: '<string>',
    entity_type: 'Individual',
    active: true,
    identifier: '<string>',
    preferred_language: '<string>',
    metadata: {custom_field: 'value', source: 'api'}
  })
};

fetch('https://api.withacclaim.com/v1/payees/{identifier}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withacclaim.com/v1/payees/{identifier}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'given_name' => 'John',
    'family_name' => 'Doe',
    'middle_name' => '<string>',
    'company' => '<string>',
    'name' => '<string>',
    'email' => 'jsmith@example.com',
    'phone' => '<string>',
    'entity_type' => 'Individual',
    'active' => true,
    'identifier' => '<string>',
    'preferred_language' => '<string>',
    'metadata' => [
        'custom_field' => 'value',
        'source' => 'api'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withacclaim.com/v1/payees/{identifier}"

	payload := strings.NewReader("{\n  \"given_name\": \"John\",\n  \"family_name\": \"Doe\",\n  \"middle_name\": \"<string>\",\n  \"company\": \"<string>\",\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"entity_type\": \"Individual\",\n  \"active\": true,\n  \"identifier\": \"<string>\",\n  \"preferred_language\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.withacclaim.com/v1/payees/{identifier}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"given_name\": \"John\",\n  \"family_name\": \"Doe\",\n  \"middle_name\": \"<string>\",\n  \"company\": \"<string>\",\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"entity_type\": \"Individual\",\n  \"active\": true,\n  \"identifier\": \"<string>\",\n  \"preferred_language\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withacclaim.com/v1/payees/{identifier}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"given_name\": \"John\",\n  \"family_name\": \"Doe\",\n  \"middle_name\": \"<string>\",\n  \"company\": \"<string>\",\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"entity_type\": \"Individual\",\n  \"active\": true,\n  \"identifier\": \"<string>\",\n  \"preferred_language\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "pyee_KfIuLz83Ya",
  "given_name": "John",
  "family_name": "Doe",
  "middle_name": "<string>",
  "name": "<string>",
  "identifier": "PYEE-2025-001",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "company": "<string>",
  "entity_type": "Individual",
  "address": {
    "country": "US",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001"
  },
  "active": true,
  "status": "Active",
  "preferred_language": "<string>",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "id": "pyee_KfIuLz83Ya",
  "given_name": "John",
  "family_name": "Doe",
  "middle_name": "<string>",
  "name": "<string>",
  "identifier": "PYEE-2025-001",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "company": "<string>",
  "entity_type": "Individual",
  "address": {
    "country": "US",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001"
  },
  "active": true,
  "status": "Active",
  "preferred_language": "<string>",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: amount",
    "details": {},
    "request_id": "req_7lYt4o2x"
  }
}

PUT

payees

{identifier}

Create or update a payee by identifier

curl --request PUT \
  --url https://api.withacclaim.com/v1/payees/{identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "given_name": "John",
  "family_name": "Doe",
  "middle_name": "<string>",
  "company": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "entity_type": "Individual",
  "active": true,
  "identifier": "<string>",
  "preferred_language": "<string>",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  }
}
'

import requests

url = "https://api.withacclaim.com/v1/payees/{identifier}"

payload = {
    "given_name": "John",
    "family_name": "Doe",
    "middle_name": "<string>",
    "company": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "entity_type": "Individual",
    "active": True,
    "identifier": "<string>",
    "preferred_language": "<string>",
    "metadata": {
        "custom_field": "value",
        "source": "api"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    given_name: 'John',
    family_name: 'Doe',
    middle_name: '<string>',
    company: '<string>',
    name: '<string>',
    email: 'jsmith@example.com',
    phone: '<string>',
    entity_type: 'Individual',
    active: true,
    identifier: '<string>',
    preferred_language: '<string>',
    metadata: {custom_field: 'value', source: 'api'}
  })
};

fetch('https://api.withacclaim.com/v1/payees/{identifier}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withacclaim.com/v1/payees/{identifier}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'given_name' => 'John',
    'family_name' => 'Doe',
    'middle_name' => '<string>',
    'company' => '<string>',
    'name' => '<string>',
    'email' => 'jsmith@example.com',
    'phone' => '<string>',
    'entity_type' => 'Individual',
    'active' => true,
    'identifier' => '<string>',
    'preferred_language' => '<string>',
    'metadata' => [
        'custom_field' => 'value',
        'source' => 'api'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withacclaim.com/v1/payees/{identifier}"

	payload := strings.NewReader("{\n  \"given_name\": \"John\",\n  \"family_name\": \"Doe\",\n  \"middle_name\": \"<string>\",\n  \"company\": \"<string>\",\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"entity_type\": \"Individual\",\n  \"active\": true,\n  \"identifier\": \"<string>\",\n  \"preferred_language\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.withacclaim.com/v1/payees/{identifier}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"given_name\": \"John\",\n  \"family_name\": \"Doe\",\n  \"middle_name\": \"<string>\",\n  \"company\": \"<string>\",\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"entity_type\": \"Individual\",\n  \"active\": true,\n  \"identifier\": \"<string>\",\n  \"preferred_language\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withacclaim.com/v1/payees/{identifier}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"given_name\": \"John\",\n  \"family_name\": \"Doe\",\n  \"middle_name\": \"<string>\",\n  \"company\": \"<string>\",\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"entity_type\": \"Individual\",\n  \"active\": true,\n  \"identifier\": \"<string>\",\n  \"preferred_language\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "pyee_KfIuLz83Ya",
  "given_name": "John",
  "family_name": "Doe",
  "middle_name": "<string>",
  "name": "<string>",
  "identifier": "PYEE-2025-001",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "company": "<string>",
  "entity_type": "Individual",
  "address": {
    "country": "US",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001"
  },
  "active": true,
  "status": "Active",
  "preferred_language": "<string>",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "id": "pyee_KfIuLz83Ya",
  "given_name": "John",
  "family_name": "Doe",
  "middle_name": "<string>",
  "name": "<string>",
  "identifier": "PYEE-2025-001",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "company": "<string>",
  "entity_type": "Individual",
  "address": {
    "country": "US",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001"
  },
  "active": true,
  "status": "Active",
  "preferred_language": "<string>",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: amount",
    "details": {},
    "request_id": "req_7lYt4o2x"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

identifier

string

required

Custom identifier for the payee (e.g., external vendor ID)

Body

application/json

given_name

string

required

First name

Required string length: 1 - 255

Example:

"John"

family_name

string

required

Last name

Required string length: 1 - 255

Example:

"Doe"

middle_name

string | null

Required string length: 1 - 255

company

string | null

Required string length: 1 - 255

name

string | null

Required string length: 1 - 255

string<email> | null

phone

string | null

E.164 formatted phone number

entity_type

enum<string>

default:Individual

Type of legal entity

Available options:

Individual,

Company

address

object

Show child attributes

active

boolean

default:true

identifier

string | null

Custom identifier for the payee

Required string length: 1 - 50

preferred_language

string | null

Maximum string length: 20

metadata

object | null

Optional metadata as key-value pairs

Example:

{ "custom_field": "value", "source": "api" }

Response

Payee updated.

string

Example:

"pyee_KfIuLz83Ya"

given_name

string

Example:

"John"

family_name

string

Example:

"Doe"

middle_name

string | null

name

string

identifier

string

Example:

"PYEE-2025-001"

string<email> | null

phone

string | null

E.164 formatted phone number

company

string | null

entity_type

enum<string>

Available options:

Individual,

Company

Example:

"Individual"

address

object | null

Show child attributes

active

boolean

Example:

true

status

enum<string>

Current status of the payee based on information completeness and active state

Available options:

Active,

MissingInfo,

Inactive

Example:

"Active"

preferred_language

string | null

BCP 47 language tag (e.g. en, en-US)

Maximum string length: 20

metadata

object | null

Optional metadata as key-value pairs

Example:

{ "custom_field": "value", "source": "api" }

created_at

string<date-time>

updated_at

string<date-time>

Last modified on June 14, 2026

Update a payee

List payout methods for a payee

⌘I

ACCLAIM API

COLLECT API

DISBURSE API

TREASURY API

Create or update a payee by identifier

Authorizations

Path Parameters

Body

Response