latestOpenAPI 3.1.12026-08-239938.6 MB

b1ad79e918ac

ACH4

Agent Keys4

Agents5

API Keys4

Approvals4

Customers6

Events3

External Accounts3

External Parties3

External Party Accounts3

Invitation Links4

Invitations3

Parties9

PaymentRequests7

Payments4

Simulations9

postInvite test customer
postFund test customer
postLink test bank account
postComplete payment claim
postFulfill payment request as test payer
postDecline payment request as test payer
postAccept customer invitation as test customer
postDecline customer invitation as test customer
postRevoke agent access as test customer

Transactions2

Transfers5

Wallets11

Webhooks6

Simulations

Complete payment claim

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

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

Path parameters

paymentIdstring required

Headers

X-Agent-IDstring nullable

Deprecated: agent identity comes from the credential. Sending this header with a party API key or user credential returns 403 agent_credential_required.

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response