POST
/
api
/
v1
/
payments
/
create
curl --request POST \
  --url https://cashpay.space/api/v1/payments/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cashTag": "<string>",
  "amount": 123,
  "isWhiteLabel": false,
  "callbackUrl": "<string>",
  "returnUrl": "<string>"
}'
{
  "id": "<string>",
  "paymentUrl": "<string>",
  "cashTag": "<string>",
  "note": "<string>",
  "amount": 123,
  "isWhiteLabel": true,
  "receiptId": "<string>",
  "paidAmount": 123,
  "status": "PENDING",
  "returnUrl": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
cashTag
string
required

The cash tag for the payment

​
amount
number
required

The amount of the payment

​
isWhiteLabel
boolean
default:false

Whether the payment is white-labeled

​
callbackUrl
string

The URL to call back after payment processing

​
returnUrl
string

The URL to return to after payment

Response

200
application/json
Successfully created payment invoice
​
id
string

The ID of the payment invoice

​
paymentUrl
string

The URL where the user can make the payment

​
cashTag
string

The CashTag of the payment recipient

​
note
string

The required note associated with the payment

​
amount
number

The amount invoiced

​
isWhiteLabel
boolean

Whether the payment is white-labeled

​
receiptId
string | null

The ID of the web receipt for the payment

​
paidAmount
number | null

The amount paid

​
status
enum<string>
Available options:
PENDING,
UNDER_PAID,
PAID,
FAILED,
EXPIRED
​
returnUrl
string | null

The URL where the user will be redirected after the payment

​
expiresAt
string

The date and time when the payment expires

​
createdAt
string

The date and time when the payment was created