v2

latestOpenAPI 3.1.02026-07-267085761.0 MB

Developer API card

Issue a funded Paywint Card for a payee

Issues and funds a Paywint Card for a payee.

This endpoint performs the following operations:

Verifies that the payee exists.
Confirms the payee has a default address set.
Validates that the issuing account's Paywint wallet has sufficient available balance.
Deducts the initial load amount from the issuing account's wallet.
Creates the paywint card request associated with the payee.

Prerequisites:

The payee must be created using the Create Payee endpoint.
A default address must be set using either the Create Payee Address or Set Default Payee Address endpoint.
The default address is used as the billing address for the issued paywint card.

Requirements:

amount is required.
Minimum initial load amount is $2.00.
card_nickname is optional.
If card_nickname is not provided, the default value "My Paywint Card" will be used.

The initial load amount is immediately deducted from the issuing account’s available wallet balance at the time of the request.

Returns the created paywint card request.

post/api/user-api/card/payee/pw-card/request

Headers

X-Api-Keystring required

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

X-Api-Secretstring required

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

Request body

payee_idstring 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.

card_nick_namestring

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

amountnumber 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.

Example request

{
  "amount": 50,
  "card_nick_name": "Holiday Bonus Card",
  "payee_id": "c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345"
}

Response

Successful Response

successboolean

Indicates whether the request was processed successfully.

messagestring

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

queryGeneratedTimenumber nullable

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

Example response

{
  "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
}