Create and send a one-time payment request.

post

https://api.securelyme.io/payment-requests/one-time

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

double

required

≥ 0.01

Invoice amount for the payment request (>= $0.01).

message

string

required

length between 1 and 2500

Message to the customer that is included when viewing the payment request.

internalNotes

string

length ≤ 250

Internal notes for the payment request, not viewable to the customer.

invoiceNumber

string

required

length ≥ 1

Invoice number from the api consumer system to help identify the payment request.

externalIdentifier

string

External identifier for payment request. Expected to be a unique identifier from the API consumer's system.

attachment

object

customerUserId

int32

required

0 to 2147483647

Securely customer id to create the payment request for.

alternatePricingPlanId

int32

Primary/Customer assigned plan used by default if not supplied.

sendNotice

boolean

Indicates if an email/text should be sent to the customer informing them about the payment request. Default is true.

sendReceipt

boolean

Indicates if an email/text should be sent to the customer informing them when a payment has completed. Default is true.

terminalSerialNumber

string

The serial number of the terminal the payment request should be sent

paymentRequestReference

uuid

Payment request reference Guid.

Response

200Created payment request id.