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_*).

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.

partyIdstring

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

Successful Response

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

Aug 27, 2026359d267dca881See the full diff
- ○
  deleted the header request parameter X-Agent-ID with deprecation
  request-parameter-removed-with-deprecation
Aug 23, 2026b1ad79e918ac1See the full diff
- ○
  header request parameter X-Agent-ID was deprecated
  request-parameter-deprecated
Aug 13, 2026ba1fb54c59392See the full diff
- ○
  added the new optional request property data/attributes/tags
  new-optional-request-property
- ○
  added the required property data/attributes/tags to the response with the 200 status
  response-required-property-added
Aug 9, 20260123533d83611See the full diff
- ○
  the request property data/attributes/paymentSource/anyOf[subschema #1]/walletId became optional
  request-property-became-optional
Jul 26, 2026270e233e401c112See the full diff
- ▲
  removed subschema #1 subschema #2 from the data/attributes/paymentSource 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 data/attributes/paymentSource request property anyOf list
  request-property-any-of-added
- ○
  added the required property data/relationships/senderAgent to the response with the 200 status
  response-required-property-added