Update Sub Account

put https://api.sandbox.safehavenmfb.com/accounts/{id}/subaccount

This creates a new sub-account based on the specified information in the request body

Body Params

phoneNumber

string

required

This is the phone number of the account holder. It should begin with the country code.

emailAddress

string

required

This is the email address.

externalReference

string

required

This is an external reference to be attached to the account object.

identityType

string

required

Defaults to BVN

Identification method the account holder, should be either NIN, vNIN, BVN, BVNUSSD, or vID (if you are using Safe Haven Verification Service)).

identityNumber

string

It is required when using BVN, NIN, and BVNUSSD. Not required if you are using vID

identityId

string

The _id from the Safe Haven Verification Endpoint. It is required when vID, BVN, or NIN

otp

string

The OTP sent to the customer's phone number when you initiate verification using Safe Haven verification endpoint. This works for BVN and NIN or the OTP sent to customer's phone number when using BVNUSSD

metadata

json

Defaults to {}

This is the key-value pair object that can be attached to the account object.

autoSweep

boolean

This should be set when creating a virtual account. It determines if auto sweep should be enabled or disabled.

autoSweepDetails

object

This contains the auto sweep details to be filled if creating a virtual account.

callbackUrl

string

If not provided, the webhook URL on your Dashboard will be used.

Headers

ClientID

string

required

This is your 'ibs_client_id' returned in the response when you generate an api token

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
13
1
curl --request PUT \
2
     --url https://api.sandbox.safehavenmfb.com/accounts/id/subaccount \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "identityType": "BVN",
8
  "metadata": {},
9
  "autoSweepDetails": {
10
    "schedule": "Instant"
11
  }
12
}
13
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400