Sign in
PaymentRequests

Get payment request

Get a payment request

get/payment-requests/{paymentRequestId}

Path parameters

paymentRequestIdstring required

Payment request ID (prq_*).

Query parameters

partyIdstring

Effective party ID (pty_*) for delegated payment request access.

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

Changed in 5 of the 28 revisions of this API.113

  • 359d267dca881See the full diff
    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

  • b1ad79e918ac1See the full diff
    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

  • ba1fb54c59391See the full diff
    • ○

      added the required property data/attributes/tags to the response with the 200 status

      response-required-property-added

  • 270e233e401c18See the full diff
    • ▲

      the data/attributes/description/anyOf[subschema #1]/ response property's maxLength was unset from 500 for the response status 200

      response-property-max-length-unset

    • ○

      added the required property data/attributes/initiatorAgent to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/attributes/initiatorParty to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/attributes/payerCanDecline to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/attributes/payerCanPay to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/attributes/payerHandle to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/attributes/requesterHandle to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/attributes/walletName to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/relationships/payerAgent to the response with the 200 status

      response-required-property-added

  • 8cc2aed458472See the full diff
    • ○

      added the required property data/attributes/payerAvatarUrl to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/attributes/requesterAvatarUrl to the response with the 200 status

      response-required-property-added