Skip to main content
POST
/
api
/
user-api
/
card
/
payee
/
pw-card
/
request
Issue a funded Paywint Card for a payee
curl --request POST \
  --url https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --header 'X-Api-Secret: <x-api-secret>' \
  --data '
{
  "amount": 50,
  "card_nick_name": "Holiday Bonus Card",
  "payee_id": "c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345"
}
'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "address_line": "742 Evergreen Terrace",
    "amount": 150,
    "card_nick_name": "Employee Performance Bonus",
    "city": "Austin",
    "country": "US",
    "created_at": "2026-02-12T10:15:30Z",
    "first_name": "Michael",
    "last_name": "Anderson",
    "payee_id": "c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345",
    "payment_id": "a42d67b4-0d65-4b89-b91e-0fcba5f65d9a",
    "reference_id": 10472,
    "request_id": "f24a8e7c-7f2b-4f39-bc5d-98e01a123456",
    "state": "TX",
    "status": "pending",
    "zip": "78701"
  },
  "queryGeneratedTime": 1718006400
}

Headers

X-Api-Key
string
required

Your API Key (UUID format). Required to identify and authorize each request

X-Api-Secret
string
required

Secret associated with your API Key. Used for authenticating requests. Keep this secure.

Body

application/json
payee_id
string<uuid>
required

The unique identifier of the existing payee who will receive the Paywint Card. The payee must already be created and must have a default address set.

Example:

"c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345"

amount
number
required

The amount to preload onto the card in USD. Minimum allowed value is $2.00. This amount is immediately deducted from the issuing account's available Paywint wallet balance.

Required range: x >= 2
Example:

50

card_nick_name
string
default:My Paywint Card

Optional nickname for the card. If not provided, the default value "My Paywint Card" will be used. Must be between 1 and 30 characters.

Required string length: 1 - 30
Example:

"Holiday Bonus Card"

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
ExternalPaywintGiftCardRequestRead · object

The main response payload, if applicable

Example:
{
  "address_line": "742 Evergreen Terrace",
  "amount": 150,
  "card_nick_name": "Employee Performance Bonus",
  "city": "Austin",
  "country": "US",
  "created_at": "2026-02-12T10:15:30Z",
  "first_name": "Michael",
  "last_name": "Anderson",
  "payee_id": "c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345",
  "payment_id": "a42d67b4-0d65-4b89-b91e-0fcba5f65d9a",
  "reference_id": 10472,
  "request_id": "f24a8e7c-7f2b-4f39-bc5d-98e01a123456",
  "state": "TX",
  "status": "pending",
  "zip": "78701"
}
queryGeneratedTime
number | null
default:1778161546.973489

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

Example:

1718006400