POST
/
api
/
platform
/
card
/
list-payee-card
/
{user_id}
List Payee Cards
curl --request POST \
  --url https://api.sandbox.paywint.com/api/platform/card/list-payee-card/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '{
  "payee_id": "f47ac10b-****-****-****-0e02b2c3d479"
}'
{
  "success": true,
  "status_code": 123,
  "message": "<string>",
  "records": [
    {
      "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
      "card_id": "b62f010b-****-****-****-9e02b2c3d478",
      "card_nick_name": "Personal Visa Card",
      "card_number": "1111",
      "card_exp": "06/2030"
    }
  ],
  "totalRecords": 123,
  "queryGeneratedTime": 123
}

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

Body

application/json
​
payee_id
string<uuid>
required

Unique identifier (UUID) assigned to the payee.

Example:

"f47ac10b-****-****-****-0e02b2c3d479"

Response

Successful Response

​
success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

​
status_code
integer | null
default:200

HTTP status code representing the result of the request.

​
message
string | null
default:Success

Short, human-readable message describing the outcome of the request.

​
records
ExternalContactCardRead · object[] | null

List of result items returned for the current page.

​
totalRecords
integer | null
default:0

Total number of matching records in the database, useful for paginating the full dataset.

​
queryGeneratedTime
integer | null
default:1756883312

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