Create Payment

Create Payment

curl --request POST \
  --url https://api.paywint.com/api/platform/payment/create-payment \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "user_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "amount": 123,
  "invoice_no": "INV-2024-001234",
  "card_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "description": "<string>",
  "payment_descriptor": "<string>",
  "payee_card_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "payee_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "to_pw_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "payment_for": "payment"
}
'

import requests

url = "https://api.paywint.com/api/platform/payment/create-payment"

payload = {
    "user_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "amount": 123,
    "invoice_no": "INV-2024-001234",
    "card_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "description": "<string>",
    "payment_descriptor": "<string>",
    "payee_card_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "to_pw_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payment_for": "payment"
}
headers = {
    "X-Platform-ID": "<x-platform-id>",
    "X-Signature": "<x-signature>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Platform-ID': '<x-platform-id>',
    'X-Signature': '<x-signature>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    user_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    payee_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    amount: 123,
    invoice_no: 'INV-2024-001234',
    card_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    bank_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    description: '<string>',
    payment_descriptor: '<string>',
    payee_card_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    payee_bank_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    to_pw_bank_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    payment_for: 'payment'
  })
};

fetch('https://api.paywint.com/api/platform/payment/create-payment', 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.paywint.com/api/platform/payment/create-payment",
  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([
    'user_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'payee_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'amount' => 123,
    'invoice_no' => 'INV-2024-001234',
    'card_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'bank_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'description' => '<string>',
    'payment_descriptor' => '<string>',
    'payee_card_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'payee_bank_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'to_pw_bank_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'payment_for' => 'payment'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Platform-ID: <x-platform-id>",
    "X-Signature: <x-signature>"
  ],
]);

$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.paywint.com/api/platform/payment/create-payment"

	payload := strings.NewReader("{\n  \"user_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"amount\": 123,\n  \"invoice_no\": \"INV-2024-001234\",\n  \"card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"description\": \"<string>\",\n  \"payment_descriptor\": \"<string>\",\n  \"payee_card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"to_pw_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payment_for\": \"payment\"\n}")

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

	req.Header.Add("X-Platform-ID", "<x-platform-id>")
	req.Header.Add("X-Signature", "<x-signature>")
	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.paywint.com/api/platform/payment/create-payment")
  .header("X-Platform-ID", "<x-platform-id>")
  .header("X-Signature", "<x-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"amount\": 123,\n  \"invoice_no\": \"INV-2024-001234\",\n  \"card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"description\": \"<string>\",\n  \"payment_descriptor\": \"<string>\",\n  \"payee_card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"to_pw_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payment_for\": \"payment\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paywint.com/api/platform/payment/create-payment")

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

request = Net::HTTP::Post.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"amount\": 123,\n  \"invoice_no\": \"INV-2024-001234\",\n  \"card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"description\": \"<string>\",\n  \"payment_descriptor\": \"<string>\",\n  \"payee_card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"to_pw_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payment_for\": \"payment\"\n}"

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

{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "payment_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "transaction_id": 1501,
    "payer_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "amount": 100,
    "processing_fee": 1.5,
    "delivery_fee": 0.5,
    "invoice_no": "INV-2024-001234",
    "currency": "USD",
    "description": "June invoice for services",
    "created_at": "2025-06-16T10:04:51.739761Z",
    "payment_date": "2025-06-16T10:13:16.749655Z",
    "status": "success",
    "card_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_card_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "to_pw_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "failure_reason": "Insufficient wallet balance",
    "payout_currency": "INR",
    "payout_amount": 8500,
    "exchange_rate": 84.91,
    "payment_method": "WALLET",
    "receiving_method": "WALLET"
  },
  "queryGeneratedTime": 1718006400
}

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

POST

api

platform

payment

create-payment

Create Payment

curl --request POST \
  --url https://api.paywint.com/api/platform/payment/create-payment \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "user_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "amount": 123,
  "invoice_no": "INV-2024-001234",
  "card_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "description": "<string>",
  "payment_descriptor": "<string>",
  "payee_card_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "payee_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "to_pw_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "payment_for": "payment"
}
'

import requests

url = "https://api.paywint.com/api/platform/payment/create-payment"

payload = {
    "user_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "amount": 123,
    "invoice_no": "INV-2024-001234",
    "card_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "description": "<string>",
    "payment_descriptor": "<string>",
    "payee_card_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "to_pw_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payment_for": "payment"
}
headers = {
    "X-Platform-ID": "<x-platform-id>",
    "X-Signature": "<x-signature>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Platform-ID': '<x-platform-id>',
    'X-Signature': '<x-signature>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    user_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    payee_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    amount: 123,
    invoice_no: 'INV-2024-001234',
    card_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    bank_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    description: '<string>',
    payment_descriptor: '<string>',
    payee_card_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    payee_bank_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    to_pw_bank_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    payment_for: 'payment'
  })
};

