Recipient-Patch-v6
Jump to navigation
Jump to search
Barion API: PATCH v6/recipients/{recipientid}
| PATCH | /v6/recipients/{recipientid} |
|---|
This API endpoint updates the name details of an existing recipient.
Prerequisites before use:
Authentication
Input properties
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| Idempotency-Key | GUID |
|
Idempotency key used to safely retry requests without duplicating operations. Passed in the request header.
See Idempotency-Key. |
| recipientid | String |
|
ID of the existing recipient to be updated. Passed as a path parameter. |
| <root> | Object |
|
|
| companyName | String |
|
Updated name of the company. |
| firstName | String |
|
Updated first name of the recipient. |
| lastName | String |
|
Updated last name of the recipient. |
Output properties
HTTP status code: 204 No Content
The response body is empty.
To find out which errors this endpoint can produce, visit the Calling the API – Handling the response page. Note that this endpoint uses camelCase field names in error responses.
Possible error messages
| Condition | ErrorCode | HTTP status code |
|---|---|---|
| Invalid input data | ModelValidationError |
400 |
| Authentication fails | 401 | |
| Referenced recipient is not connected to the opened wallet | RecipientForbidden |
403 |
| Recipient does not exist | RecipientNotFound |
404 |