Skip to main content
POST
/
api
/
platform
/
card
/
add
/
secure-link
/
{user_id}
Generate signed add-card link
curl --request POST \
  --url http://localhost:8001/api/platform/card/add/secure-link/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "card_purpose": "PAYMENT"
}
'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "secure_link": "https://your-client-app.com/platform/add-card?prd=1&cardId=07f0a4aa-b890-4135-84d6-ec9c19b82bb3"
  },
  "queryGeneratedTime": 1718006400
}

Headers

​
X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

​
X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

​
user_id
string<uuid>
required

Unique identifier (UUID) of the user for whom the add-card link is being generated.

Body

application/json
​
card_purpose
enum<string>
required

Specifies the purpose of the card — either PAYMENT or WITHDRAWAL

Available options:
PAYMENT,
WITHDRAWAL
Example:

"PAYMENT"

Response

Successful Response

​
success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

​
message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

​
data
PlatformCardSecureLinkRead · object

The main response payload, if applicable

​
queryGeneratedTime
number | null
default:1782303609.673092

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400