Skip to main content
POST
/
api
/
platform
/
payment
/
create-payment
Create Payment
curl --request POST \
  --url https://api.sandbox.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,
  "payment_method": "WALLET",
  "invoice_no": "INV-2024-001234",
  "receiving_method": "WALLET",
  "card_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "description": "<string>",
  "payment_descriptor": "<string>",
  "payee_card_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "payee_bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "payment_for": "payment"
}
'
{
  "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",
    "failure_reason": "Insufficient wallet balance",
    "payment_method": "WALLET",
    "receiving_method": "WALLET"
  },
  "queryGeneratedTime": 1718006400
}

Documentation Index

Fetch the complete documentation index at: https://developer.paywint.com/llms.txt

Use this file to discover all available pages before exploring further.

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 bank account to be debited (required if using ACH as the payment method).

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"

​
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

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