This guide explains the purpose and general usage of the Create Recipient endpoint in the orda API.

OverviewCopied!

You can create recipients associated to a project that can move money. Creating a recipient generates a unique ID specific to that recipient, which you'll use when sending funds to that recipient or retrieving data associated with them.

AuthenticationCopied!

To create recipients via the API, you must have a project client ID and secret. You can create a new project on the orda developer portal

You must sign each API request with a HMAC signature with an x-signature in the header, derived from your client secret. Refer to the authentication guide for more info on how to authenticate your requests.

NotesCopied!

To create a recipient, you must include the settlement details where the user can receive funds in fiat currency and/or on-chain. At least one of the following settlement details are required:

• Blockchain settlement information associated to the recipient (destination chain, token, wallet address)

• Fiat settlement information (KYB/KYC information, banking details)

The recipient will be associated with the project client ID provided in the request header as such:

Header	Description
x-client-id	Your project's client ID
x-signature	HMAC-SHA256 signature derived from your client secret
Content-Type	application/json for this request

Common IssuesCopied!

• Not signing the request with an x-signature derived from your client secret. Refer to the authentication guide for more info.

• Providing a token address or wallet address that is invalid or not compatible with the specified blockchain.

Next StepsCopied!

Once a recipient is created, you’ll receive a unique recipient ID for them in the response. This key should be securely stored and used when interacting with that recipient’s data or initiating payouts.

For implementation details, such as request format and sample code, refer to the API reference.