NAnatural
Simulations

Complete payment claim

Changed on

Simulate the recipient of a held payment joining Natural and receiving the funds

post/simulations/payments/{paymentId}/complete-claim

Request

  • Base URL
    https://api.sandbox.natural.com
  • URL
    https://api.sandbox.natural.com/simulations/payments/{paymentId}/complete-claim
  • Auth
    HTTP bearer

Path parameters

paymentIdstring required

Payment ID (pay_*).

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

  • 897916372a74Revision changes
    • breaking

      removed the required property // from the response with the status

    • info

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

  • 6f76de3472aaRevision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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