Create payment request

Create a new payment request. Once created, call the Transfer funds endpoint to execute the payment.

For additional information, see the Payment requests guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payload object for Create payment request (v1/payment-requests).

to
object
required

Payment method for Pismo account transfers.

from
object

Payment method for Pismo account transfers.

float
required
≥ 0.01

Payment request amount.

string

Payment request processing code.

date-time

Payment request expiration date in UTC-0 (RFC3339) format.

string

Optional unique ID correlating the payment request's associated credit and debit authorizations.

metadata
object

This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation.

The Pismo platform does not perform any validation or processing on this field but passes this object to the acquirer in transactions involving calls to the acquirer and sends it in the events related to the stream of data produced at the end of the request.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

location
object

Request latitude and longitude object.

Headers
string
required
length between 39 and 39
TN\-[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}

Unique Org ID.

string

Source account ID (optional). Can be ommited if from specifies the source account ID.

string

Related correlation identifier. If none is provided, a random one is generated.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json