post https://api.banking.netevia.dev/api/fundsMovement/v2/Payee
API Method: POST /api/fundsMovement/v2/Payee
POST /api/fundsMovement/v2/PayeeDescription:
This endpoint allows the authenticated user to add a new payee to their account for funds movement. The payee is typically a Netevia account holder (or an external account) that the user can transfer funds to or make payments. The new payee will be linked to the user's account and can be used for future transactions such as A2A transfers or bill payments.
Request:
- HTTP Method:
POST - Endpoint:
/api/fundsMovement/v2/Payee - Authentication: Requires authentication (e.g., Bearer token or session ID) to ensure that only authorized users can add new payees to their account.
Request Body:
- Content-Type: `application/json
Response:
- Status Code:
200 Created— On success, the API confirms that the new payee has been added to the user's account. - Content-Type:
application/json
Response Fields:
message(string): A confirmation message that the payee has been successfully added.payeeId(string): Unique identifier for the newly added payee.payeeName(string): The name of the added payee.accountNumber(string): The masked account number of the payee for security purposes.isExternalAccount(boolean): Indicates whether the payee account is external or internal.
Possible Errors:
400 Bad Request: The request contains invalid data or missing required fields.401 Unauthorized: The request was made without proper authentication or with an invalid token.403 Forbidden: The user does not have permission to add payees.409 Conflict: A payee with the same account number or details already exists.500 Internal Server Error: An error occurred on the server while processing the request.
This request adds a new payee to the user's account for future transfers or payments, specifying the payee's account details, bank information, and whether the account is internal or external to the bank.