Skip to main content
POST
/
client
/
transactions
/
onboard-from-storage
/
initiate
cURL
curl --request POST \
  --url https://sandbox-remote-api.rayda.co/api/v2/client/transactions/onboard-from-storage/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_method": "Card",
  "employee_country_id": "b9bbd993-6556-4186-a00b-61346f9f66be",
  "orders": {},
  "redirect_url": "http://localhost:3000/dashboard/transactions"
}
'
{
  "success": true,
  "message": "Record created successfully",
  "data": {
    "tx_ref": "tx_ref_r_679e6440309fa",
    "payment_method": "Credit",
    "amount": 0,
    "insurance": 0,
    "gateway_fee": 0,
    "onboarding_fee": 198,
    "device_config_fee": 0,
    "platform_fee": 0,
    "total_amount": 198,
    "currency": "GBP",
    "link": "https://checkout.stripe.com/c/pay/...",
    "status": "Fulfilled"
  }
}
This endpoint allows you to start a transaction for assigning equipment from storage to an employee. It computes the total onboarding fees based on the quantity of equipment and provides a payment link for finalizing the transaction. While there are no costs associated with the equipment itself, onboarding fees apply (including logistics, device setup, etc.).Payments can be made via Card or Credit, with credit payments being deducted from your credit wallet.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The transaction details, including order information and payment method.

​
payment_method
string
required

The payment method selected by the client (e.g., "Credit").

Example:

"Card"

​
employee_country_id
string<uuid>
required

The ID of the employee's resident country.

Example:

"b9bbd993-6556-4186-a00b-61346f9f66be"

​
orders
object
required

The key for this property must correspond to the ID of the employee to whom the equipment will be assigned.

​
redirect_url
string<uri>

The URL to redirect the user after payment completion.

Example:

"http://localhost:3000/dashboard/transactions"

Response

Transaction initiated successfully. Returns payment link and transaction details.

​
success
boolean
Example:

true

​
message
string
Example:

"Record created successfully"

​
data
object