Skip to main content
A payment request (prq_*) asks another party to pay you. When the payer fulfills it, Natural creates one payment for it, and that payment’s outcome sets the request’s status. To learn more, see Request a payment and Fulfill or decline a request.

Example

GET /payment-requests/{paymentRequestId}
The object is everything inside data. The field names below are relative to it: attributes.amount is data.attributes.amount in the response.

Fields

string
required
Resource type. Always paymentRequest.
string
required
Payment request ID (prq_*).
object
required
The payment request’s details.
object
required
Resources the payment request links to.

Statuses

Events

Other objects

These endpoints in the group don’t return this object:
  • Fulfill payment request (POST /payment-requests/{paymentRequestId}/fulfill) returns a payment object.

Endpoint differences

These endpoints return the object with a difference:
  • POST /payment-requests does not return the payment and wallet relationships; read the request to get them.

Errors

See the error codes these endpoints return.

Sandbox simulations