fetch('https://api.paywint.com/api/platform/payment/create-payment', 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.paywint.com/api/platform/payment/create-payment",
  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([
    'user_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'payee_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'amount' => 123,
    'invoice_no' => 'INV-2024-001234',
    'card_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'bank_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'description' => '<string>',
    'payment_descriptor' => '<string>',
    'payee_card_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'payee_bank_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'to_pw_bank_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'payment_for' => 'payment'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Platform-ID: <x-platform-id>",
    "X-Signature: <x-signature>"
  ],
]);

$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.paywint.com/api/platform/payment/create-payment"

	payload := strings.NewReader("{\n  \"user_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"amount\": 123,\n  \"invoice_no\": \"INV-2024-001234\",\n  \"card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"description\": \"<string>\",\n  \"payment_descriptor\": \"<string>\",\n  \"payee_card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"to_pw_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payment_for\": \"payment\"\n}")

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

	req.Header.Add("X-Platform-ID", "<x-platform-id>")
	req.Header.Add("X-Signature", "<x-signature>")
	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.paywint.com/api/platform/payment/create-payment")
  .header("X-Platform-ID", "<x-platform-id>")
  .header("X-Signature", "<x-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"amount\": 123,\n  \"invoice_no\": \"INV-2024-001234\",\n  \"card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"description\": \"<string>\",\n  \"payment_descriptor\": \"<string>\",\n  \"payee_card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"to_pw_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payment_for\": \"payment\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paywint.com/api/platform/payment/create-payment")

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

request = Net::HTTP::Post.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"amount\": 123,\n  \"invoice_no\": \"INV-2024-001234\",\n  \"card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"description\": \"<string>\",\n  \"payment_descriptor\": \"<string>\",\n  \"payee_card_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payee_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"to_pw_bank_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"payment_for\": \"payment\"\n}"

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

{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "payment_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "transaction_id": 1501,
    "payer_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "amount": 100,
    "processing_fee": 1.5,
    "delivery_fee": 0.5,
    "invoice_no": "INV-2024-001234",
    "currency": "USD",
    "description": "June invoice for services",
    "created_at": "2025-06-16T10:04:51.739761Z",
    "payment_date": "2025-06-16T10:13:16.749655Z",
    "status": "success",
    "card_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_card_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "to_pw_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "failure_reason": "Insufficient wallet balance",
    "payout_currency": "INR",
    "payout_amount": 8500,
    "exchange_rate": 84.91,
    "payment_method": "WALLET",
    "receiving_method": "WALLET"
  },
  "queryGeneratedTime": 1718006400
}

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

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.

Body

application/json

user_id

string<uuid>

required

Unique identifier (UUID) of the user initiating the payment.

Example:

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

payee_id

string<uuid>

required

Unique identifier (UUID) of the recipient receiving the funds.

Example:

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

amount

number

required

Amount to be paid

payment_method

enum<string>

required

Payment source selected by the payer (e.g., WALLET, CARD).

Available options:

WALLET,

CARD,

PW_BANK

invoice_no

string

required

Invoice or transaction reference number for tracking and record-keeping purposes.

Maximum string length: 20

Example:

"INV-2024-001234"

receiving_method

enum<string>

required

Destination for the received funds (e.g., WALLET, CARD, ACH, PW_BANK, RTP, FEDNOW).

Available options:

WALLET,

CARD,

ACH,

PW_BANK,

RTP,

FEDNOW

card_id

string<uuid> | null

UUID of the payer’s card to be charged (required if using CARD as the payment method).

Example:

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

bank_id

string<uuid> | null

UUID of the payer's source bank account to be debited when using ACH or PW_BANK.

Example:

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

description

string | null

Optional short note or description for the payment (e.g., invoice reference, service details).

Maximum string length: 255

payment_descriptor

string | null

Description to be shown in the statement. (Only available for RTP now)

Maximum string length: 50

payee_card_id

string<uuid> | null

UUID of the payee’s card to receive funds (required if receiving to CARD).

Example:

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

payee_bank_id

string<uuid> | null

UUID of the payee’s bank account to receive funds (required if receiving to ACH).

Example:

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

to_pw_bank_id

string<uuid> | null

UUID of the payee's Paywint bank account to receive funds when receiving to PW_BANK.

Example:

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

payment_for

enum<string>

default:payment

Indicates whether the payment is for a standard payment or subscription.

Available options:

payment,

subscription

Example:

"payment"

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

PlatformPaymentRead · object | null

The main response payload, if applicable

Show child attributes

queryGeneratedTime

number | null

default:1783679844.273462

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

Example:

1718006400

Users

KYC & KYB

Wallet

Payments

Accept Payments

Cross Border Payments

Bank Accounts

Paywint Bank Accounts

Cards

Check

Payee Management

Payee Bank Accounts

Payee Cards

Payee Addresses

Headers

Body

Response