Back to neotek ↗Get Sandbox Access

CreateVirtualAccount

POSThttps://test.api.neotek.sa/b2b-unified/va/v1/remitters

Sandbox URL · in Production call https://api.neotek.sa

Creates one VA within a scheme and returns the bank-assigned IBAN and BBAN.

Body:

ParameterRequiredDescription
bankCodeRequiredalways RJHISARI
remitterIdRequiredyour own identifier, alphanumeric, up to 16 characters
remitterNameRequireddisplay name, up to 100 characters
maximumAmountRequiredthe cap for CAP schemes, a high value for non-CAP. Range 0 to 9999999999999.99
schemeIdOptionalrequired only if you have several schemes
startDateOptionaldefaults to today
expiryDateOptionalthe VA never expires if omitted
msgReferenceOptionalgenerated if omitted
notificationsOptionalsee below

notifications enables SMS or email alerts for VA activity. At least one of email or mobile is required when the block is present:

ParameterRequiredDescription
enabledRequiredturns notifications on or off
languageOptionalARABIC or ENGLISH, defaulting to ENGLISH
emailConditionalthe address to notify
mobileConditionala Saudi mobile in +9665XXXXXXXX form

Headers:

ParameterRequiredDescription
authorizationRequiredBearer <ACCESS_TOKEN>
content-typeRequiredapplication/json
cURL
curl -X POST 'https://test.api.neotek.sa/b2b-unified/va/v1/remitters' \  --header 'authorization: Bearer <ACCESS_TOKEN>' \  --header 'content-type: application/json' \  --data '{    "bankCode": "RJHISARI",    "remitterId": "CUST001",    "remitterName": "Acme Trading Co",    "maximumAmount": 50000.00,    "notifications": {      "enabled": true,      "language": "ENGLISH",      "email": "finance@acme.com",      "mobile": "+966512345678"    }  }'

Response

JSON
{  "success": true,  "code": "SUCCESS",  "message": "Virtual account created successfully",  "remitterId": "CUST001",  "iban": "SA4580000204000010006087",  "bban": "204000010006087",  "maximumAmount": "50000.00",  "msgReference": "REF123ABC",  "schemeId": "SCHEME001"}

iban and bban are bank-assigned and immutable. They cannot be changed through UpdateVirtualAccount.

Errors — every B2B failure carries a category that determines the HTTP status; see Statements → Errors.