NAnatural
Simulations

Sandbox: settle a card payment

Changed on

Simulate settlement of a successful card payment into the receiving wallet. Sandbox only.

post/simulations/card-payments/{cardPaymentId}/settle

Request

  • Base URL
    https://api.sandbox.natural.com
  • URL
    https://api.sandbox.natural.com/simulations/card-payments/{cardPaymentId}/settle
  • Auth
    HTTP bearer

Path parameters

cardPaymentIdstring required

Card payment ID (cpy_*). The payment must have succeeded.

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

  • 46c3e5516668Revision changes
    • warning

      added the new api enum value to the // response property for the response status

    • warning

      added the new authorized enum value to the // response property for the response status

    • warning

      added the new canceled enum value to the // response property for the response status

    • info

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

  • 84d3e68026cfRevision changes
    • info

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