API Reference

Create payment request transaction for DataCap.

post
https://api.securelyme.io/payment-requests/transaction
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32

Payment request id if payment request is already created.

uuid

Payment request reference Guid. Invoice No in DataCap. Required if Payment Request Id is not supplied.

uuid
required
length ≥ 1

Transaction reference number. Ref No in DataCap.

double

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

string
length ≤ 2500

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

string
length ≤ 250

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

string

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

string

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

attachment
object
int32
0 to 2147483647

Securely customer id to create the payment request for.

int32

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

boolean

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

boolean

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

string

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

string
required
length ≥ 1

Transaction process request sent to the processor.

string
required
length ≥ 1

Transaction response received from the processor.

Response

Updated 9 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

Did this page help you?