Create an invoice link

POST https://api.passimpay.io/v2/createorder

This endpoint allows you to create a new payment link for an invoice.

For displaying fiat currencies, this payment method must be enabled in your account settings. To enable it, please contact technical support.

Headers

Name	Type	Description
x-signature	string	SHA-256 encrypted signature
Content-Type	string	application/json

Request Body

Name	Type	Description
platformId	integer	Platform Id
orderId	string	Order ID of your platform. Type string, maximum length 64, allowed characters 'A-Za-z0-9+/=-:.,'
amount	string	The transaction amount. Format should have 2 decimals "100.00".
currencies	string	List the currency ID separated by commas. Not required. You can get the list of currency IDs here.
symbol	string	The currency for the amount field follows the ISO 4217 standard. It should be 3 characters in uppercase. This field is optional; if not provided, the default currency is USD.
type	integer	Currency type to display in the payment link: 0: display all currencies (both cryptocurrencies and fiat currencies) 1: display only cryptocurrencies 2: display only fiat currencies

Additional Client Information (Optional)

You can provide additional information about your client, although it is not mandatory. The following fields are supported:

Name	Type	Description
firstName	string	The first name of the client.
lastName	string	The last name of the client.
email	string	The client's email address.
phoneNo	integer	The client's phone number.
returnUrl	string	The returnUrl parameter specifies the URL to which the user should be redirected after payment. (works for INR symbol)

Successful response

Name	Type	Description
result	integer	Request result: 1: success 0: error
url	string	The URL of the payment link where the customer is redirected.

Error Response

Name	Type	Description
result	integer	Request result: 1: success 0: error
message	string	Error description