Skip to main content
POST
/
api
/
company
/
{company_id}
/
recipients
/
create
Create recipient
curl --request POST \
  --url https://api.sandbox.bitwage.com/api/company/{company_id}/recipients/create \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient_type": "contractor",
  "external_id": "<string>"
}
'
{
  "recipient_id": "<string>",
  "recipient_type": "<string>",
  "relationship_id": "<string>",
  "status": "<string>",
  "idempotency_replayed": true
}

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Unique key for idempotent requests. Recommended for all write operations.

Path Parameters

company_id
string
required

Company ID.

Body

application/json
recipient_type
enum<string>
required
Available options:
contractor,
employee
external_id
string
worker
object

Response

200 - application/json

Recipient created.

recipient_id
string
recipient_type
string
relationship_id
string
status
string
idempotency_replayed
boolean