PayoutMethod-Post-v6

From Barion Documentation
Jump to navigation Jump to search

Barion API: POST v6/recipients/{recipientid}/payout-methods

POST /v6/recipients/{recipientid}/payout-methods

This API endpoint adds a new payout method to an existing recipient.

Prerequisites before use:

Authentication

Barion Wallet Authentication

Input properties

Property name Property type Limitations and constraints Description
Idempotency-Key GUID
  • Optional
Idempotency key used to safely retry requests without duplicating operations. Passed in the request header. See Idempotency-Key.
recipientid String
  • Required
  • Format: rcp_<ordered-base64-ulid>
ID of an existing recipient. Passed as a path parameter.
<root> Object
  • Required
Payout method object. See the object.

Output properties

HTTP status code: 201 Created

Property name Property type Description
payoutMethodId String Unique identifier of the newly created payout method. Format: pout_<ordered-base64-ulid>.

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
The provided account number is invalid (whitelist & blacklist validation) InvalidAccountNumber 400
Authentication fails 401
Referenced recipient is not connected to the opened wallet RecipientForbidden 403
Recipient does not exist RecipientNotFound 404