Create Payment Link

post

https://sandbox-api.prioritycommerce.com/v1/checkout/v3/device

Create a shareable payment link that directs customers to a hosted payment page for collecting payments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

echo

boolean

Defaults to true

If true, the API will echo the full payment resource in the response body

Body Params

Device information.

Device class

name

string

required

Display name of the device as shown to the merchant

description

string

Optional description to help identify or explain the purpose of the device

deviceType

string

enum

Type of device used for processing payments

Allowed:

deviceTypeName

string

Name of the device type.

enabled

boolean

Indicates whether the device is currently active and allowed to process transactions

onSuccessUrl

string

URL where the user is redirected after a successful payment

onFailureUrl

string

URL where the user is redirected after a failed payment

merchantId

int32

Merchant ID

MinPaymentAmount

double

Minimum payment amount allowed when using the payment link

MaxPaymentAmount

double

maximum payment amount allowed when using the payment link

string

Email address associated with the merchant account

InvoiceFieldEnabled

boolean

Indicates whether the invoice number field is enabled for payments on this device.

Responses

201

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Entity

500Internal Server Error

503Service Unavailable