Skip to main content
POST
/
api
/
user-api
/
payee
/
create
Create Payee
curl --request POST \
  --url https://api.sandbox.paywint.com/api/user-api/payee/create \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --header 'X-Api-Secret: <x-api-secret>' \
  --data '
{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone_country_code": "+1",
  "phone": "1234567890"
}
'
import requests

url = "https://api.sandbox.paywint.com/api/user-api/payee/create"

payload = {
"name": "John Doe",
"email": "john.doe@example.com",
"phone_country_code": "+1",
"phone": "1234567890"
}
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({
name: 'John Doe',
email: 'john.doe@example.com',
phone_country_code: '+1',
phone: '1234567890'
})
};

fetch('https://api.sandbox.paywint.com/api/user-api/payee/create', 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/payee/create",
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([
'name' => 'John Doe',
'email' => 'john.doe@example.com',
'phone_country_code' => '+1',
'phone' => '1234567890'
]),
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/payee/create"

payload := strings.NewReader("{\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone_country_code\": \"+1\",\n \"phone\": \"1234567890\"\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/payee/create")
.header("X-Api-Key", "<x-api-key>")
.header("X-Api-Secret", "<x-api-secret>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone_country_code\": \"+1\",\n \"phone\": \"1234567890\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone_country_code\": \"+1\",\n \"phone\": \"1234567890\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone_country_code": "+1",
    "phone": "1234567890",
    "created_at": "2025-06-10T18:10:42.000Z"
  },
  "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
name
string
required

Full name of the payee

Maximum string length: 50
Example:

"John Doe"

email
string<email> | null

Email address of the payee

Maximum string length: 100
Example:

"john.doe@example.com"

phone_country_code
string | null

International dialing code of the payee’s phone number (e.g., +1 for US).

Maximum string length: 5
Example:

"+1"

phone
string | null

Payee’s local phone number, excluding country code.

Maximum string length: 15
Example:

"1234567890"

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
ExternalContactsRead · object | null

The main response payload, if applicable

queryGeneratedTime
number | null
default:1778161546.973489

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

Example:

1718006400