PaymentRequests

Create payment request

Create a payment request

post/payment-requests

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 7 of the 28 revisions of this API.3416

Aug 27, 2026359d267dca881See the full diff
- ○
  deleted the header request parameter X-Agent-ID with deprecation
  request-parameter-removed-with-deprecation
Aug 23, 2026b1ad79e918ac11See the full diff
- ●
  removed the request property data/attributes/disableNotifications
  request-property-removed
- ○
  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 201 status
  response-required-property-added
Aug 2, 2026983d5c23452211See the full diff
- ●
  removed the request property data/attributes/suppressNotifications
  request-property-removed
- ○
  added the new optional request property data/attributes/disableNotifications
  new-optional-request-property
Jul 31, 20268a3cf2b14c081See the full diff
- ○
  added the new optional request property data/attributes/suppressNotifications
  new-optional-request-property
Jul 26, 2026270e233e401c328See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the data/attributes/payer request property anyOf list
  request-property-any-of-removed
- ▲
  the data/attributes/description request property's maxLength was decreased to 80
  request-property-max-length-decreased
- ▲
  the data/attributes/description/anyOf[subschema #1]/ response property's maxLength was unset from 500 for the response status 201
  response-property-max-length-unset
- ●
  for the header request parameter Idempotency-Key, the maxLength was set to 255
  request-parameter-max-length-set
- ●
  the data/attributes/payerName request property's maxLength was set to 32
  request-property-max-length-set
- ○
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the data/attributes/payer request property anyOf list
  request-property-any-of-added
- ○
  added the required property data/attributes/initiatorAgent to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/attributes/initiatorParty to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/attributes/payerCanDecline to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/attributes/payerCanPay to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/attributes/payerHandle to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/attributes/requesterHandle to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/attributes/walletName to the response with the 201 status
  response-required-property-added
Jul 14, 20268cc2aed458472See the full diff
- ○
  added the required property data/attributes/payerAvatarUrl to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/attributes/requesterAvatarUrl to the response with the 201 status
  response-required-property-added

Full history