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

import requests

url = "https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request"

payload = {
    "amount": 50,
    "card_nick_name": "Holiday Bonus Card",
    "payee_id": "c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345"
}
headers = {
    "X-Api-Key": "<x-api-key>",
    "X-Api-Secret": "<x-api-secret>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Api-Key': '<x-api-key>',
    'X-Api-Secret': '<x-api-secret>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 50,
    card_nick_name: 'Holiday Bonus Card',
    payee_id: 'c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345'
  })
};

fetch('https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 50,
    'card_nick_name' => 'Holiday Bonus Card',
    'payee_id' => 'c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <x-api-key>",
    "X-Api-Secret: <x-api-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request"

	payload := strings.NewReader("{\n  \"amount\": 50,\n  \"card_nick_name\": \"Holiday Bonus Card\",\n  \"payee_id\": \"c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<x-api-key>")
	req.Header.Add("X-Api-Secret", "<x-api-secret>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request")
  .header("X-Api-Key", "<x-api-key>")
  .header("X-Api-Secret", "<x-api-secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 50,\n  \"card_nick_name\": \"Holiday Bonus Card\",\n  \"payee_id\": \"c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request["X-Api-Secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 50,\n  \"card_nick_name\": \"Holiday Bonus Card\",\n  \"payee_id\": \"c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Issue Paywint Card For 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

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

import requests

url = "https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request"

payload = {
    "amount": 50,
    "card_nick_name": "Holiday Bonus Card",
    "payee_id": "c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345"
}
headers = {
    "X-Api-Key": "<x-api-key>",
    "X-Api-Secret": "<x-api-secret>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Api-Key': '<x-api-key>',
    'X-Api-Secret': '<x-api-secret>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 50,
    card_nick_name: 'Holiday Bonus Card',
    payee_id: 'c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345'
  })
};

fetch('https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 50,
    'card_nick_name' => 'Holiday Bonus Card',
    'payee_id' => 'c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <x-api-key>",
    "X-Api-Secret: <x-api-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request"

	payload := strings.NewReader("{\n  \"amount\": 50,\n  \"card_nick_name\": \"Holiday Bonus Card\",\n  \"payee_id\": \"c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<x-api-key>")
	req.Header.Add("X-Api-Secret", "<x-api-secret>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request")
  .header("X-Api-Key", "<x-api-key>")
  .header("X-Api-Secret", "<x-api-secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 50,\n  \"card_nick_name\": \"Holiday Bonus Card\",\n  \"payee_id\": \"c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paywint.com/api/user-api/card/payee/pw-card/request")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request["X-Api-Secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 50,\n  \"card_nick_name\": \"Holiday Bonus Card\",\n  \"payee_id\": \"c9b1f3b2-8d9a-4f1b-a9e5-6a77f0b12345\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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 | null

The main response payload, if applicable

Show child attributes

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

Accept Payment

Payment

Wallet

Paywint Cards

Payee Management

Payee Addresses

Issue Paywint Card For Payee

Headers

Body

Response