PaymentRequests

Fulfill payment request

Fulfill an open payment request from a wallet or a verified linked bank account

post/payment-requests/{paymentRequestId}/fulfill

Path parameters

paymentRequestIdstring required

Payment request ID (prq_*).

Headers

Idempotency-Keystring required

Unique key for safely retrying a request without creating duplicates.

X-Instance-IDstring nullable

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

Request body

Response

Successful Response

Changes

Changed in 9 of the 50 revisions of this API.2227

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

  • bcf3b028c3e512See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

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

      response-required-property-added

  • a7210001d0d411See the full diff
    • ▲

      removed subschema #1 subschema #2 from the // request property anyOf list

      request-property-any-of-removed

    • ○

      added subschema #1 subschema #2 to the // request property anyOf list

      request-property-any-of-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      request-parameter-removed-with-deprecation

    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

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

      response-required-property-added

    • ○

      the request property //// became optional

      request-property-became-optional

  • 270e233e401c112See the full diff
    • ▲

      removed subschema #1 subschema #2 from the // request property anyOf list

      request-property-any-of-removed

    • ●

      for the header request parameter Idempotency-Key, the maxLength was set to 255

      request-parameter-max-length-set

    • ○

      added subschema #1 subschema #2 to the // request property anyOf list

      request-property-any-of-added

    • ○

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

      response-required-property-added