Skip to main content
POST
/
payees
/
{payee_id}
/
payout_methods
Create a payout method for a payee
curl --request POST \
  --url https://api.withacclaim.com/v1/payees/{payee_id}/payout_methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payout_method_type": "UnitedStatesAch",
  "country": "<string>",
  "account_number": "<string>",
  "routing_type1": "<string>",
  "routing_value1": "<string>",
  "routing_type2": "<string>",
  "routing_value2": "<string>",
  "account_holder_name": "<string>",
  "account_type": "<string>",
  "swift_code": "<string>",
  "iban": "<string>",
  "currency": "<string>",
  "tax_id_type": "<string>",
  "tax_id": "<string>",
  "payout_speed": "normal"
}
'
{
  "id": "pmet_abc123",
  "payout_method_type": "UnitedStatesAch",
  "active": true,
  "currency": "<string>",
  "country": "<string>",
  "account_number": "<string>",
  "routing_type1": "<string>",
  "routing_value1": "<string>",
  "routing_type2": "<string>",
  "routing_value2": "<string>",
  "bank_name": "<string>",
  "account_holder_name": "<string>",
  "account_type": "<string>",
  "swift_code": "<string>",
  "iban": "<string>",
  "tax_id_type": "<string>",
  "tax_id": "<string>",
  "payout_speed": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
payee_id
string
required

ID of the payee.

Body

application/json
​
payout_method_type
string | null

Payout method type. When omitted, we infer the payout method type from the given data.

Example:

"UnitedStatesAch"

​
country
string | null

ISO 3166-1 alpha-2 country code

Required string length: 2
​
account_number
string | null

Bank account number

Maximum string length: 255
​
routing_type1
string | null

Primary routing type (e.g. aba, swift)

​
routing_value1
string | null

Primary routing value

Maximum string length: 255
​
routing_type2
string | null

Secondary routing type

​
routing_value2
string | null

Secondary routing value

Maximum string length: 255
​
account_holder_name
string | null
Maximum string length: 255
​
account_type
string | null

e.g. checking, savings

Maximum string length: 50
​
swift_code
string | null
Maximum string length: 50
​
iban
string | null
Maximum string length: 34
​
currency
string | null

ISO 4217 currency code

Maximum string length: 3
​
tax_id_type
string | null
Maximum string length: 50
​
tax_id
string | null
Maximum string length: 100
​
payout_speed
enum<string> | null

Payout speed preference

Available options:
normal,
priority

Response

Payout method created.

​
id
string

Public ID of the payout method

Example:

"pmet_abc123"

​
payout_method_type
string

Type of payout method

Example:

"UnitedStatesAch"

​
active
boolean
Example:

true

​
currency
string | null

ISO 4217 currency code

​
country
string | null

ISO 3166-1 alpha-2 country code

​
account_number
string | null
​
routing_type1
string | null
​
routing_value1
string | null
​
routing_type2
string | null
​
routing_value2
string | null
​
bank_name
string | null
​
account_holder_name
string | null
​
account_type
string | null
​
swift_code
string | null
​
iban
string | null
​
tax_id_type
string | null
​
tax_id
string | null
​
payout_speed
string | null
​
created_at
string<date-time>
​
updated_at
string<date-time>
Last modified on April 16, 2026