HomeAPI ReferenceClientsCreate Fiat Client
POST/clients/fiat/create

Create Fiat Client

Outcome - Creates a new client of category FIAT linked to this vault. Allowed only for Fiat Vault credentials. Refunding Prerequisite: Under the hood, fiat deposits are only refundable if the client's bank details are known. You must provide the client's IBAN during registration to make transactions eligible for refunding. Without a registered IBAN, the payment gateway cannot identify the destination account to reverse/refund funds.

Body Parameters

idstringrequired

Unique client identifier in your system

namestringrequired

Full legal name as registered at their bank

identityNumberstringrequired

National ID, Iqama, or Commercial Registration number (10 to 12 characters)

IBANstring

Bank IBAN. Required to support refunds. Must begin with Saudi Arabia prefix 'SA'

emailstring

Valid email address

mobilestring

Mobile phone number

Responses

Response attributes

messagestring

Success message

clientobject

Created client details

Show child attributes (7)
externalIdstring

External client ID

namestring

Client name

emailstring

Email address

mobilestring

Mobile number

idnumber

Internal ID

createdAtstring

Creation timestamp

updatedAtstring

Update timestamp

statusnumber

HTTP status code

Was this page helpful?