Loading...
Accounts APINamed accounts

Create named account order

POST
/orders/named-accounts

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

It helps preventing duplicates in your POST requests. It is recommend using a UUID for the key, however you may use any other unique identifier you choose.

Lengthlength <= 160
X-Volt-Api-Version*integer

Version of the API used. Currently, version 1 is the only version.

Value in1
X-Volt-Testing-Scenario?string

[SANDBOX ONLY] used to trigger specific transaction failure or verification mocks.

Value in"PAYOUT_REJECTED" | "ACCOUNT_HOLDER_VERIFICATION_CLOSE_MATCH" | "ACCOUNT_HOLDER_VERIFICATION_NO_MATCH" | "ACCOUNT_HOLDER_VERIFICATION_ERROR" | "ONBOARDING_REJECTED" | "ONBOARDING_ADDITIONAL_INFO_REQUIRED" | "ONBOARDING_EXPIRED" | "ORDER_NAMED_ACCOUNTS_FAILED"

Request Body

application/json

onboardingEntityId*string

ID of the approved onboarding entity

Formatuuid
currency*string

Three-letter ISO 4217 currency code.

Match^[A-Z]{3}$
communication?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://accounts.sandbox.volt.io/orders/named-accounts" \  -H "Idempotency-Key: 85136c79cbf9fe36bb9d05d0639c70c265c18d37" \  -H "X-Volt-Api-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "onboardingEntityId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",    "currency": "EUR",    "communication": {      "notification": {        "url": "https://mywebsite.com/webhooks"      }    }  }'
{
  "id": "order-5678-90ab-cdef-1234567890ab"
}