fawran/link-recipient

Saves (tokenizes) a Fawran recipient from an iFrame flow so the front end can reference it by FawranToken. The recipient is scoped to the client account the iFrame was generated for. The same alias linked again returns the same token (a deleted recipient is revived).

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

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

string
required

The key of the iFrame the recipient is being linked from.

string
required

Recipient's full name (3 to 140 characters, Arabic or Latin).

string

individual (default) or corporate. Decides the allowed AliasType values.

string

Recipient's Qatar IBAN (29 characters, starts with QA). Saved as an AliasType iban recipient. Required unless AliasType/AliasValue is given.

string

How the recipient is addressed instead of an IBAN. Individual: mobile, alias, iban. Corporate: iban, cr_number, establishment_id, license_number.

string

The alias value: the mobile number, alias name, CR number, Establishment ID or License number.

Response

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