Create Virtual Account

Creates a temporary account number that expires after validFor seconds. Use it to collect a one-time payment; funds received are settled into settlementAccount and a notification is sent to callbackUrl.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The settlementAccount.bankCode is the Safe Haven bank code for the environment you are calling: 999240 in the sandbox and 090286 in production.

Body Params
int32
required

How long the virtual account is valid, in seconds. An integer, minimum 1. There is no default, so you must send it (for example 900 for 15 minutes).

string
required

An endpoint to receive payment webhook notifications. Must start with https://

settlementAccount
object
required

The account that payments are settled into: bankCode and accountNumber. Use bank code 999240 in the sandbox and 090286 in production.

string
enum
required

Controls which payment amounts are accepted: Fixed, UnderPayment or OverPayment.

Allowed:
int32
required

The amount expected on the virtual account.

string

Unique per account. This will be returned on the transfer object

Headers
string
required

Your ibs_client_id, returned by Exchange Client Credentials.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json