Skip to main content
PATCH
/
api
/
v1
/
business
/
payouts
/
recipients
/
{id}
Update recipient label
curl --request PATCH \
  --url http://localhost:3001/api/v1/business/payouts/recipients/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "businessId": "<string>",
    "label": "<string>",
    "detailsMasked": {},
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "screenedAt": {},
    "archivedAt": {}
  }
}

Authorizations

Authorization
string
header
required

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

Headers

X-Axra-Business-Id
string

Active business workspace

Path Parameters

id
string
required

Body

application/json
label
string
required
Maximum string length: 120

Response

OK

success
boolean
required
Example:

true

data
object
required