logoOPEN BANKING DOCS

Create transient account

Create a new transient account for a wallet

POST
/transient-accounts
X-API-Key<token>

In: header

Header Parameters

X-API-Keystring

API key for the application

X-App-Idstring

UUID of the application

Formatuuid
walletIdstring

Wallet UUID to associate with the transient account

Formatuuid
accountNamestring

Name for the transient account

ownerEntityTypestring

Type of entity that owns the account

Value in"CUSTOMER" | "CORPORATION"
collectionsAccountIdstring

Collections account UUID for overfill handling

Formatuuid
overfillAmount?number | null

Maximum overfill amount allowed

Formatdecimal
Range0 <= value

Response Body

curl -X POST "https://virtual-accounts-api.vantacrest.com/company/v1/transient-accounts" \  -H "X-API-Key: string" \  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",    "accountName": "string",    "ownerEntityType": "CUSTOMER",    "collectionsAccountId": "fb32ea18-8c9e-4af9-80c5-0fc8d779c454"  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "accountNumber": "string",
    "accountName": "string",
    "ownerEntityType": "CUSTOMER",
    "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
    "appId": "28c365d5-df94-4a54-8217-3ce51d068868",
    "state": "ACTIVE",
    "collectionsAccountId": "fb32ea18-8c9e-4af9-80c5-0fc8d779c454",
    "overfillAmount": 0,
    "overfilled": true,
    "settled": true,
    "createdAt": "2019-08-24T14:15:22Z"
  }
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}