Prepare a payment - Atum Docs

A payment request has the same fields as a quote request, plus your signature in sender_auth. The signature authorizes the settlement vault to take up to max_source_amount of the source token from your wallet. You build and sign the request on your machine; Atum never sees your private key.

Fields

Field	Value
`depositor`	Your wallet: the account that pays and signs.
`sourceAsset`	The token you pay with, as a CAIP-19 identifier. Copy it from Supported assets.
`destinationAccount`	The recipient’s address on the destination chain.
`destinationAsset`	The token the recipient receives, as a CAIP-19 identifier.
`fulfillmentAmount`	What the recipient receives, in atomic units of the destination token. For USDC, `10000` is 0.01 USDC.
`maxSourceAmount`	The most that may leave your wallet: the amount delivered plus the settlement operator’s charge, in atomic units of the source token. Quotes above it are not accepted. Get a price quote to size it.
`requestId`	Your idempotency key for this payment. Reuse it only to retry the same payment.
`quoteDeadlineSeconds`, `fulfillmentDeadlineSeconds`	Optional; the SDK fills in defaults when you leave them out. For a large payment, pass a longer `fulfillmentDeadlineSeconds`. See Choosing a delivery deadline.
`settlerRequirements`	Optional. Limits which settlement operators may deliver. See Settlement operators on this payment.

The same token on two chains is two different assets. Copy the full CAIP-19 identifier, chain included.

Example

SDK
CLI

const paymentRequest = await client.preparePaymentRequest({
  depositor: SENDER,
  sourceAsset: SOURCE_ASSET,
  destinationAccount: RECEIVER,
  destinationAsset: DESTINATION_ASSET,
  fulfillmentAmount: '10000',
  maxSourceAmount: '10101',
  requestId: 'order-123',
});

Sign and submit it as in the SDK quickstart.

send-payment --gateway https://payment-gw.production-testnet.atum.xyz \
  --request-id order-123 \
  --max-source-amount 10101 \
  "$SENDER" 10000 \
  "$SOURCE" \
  "$RECEIVER" \
  "$DESTINATION"

send-payment builds, signs and submits in one step.

Then follow the payment as in After submission.

Next steps

Topic	Guide
Check prices before you pay	Get a price quote
The quote window and delivery deadline	Deadlines
Track a payment	After submission
One-time spend approval	Token approvals