NAnatural
PaymentRequests

Get payment request

Changed on

Get a payment request

get/payment-requests/{paymentRequestId}

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/payment-requests/{paymentRequestId}
  • Auth
    HTTP bearer

Path parameters

paymentRequestIdstring required

Payment request ID (prq_*).

Query parameters

customerPartyIdstring

Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

  • b1bbe421e39fRevision changes
    • info

      added the required property //// to the response with the status

  • 897916372a74Revision changes
    • breaking

      removed the required property // from the response with the status

    • info

      added the required property // to the response with the status