GuidesAPI ReferenceChangelog
Changelog
added

v2.2.0

New Payout endpoints

Get the auto-withdrawal setting

See a contractor's auto-withdrawal setting. It can be on or off and have a withdrawal method selected.

Endpoint: GET /rest/v2/payouts/auto-withdrawal-setting

Token scopes: worker:read

API Reference: Get the auto-withdrawal setting

Request Example:

curl --request GET --url https://api.letsdeel.com/rest/v2/payouts/auto-withdrawal-setting --header 'accept: application/json' --header 'authorization: Bearer {API_TOKEN}' --header 'content-type: application/json'

Change the auto-withdrawal setting

See a contractor's auto-withdrawal setting. It can be on or off and have a withdrawal method selected.

Endpoint: PATCH /rest/v2/payouts/auto-withdrawal-setting

Token scopes: worker:write

API Reference: Change the auto-withdrawal setting

Request Example:

curl --request PATCH --url https://api.letsdeel.com/rest/v2/payouts/auto-withdrawal-setting --header 'accept: application/json' --header 'authorization: Bearer {API_TOKEN}' --header 'content-type: application/json' --data ' { "enabled": true, "threshold": 1000 } '

Request to withdraw funds

See a contractor's auto-withdrawal setting. It can be on or off and have a withdrawal method selected.

Endpoint: POST /rest/v2/payouts/withdrawals

Token scopes: worker:write

API Reference: Request to withdraw funds

Request Example:

curl --request POST --url https://api.letsdeel.com/rest/v2/payouts/withdrawals --header 'accept: application/json' --header 'authorization: Bearer {API_TOKEN}' --header 'content-type: application/json' --data ' { "amount": 1000, "currency": "USD", "beneficiary_id": "123456789" } '

List Contractor Balances

See a contractor's auto-withdrawal setting. It can be on or off and have a withdrawal method selected.

Endpoint: GET /rest/v2/payouts/balances

Token scopes: worker:read

API Reference: List Contractor Balances

Request Example:

curl --request GET --url https://api.letsdeel.com/rest/v2/payouts/balances --header 'accept: application/json' --header 'authorization: Bearer {API_TOKEN}' --header 'content-type: application/json'