Payments

Create payment

Create a payment

post/payments

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.339

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

      request-parameter-removed-with-deprecation

  • b1ad79e918ac11See the full diff
    • removed the request property data/attributes/disableNotifications

      request-property-removed

    • header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

    • 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

    • removed the request property data/attributes/suppressNotifications

      request-property-removed

    • added the new optional request property data/attributes/disableNotifications

      new-optional-request-property

    • the response property data/attributes/claimLink became optional for the status 201

      response-property-became-optional

    • added the new optional request property data/attributes/suppressNotifications

      new-optional-request-property

    • added the required property data/attributes/claimLink to the response with the 201 status

      response-required-property-added

  • 270e233e401c212See the full diff
    • removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the data/attributes/counterparty 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

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

      request-parameter-max-length-set

    • added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the data/attributes/counterparty request property anyOf list

      request-property-any-of-added

    • added the required property data/relationships/senderAgent to the response with the 201 status

      response-required-property-added