Skip to main content
POST
/
api
/
user
/
payer
/
update
Update payer
curl --request POST \
  --url https://api.sandbox.bitwage.com/api/user/payer/update \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "company_type": "employer",
  "payroll_invoice_currency": "EUR",
  "name": "<string>",
  "website": "<string>",
  "email": "jsmith@example.com",
  "external_company_id": "<string>",
  "occupation": "<string>",
  "payment_amount": "<string>",
  "street_address": "<string>",
  "street_address_2": "<string>",
  "city": "<string>",
  "region": "<string>",
  "zip": "<string>",
  "country": "<string>"
}
'
{
  "external_company_id": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Include your access token as: Authorization: Basic <ACCESS_TOKEN>

Body

application/json
user_id
string
required
company_type
enum<string>
required
Available options:
employer,
client
payroll_invoice_currency
enum<string>
required
Available options:
EUR,
USD
name
string
required

Payer company name.

website
string
required
email
string<email>
required
external_company_id
string
required

Payer ID to update.

occupation
string

Employer only.

payment_amount
string

Employer only.

street_address
string

Client only.

street_address_2
string

Client only.

city
string

Client only.

region
string

Client only.

zip
string

Client only.

country
string

Client only. 2-character ISO country code.

Response

200 - application/json

Payer updated.

external_company_id
string