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}
data. The field names below are relative to it: attributes.amount is data.attributes.amount in the response.
Fields
Statuses
Events
paymentRequest.created: A merchant created a payment request. The fee is assessed when the request is paid, so it’s null untilpaymentRequest.completed.paymentRequest.incoming, sent to the payer, never carries it.paymentRequest.completed: The linked payment for a payment request completed successfully.paymentRequest.canceled: A merchant canceled an open payment request.paymentRequest.declined: The payer declined an open payment request.paymentRequest.incoming: A payment request was created naming this party as the payer.
Other objects
These endpoints in the group don’t return this object:- Fulfill payment request (
POST /payment-requests/{paymentRequestId}/fulfill) returns apaymentobject.
Endpoint differences
These endpoints return the object with a difference:POST /payment-requestsdoes not return thepaymentandwalletrelationships; read the request to get them.
Errors
See the error codes these endpoints return.Sandbox simulations
- Sandbox: Fulfill a payment request: Pay a Sandbox payment request from the test payer’s funded wallet.
- Sandbox: Decline a payment request: Decline a payment request as a test payer in Sandbox.