Create New Beneficiary Bank Account
Header Parameters
X-Auth-User-IDstring Required
MatchMove provided ID for the user.
Authorizationstring
Body Parameters
bank_account_numberstring Required
Bank Account Number
bank_holder_namestring Required
Bank Holder Name
bank_codestring Required
Bank Identification Code
entity_typestring
Bank Entity Type
Enum values:
BUSINESSINDIVIDUALResponse
200
Object
Success
Response Attributes
idstring
Bank Account Generated Hash ID
bank_account_numberstring
Bank Account Number
bank_holder_namestring
Bank Account Name
bank_codestring
Bank Identification Code
bank_namestring
Bank Name
modestring
Bank Mode
Enum values:
bankwalletentity_typestring
Bank Entity Type
Nullable:
True
Enum values:
[object Object]BUSINESSINDIVIDUALis_activenumber
Bank Is Active
Enum values:
01statusstring
| Status | Description |
|---|---|
| pending_activation | Status of recipient bank account for domestic payouts before the bank account is approved for processing payouts |
| active | Status of recipient bank account which is enabled and allowed to process domestic payout transactions |
| blocked | Status of recipient bank account which has been flagged and blocked in the system. This status generally happens if the bank account is flagged / under review for complianc... |
Enum values:
activepending_activationblockeddeletedcreated_atstring
Date Created
updated_atstring
Date Updated
Nullable:
True
activated_atstring
Date Activated
Nullable:
True
400
Object
Bad Request
| Code | Description | Examples/Notes |
| :--- | :---------- | :---------- |
| resource_va_error | Error: :error_message | error_message are dynamic errors which represents the 400 errors |
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
401
Object
Unauthorized request
| Code | Description | Examples/Notes |
| :--- | :---------- | :---------- |
| resource_va_error | Error: :error_message | error_message are dynamic errors which represents the 401 errors |
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
403
Object
Forbidden
| Code | Description | Examples/Notes |
| :--- | :---------- | :---------- |
| resource_va_error | Error: :error_message | error_message are dynamic errors which represents the 403 errors |
| enity_blocked_risk_threshold_exceeded | Entity '{entity}.{attribute}' requested for evaluation is blacklisted | Entity 'virtual_account_beneficiary.bank_account_number' requested for evaluation is blacklisted |
| | | Entity 'virtual_account_beneficiary.bank_holder_name' requested for evaluation is blacklisted |
| | | Entity 'virtual_account_beneficiary.bank_code' requested for evaluation is blacklisted |
| risk_management_engine_error | | An exception occurred while checking whether the entity is blacklisted or not |
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
404
Object
Resource not found
| Code | Description | Examples/Notes |
| :--- | :---------- | :---------- |
| resource_va_error | Error: :error_message | error_message are dynamic errors which represents the 404 errors |
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
500
Object
Internal server Error
| Code | Description |
| :--- | :---------- |
| resource_va_service_error | Unable to process the request due to the risk service unavailability. |
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
502
Object
Bad Gateway
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
503
Object
External Service Error
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
504
Object
Gateway timeout
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
Was this section helpful?
Response
Was this section helpful?