Skip to main content
POST
/
api
/
v1
/
merchants
/
whitelabel
/
create
Create a whitelabel payment invoice
curl --request POST \
  --url https://payvra.com/api/v1/merchants/whitelabel/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 1,
  "payCurrency": "<string>",
  "amountCurrency": "USD",
  "underPaidCover": 25,
  "feePaidByPayer": true,
  "lifeTime": 1440,
  "network": "<string>"
}
'
{
  "id": "<string>",
  "merchantId": "<string>",
  "paymentUrl": "<string>",
  "status": "PENDING",
  "address": "<string>",
  "txHash": "<string>",
  "amount": 123,
  "amountCurrency": "<string>",
  "rate": 123,
  "payAmount": 123,
  "cryptoCurrency": {
    "symbol": "<string>"
  },
  "network": {
    "network": "<string>"
  },
  "feePaidByPayer": true,
  "underPaidCover": 123,
  "isWhiteLabel": true,
  "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
​
amount
number
required

Amount for the payment invoice

Required range: x >= 0
​
payCurrency
string
required

Cryptocurrency symbol to be used for payment

​
amountCurrency
string
default:USD

Currency of the amount

​
underPaidCover
number

Percentage of underpayment that will be accepted

Required range: 0 <= x <= 50Must be a multiple of 0.1
​
feePaidByPayer
boolean

Whether the fee should be paid by the payer

​
lifeTime
number
default:1440

Invoice lifetime in minutes

Required range: 1 <= x <= 1440
​
network
string

Network to be used for the cryptocurrency

Response

Whitelabel payment invoice created successfully

​
id
string
​
merchantId
string
​
paymentUrl
string<uri>
​
status
enum<string>
Available options:
PENDING,
CONFIRMING,
UNDER_PAID,
PAID,
FAILED,
EXPIRED
​
address
string
​
txHash
string
​
amount
number
​
amountCurrency
string
​
rate
number
​
payAmount
number
​
cryptoCurrency
object
​
network
object
​
feePaidByPayer
boolean
​
underPaidCover
number
​
isWhiteLabel
boolean
​
returnUrl
string<uri>
​
expiresAt
string<date-time>
​
createdAt
string<date-time>