Assign VRN to virtual account

POST 
/v1/baas/virtual-accounts/assign-vrn

Assigns a Virtual Reference Number (VRN) to a specific virtual account. The virtual account is identified by the user ID and the account number.

Request

application/json

Body

required

userId stringrequired

The ID of the user to assign a VRN for

virtualAccountNumber stringrequired

The virtual account number (from bank_virtual_account) to assign the VRN to

Responses

201

VRN assigned to virtual account with success.

application/json

Schema

Schema

traceId string
message string

data

object

walletId stringrequired

The ID of the wallet that the virtual account belongs to

vrnNumber stringrequired

The VRN assigned to the virtual account

virtualAccountNumber stringrequired

The virtual account number that received the VRN

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": {
    "walletId": "550e8400-e29b-41d4-a716-446655440000",
    "vrnNumber": "9876543210",
    "virtualAccountNumber": "1234567890"
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...