Payouts

Your balance of every asset you hold: available is free to pay out, pending is credited on a network with depth-based finality (Bitcoin) but not yet at its settle depth, and reserved is held for payouts and refunds under way.

await nowgate.balances.list();

client.balances.list()

$nowgate->balances->list();

Responses

An address of yours that payouts can pay. A new destination waits before it can be paid: 24 hours in live, 5 minutes in the sandbox. destination.created reaches your webhook endpoint at once, so your own systems can raise an alarm about an address nobody meant to add, and destination.active follows when it can be paid. Adding an address you already have returns that destination with 200.

await nowgate.payoutDestinations.create({ … });

client.payout_destinations.create(…)

$nowgate->payoutDestinations->create([…]);

Headers

• Idempotency-Keystringrequired

  A unique key for this request, such as a UUID: 1-255 visible ASCII characters, without spaces. Retrying with the same key and the same request replays the original response (for at least 24 hours); the same key with a different request is refused with 422 idempotency_key_reused. Failed requests are not stored, so they can be retried with the same key.

  1 to 255 characters. Pattern: ^[!-~]+$.

Body

• networkNetwork (string)required

  Network identifier; see GET /assets. New networks may be added.

• addressstringrequired

  1 to 128 characters.

• memo_typeMemoType (string)

  A Stellar memo's type. id is a number up to 2^64-1, text at most 28 bytes.

  One of: id, text.

• memostring

  Stellar only.

  1 to 28 characters.

• labelstring

  1 to 100 characters.

Responses

await nowgate.payoutDestinations.retrieve(id);

client.payout_destinations.retrieve(id)

$nowgate->payoutDestinations->retrieve($id);

Path parameters

• idPayoutDestinationID (string)required

Responses

await nowgate.payoutDestinations.list({ … });
for await (const item of nowgate.payoutDestinations.listAll({ … })) { … }

client.payout_destinations.list(…)
for item in client.payout_destinations.list_all(…): …

$nowgate->payoutDestinations->list([…]);
foreach ($nowgate->payoutDestinations->listAll([…]) as $item) { … }

Query parameters

• limitinteger

  From 1 to 100. Default: 20.

• starting_afterPayoutDestinationID (string)

  Return the page after (older than) this ID.

• ending_beforePayoutDestinationID (string)

  Return the page before (newer than) this ID.

Responses

Disables the destination at once. Payouts to it that haven't been sent fail with destination_disabled, and their amounts return to your available balance. A payout already sent can't be stopped. To pay the address again, add it again: it waits like any new destination.

await nowgate.payoutDestinations.disable(id);

client.payout_destinations.disable(id)

$nowgate->payoutDestinations->disable($id);

Path parameters

• idPayoutDestinationID (string)required

Responses

Pays an amount of an asset you hold to one of your destinations, given by its ID or by its address (a new address becomes a destination, and waits). The amount is reserved from your available balance at once. network_fee is quoted in the payout's own asset now and never changes; by default you pay it on top (fee_paid_by: merchant), or it comes out of the amount (payee).

await nowgate.payouts.create({ … });

client.payouts.create(…)

$nowgate->payouts->create([…]);

Headers

• Idempotency-Keystringrequired

  A unique key for this request, such as a UUID: 1-255 visible ASCII characters, without spaces. Retrying with the same key and the same request replays the original response (for at least 24 hours); the same key with a different request is refused with 422 idempotency_key_reused. Failed requests are not stored, so they can be retried with the same key.

  1 to 255 characters. Pattern: ^[!-~]+$.

Body

• destinationPayoutDestinationID (string)

  One of your destinations; or give address (and memo_type and memo) instead.

• networkNetwork (string)required

  Network identifier; see GET /assets. New networks may be added.

• assetAssetSymbol (string)required

  Asset symbol on the network; see GET /assets.

• addressstring

  1 to 128 characters.

• memo_typeMemoType (string)

  A Stellar memo's type. id is a number up to 2^64-1, text at most 28 bytes.

  One of: id, text.

• memostring

  1 to 28 characters.

• amountAmount (string)required

  A non-negative decimal amount in the asset's units, e.g. "12.5".

• fee_paid_byPayoutFeePaidBy (string)

  Who pays the network fee: merchant on top of the amount (the destination gets the whole amount), or payee out of it.

  One of: merchant, payee.

• external_idstring

  Your own reference, unique among your payouts.

  1 to 100 characters.

• webhook_urlstring

  This payout's events go here instead, signed with your default endpoint's secret.

• send_atTimestamp (string (date-time))

  Send no earlier than this, at most 30 days ahead.

• metadatamap of string

Responses

await nowgate.payouts.retrieve(id);

client.payouts.retrieve(id)

$nowgate->payouts->retrieve($id);

Path parameters

• idPayoutID (string)required

Responses

await nowgate.payouts.list({ … });
for await (const item of nowgate.payouts.listAll({ … })) { … }

client.payouts.list(…)
for item in client.payouts.list_all(…): …

$nowgate->payouts->list([…]);
foreach ($nowgate->payouts->listAll([…]) as $item) { … }

Query parameters

• limitinteger

  From 1 to 100. Default: 20.

• starting_afterPayoutID (string)

  Return the page after (older than) this ID.

• ending_beforePayoutID (string)

  Return the page before (newer than) this ID.

• statusPayoutStatus (string)

  One of: awaiting_address, awaiting_approval, scheduled, waiting_destination, queued, sending, finished, failed, canceled.

• batchPayoutBatchID (string)

Responses

Cancels a payout that hasn't been sent yet, and returns its reserved amount to your available balance. A payout being sent can't be canceled (payout_not_cancelable).

await nowgate.payouts.cancel(id);

client.payouts.cancel(id)

$nowgate->payouts->cancel($id);

Headers

• Idempotency-Keystringrequired

  A unique key for this request, such as a UUID: 1-255 visible ASCII characters, without spaces. Retrying with the same key and the same request replays the original response (for at least 24 hours); the same key with a different request is refused with 422 idempotency_key_reused. Failed requests are not stored, so they can be retried with the same key.

  1 to 255 characters. Pattern: ^[!-~]+$.

Path parameters

• idPayoutID (string)required

Responses

Up to 1,000 payouts at once, as items or as CSV text in csv (at most 256 KiB). The CSV's header row names its columns, in this order: network, asset, address, memo_type, memo, amount, fee_paid_by and external_id. Every item is checked before any is created: one bad item refuses the whole batch with invalid_items, listing every item's problem. Your limits apply to the batch's total, and its amounts are reserved together. Each item becomes a payout with its own ID and events. This request may be up to 512 KiB.

await nowgate.payoutBatches.create({ … });

client.payout_batches.create(…)

$nowgate->payoutBatches->create([…]);

Headers

• Idempotency-Keystringrequired

  A unique key for this request, such as a UUID: 1-255 visible ASCII characters, without spaces. Retrying with the same key and the same request replays the original response (for at least 24 hours); the same key with a different request is refused with 422 idempotency_key_reused. Failed requests are not stored, so they can be retried with the same key.

  1 to 255 characters. Pattern: ^[!-~]+$.

Body

• itemsarray of PayoutBatchItem (object)
  11 fields of PayoutBatchItem

  • destinationPayoutDestinationID (string)
  • networkNetwork (string)required

    Network identifier; see GET /assets. New networks may be added.

  • assetAssetSymbol (string)required

    Asset symbol on the network; see GET /assets.

  • addressstring

    1 to 128 characters.

  • memo_typeMemoType (string)

    A Stellar memo's type. id is a number up to 2^64-1, text at most 28 bytes.

    One of: id, text.

  • memostring

    1 to 28 characters.

  • amountAmount (string)required

    A non-negative decimal amount in the asset's units, e.g. "12.5".

  • fee_paid_byPayoutFeePaidBy (string)

    Who pays the network fee: merchant on top of the amount (the destination gets the whole amount), or payee out of it.

    One of: merchant, payee.

  • external_idstring

    1 to 100 characters.

  • webhook_urlstring
  • metadatamap of string
• csvstring

  The batch as CSV, its header row naming the columns as the operation describes.

  At most 262144 characters.

• send_atTimestamp (string (date-time))

Responses

await nowgate.payoutBatches.retrieve(id);

client.payout_batches.retrieve(id)

$nowgate->payoutBatches->retrieve($id);

Path parameters

• idPayoutBatchID (string)required

Responses

await nowgate.payoutBatches.list({ … });
for await (const item of nowgate.payoutBatches.listAll({ … })) { … }

client.payout_batches.list(…)
for item in client.payout_batches.list_all(…): …

$nowgate->payoutBatches->list([…]);
foreach ($nowgate->payoutBatches->listAll([…]) as $item) { … }

Query parameters

• limitinteger

  From 1 to 100. Default: 20.

• starting_afterPayoutBatchID (string)

  Return the page after (older than) this ID.

• ending_beforePayoutBatchID (string)

  Return the page before (newer than) this ID.

Responses

Your forwarding rules, one per asset you forward.

await nowgate.forwarding.retrieve();

client.forwarding.retrieve()

$nowgate->forwarding->retrieve();

Responses

Replaces your forwarding rules with these, all at once (an empty list stops forwarding). A rule forwards an asset to one of your active destinations: in payment mode each payment's credit as it reaches your available balance, in daily mode your whole available balance once a day at hour UTC. Nothing under min_amount is forwarded. Forwarding payouts are ordinary payouts with source: forwarding; the network fee comes out of them (fee_paid_by: payee), and they never wait for approval.

await nowgate.forwarding.update({ … });

client.forwarding.update(…)

$nowgate->forwarding->update([…]);

Body

• object"forwarding"

  Ignored in a request.

• rulesarray of ForwardingRule (object)required
  8 fields of ForwardingRule

  • networkNetwork (string)required

    Network identifier; see GET /assets. New networks may be added.

  • assetAssetSymbol (string)required

    Asset symbol on the network; see GET /assets.

  • destinationPayoutDestinationID (string)required

    An active destination of yours on the asset's network.

  • modeForwardingMode (string)required

    payment forwards each payment's credit; daily the whole available balance once a day.

    One of: payment, daily.

  • hourinteger

    The hour, UTC, of a daily rule; not given for payment.

    From 0 to 23.

  • min_amountAmount (string)

    Nothing smaller is forwarded (default 0); it stays in your balance.

  • created_atTimestamp (string (date-time))

    When the rule was first set; ignored in a request.

  • updated_atTimestamp (string (date-time))

    When it last changed; ignored in a request.

Responses

Nowgate POSTs payout.created, then payout.<status> on every change of a payout's status, signed and retried as payment events are. A payout with its own webhook_url sends its events there instead.

Headers

• Nowgate-Signaturestringrequired
• Nowgate-Event-IdEventID (string)required

Body

• idEventID (string)required
• object"event"required
• typestringrequired

  payout.created or payout.<status>.

  Example: "payout.finished".

• api_versionstringrequired

  Example: "2026-11-01".

• environmentstringrequired

  One of: live, sandbox, dev, test.

• created_atTimestamp (string (date-time))required
• dataobjectrequired
  1 fields

  • objectPayout (object)required
    24 fields of Payout

    • idPayoutID (string)required
    • object"payout"required
    • statusPayoutStatus (string)required

      One of: awaiting_address, awaiting_approval, scheduled, waiting_destination, queued, sending, finished, failed, canceled.

    • networkNetwork (string)required

      Network identifier; see GET /assets. New networks may be added.

    • assetAssetSymbol (string)required

      Asset symbol on the network; see GET /assets.

    • amountAmount (string)required

      A non-negative decimal amount in the asset's units, e.g. "12.5".

    • amount_sentAmount (string)required

      What the destination gets.

    • network_feeAmount (string)required

      The network fee, quoted in this asset when the payout was created.

    • payout_feeAmount (string)required

      Nowgate's payout fee.

    • amount_debitedAmount (string)required

      What your balance pays for it.

    • fee_paid_byPayoutFeePaidBy (string)required

      Who pays the network fee: merchant on top of the amount (the destination gets the whole amount), or payee out of it.

      One of: merchant, payee.

    • destinationPayoutDestination (object)required
      12 fields of PayoutDestination

      • idPayoutDestinationID (string)required
      • object"payout_destination"required
      • statusstringrequired

        One of: pending, active, disabled.

      • networkNetwork (string)required

        Network identifier; see GET /assets. New networks may be added.

      • addressstringrequired

        The address in its canonical form.

      • memo_typeMemoType (string)

        A Stellar memo's type. id is a number up to 2^64-1, text at most 28 bytes.

        One of: id, text.

      • memostring
      • labelstring
      • kindstringrequired

        refund when a payer gave it for a refund.

        One of: payout, refund.

      • active_atTimestamp (string (date-time))required

        When it became, or will become, payable.

      • created_atTimestamp (string (date-time))required
      • disabled_atTimestamp (string (date-time))
    • waiting_reasonstring

      Present on a queued payout that is waiting for something on Nowgate's side.

      One of: liquidity, gas_funding, fees, signer_limit.

    • failure_reasonstring

      Present on a failed payout.

    • external_idstring
    • batchPayoutBatchID (string)
    • send_atTimestamp (string (date-time))
    • approved_atTimestamp (string (date-time))
    • transactionstring

      The transaction that carries it

    • metadatamap of stringrequired
    • created_atTimestamp (string (date-time))required
    • updated_atTimestamp (string (date-time))required
    • closed_atTimestamp (string (date-time))
    • versioninteger (int64)required

      Increases with every change; use it to ignore stale webhook events.

Responses

destination.created as soon as a destination is added, so you can raise an alarm about an address nobody meant to add; destination.active when it can be paid; destination.disabled when it is disabled.

Headers

• Nowgate-Signaturestringrequired
• Nowgate-Event-IdEventID (string)required

Body

• idEventID (string)required
• object"event"required
• typestringrequired

  destination.created

• api_versionstringrequired

  Example: "2026-11-01".

• environmentstringrequired

  One of: live, sandbox, dev, test.

• created_atTimestamp (string (date-time))required
• dataobjectrequired
  1 fields

  • objectPayoutDestination (object)required
    12 fields of PayoutDestination

    • idPayoutDestinationID (string)required
    • object"payout_destination"required
    • statusstringrequired

      One of: pending, active, disabled.

    • networkNetwork (string)required

      Network identifier; see GET /assets. New networks may be added.

    • addressstringrequired

      The address in its canonical form.

    • memo_typeMemoType (string)

      A Stellar memo's type. id is a number up to 2^64-1, text at most 28 bytes.

      One of: id, text.

    • memostring
    • labelstring
    • kindstringrequired

      refund when a payer gave it for a refund.

      One of: payout, refund.

    • active_atTimestamp (string (date-time))required

      When it became, or will become, payable.

    • created_atTimestamp (string (date-time))required
    • disabled_atTimestamp (string (date-time))

Responses

batch.created when a batch is created, and batch.finished once every item is final. Each item also sends its own payout events.

Headers

• Nowgate-Signaturestringrequired
• Nowgate-Event-IdEventID (string)required

Body

• idEventID (string)required
• object"event"required
• typestringrequired

  batch.created or batch.finished.

• api_versionstringrequired

  Example: "2026-11-01".

• environmentstringrequired

  One of: live, sandbox, dev, test.

• created_atTimestamp (string (date-time))required
• dataobjectrequired
  1 fields

  • objectPayoutBatch (object)required
    9 fields of PayoutBatch

    • idPayoutBatchID (string)required
    • object"payout_batch"required
    • formatstringrequired

      One of: json, csv.

    • item_countintegerrequired
    • countsmap of integerrequired

      The items' counts, by status.

    • send_atTimestamp (string (date-time))
    • created_atTimestamp (string (date-time))required
    • finished_atTimestamp (string (date-time))

      When its last item became final.

    • itemsarray of Payout (object)

      The batch's payouts, in the order given; only in the creating response.

      24 fields of Payout

      • idPayoutID (string)required
      • object"payout"required
      • statusPayoutStatus (string)required

        One of: awaiting_address, awaiting_approval, scheduled, waiting_destination, queued, sending, finished, failed, canceled.

      • networkNetwork (string)required

        Network identifier; see GET /assets. New networks may be added.

      • assetAssetSymbol (string)required

        Asset symbol on the network; see GET /assets.

      • amountAmount (string)required

        A non-negative decimal amount in the asset's units, e.g. "12.5".

      • amount_sentAmount (string)required

        What the destination gets.

      • network_feeAmount (string)required

        The network fee, quoted in this asset when the payout was created.

      • payout_feeAmount (string)required

        Nowgate's payout fee.

      • amount_debitedAmount (string)required

        What your balance pays for it.

      • fee_paid_byPayoutFeePaidBy (string)required

        Who pays the network fee: merchant on top of the amount (the destination gets the whole amount), or payee out of it.

        One of: merchant, payee.

      • destinationPayoutDestination (object)required
      • waiting_reasonstring

        Present on a queued payout that is waiting for something on Nowgate's side.

        One of: liquidity, gas_funding, fees, signer_limit.

      • failure_reasonstring

        Present on a failed payout.

      • external_idstring
      • batchPayoutBatchID (string)
      • send_atTimestamp (string (date-time))
      • approved_atTimestamp (string (date-time))
      • transactionstring

        The transaction that carries it

      • metadatamap of stringrequired
      • created_atTimestamp (string (date-time))required
      • updated_atTimestamp (string (date-time))required
      • closed_atTimestamp (string (date-time))
      • versioninteger (int64)required

        Increases with every change; use it to ignore stale webhook events.

Responses

• idPayoutID (string)required
• object"payout"required
• statusPayoutStatus (string)required

  One of: awaiting_address, awaiting_approval, scheduled, waiting_destination, queued, sending, finished, failed, canceled.

• networkNetwork (string)required

  Network identifier; see GET /assets. New networks may be added.

• assetAssetSymbol (string)required

  Asset symbol on the network; see GET /assets.

• amountAmount (string)required

  A non-negative decimal amount in the asset's units, e.g. "12.5".

• amount_sentAmount (string)required

  What the destination gets.

• network_feeAmount (string)required

  The network fee, quoted in this asset when the payout was created.

• payout_feeAmount (string)required

  Nowgate's payout fee.

• amount_debitedAmount (string)required

  What your balance pays for it.

• fee_paid_byPayoutFeePaidBy (string)required

  Who pays the network fee: merchant on top of the amount (the destination gets the whole amount), or payee out of it.

  One of: merchant, payee.

• destinationPayoutDestination (object)required
  12 fields of PayoutDestination

  • idPayoutDestinationID (string)required
  • object"payout_destination"required
  • statusstringrequired

    One of: pending, active, disabled.

  • networkNetwork (string)required

    Network identifier; see GET /assets. New networks may be added.

  • addressstringrequired

    The address in its canonical form.

  • memo_typeMemoType (string)

    A Stellar memo's type. id is a number up to 2^64-1, text at most 28 bytes.

    One of: id, text.

  • memostring
  • labelstring
  • kindstringrequired

    refund when a payer gave it for a refund.

    One of: payout, refund.

  • active_atTimestamp (string (date-time))required

    When it became, or will become, payable.

  • created_atTimestamp (string (date-time))required
  • disabled_atTimestamp (string (date-time))
• waiting_reasonstring

  Present on a queued payout that is waiting for something on Nowgate's side.

  One of: liquidity, gas_funding, fees, signer_limit.

• failure_reasonstring

  Present on a failed payout.

• external_idstring
• batchPayoutBatchID (string)
• send_atTimestamp (string (date-time))
• approved_atTimestamp (string (date-time))
• transactionstring

  The transaction that carries it

• metadatamap of stringrequired
• created_atTimestamp (string (date-time))required
• updated_atTimestamp (string (date-time))required
• closed_atTimestamp (string (date-time))
• versioninteger (int64)required

  Increases with every change; use it to ignore stale webhook events.

• idPayoutDestinationID (string)required
• object"payout_destination"required
• statusstringrequired

  One of: pending, active, disabled.

• networkNetwork (string)required

  Network identifier; see GET /assets. New networks may be added.

• addressstringrequired

  The address in its canonical form.

• memo_typeMemoType (string)

  A Stellar memo's type. id is a number up to 2^64-1, text at most 28 bytes.

  One of: id, text.

• memostring
• labelstring
• kindstringrequired

  refund when a payer gave it for a refund.

  One of: payout, refund.

• active_atTimestamp (string (date-time))required

  When it became, or will become, payable.

• created_atTimestamp (string (date-time))required
• disabled_atTimestamp (string (date-time))

• idPayoutBatchID (string)required
• object"payout_batch"required
• formatstringrequired

  One of: json, csv.

• item_countintegerrequired
• countsmap of integerrequired

  The items' counts, by status.

• send_atTimestamp (string (date-time))
• created_atTimestamp (string (date-time))required
• finished_atTimestamp (string (date-time))

  When its last item became final.

• itemsarray of Payout (object)

  The batch's payouts, in the order given; only in the creating response.

  24 fields of Payout

  • idPayoutID (string)required
  • object"payout"required
  • statusPayoutStatus (string)required

    One of: awaiting_address, awaiting_approval, scheduled, waiting_destination, queued, sending, finished, failed, canceled.

  • networkNetwork (string)required

    Network identifier; see GET /assets. New networks may be added.

  • assetAssetSymbol (string)required

    Asset symbol on the network; see GET /assets.

  • amountAmount (string)required

    A non-negative decimal amount in the asset's units, e.g. "12.5".

  • amount_sentAmount (string)required

    What the destination gets.

  • network_feeAmount (string)required

    The network fee, quoted in this asset when the payout was created.

  • payout_feeAmount (string)required

    Nowgate's payout fee.

  • amount_debitedAmount (string)required

    What your balance pays for it.

  • fee_paid_byPayoutFeePaidBy (string)required

    Who pays the network fee: merchant on top of the amount (the destination gets the whole amount), or payee out of it.

    One of: merchant, payee.

  • destinationPayoutDestination (object)required
    12 fields of PayoutDestination

    • idPayoutDestinationID (string)required
    • object"payout_destination"required
    • statusstringrequired

      One of: pending, active, disabled.

    • networkNetwork (string)required

      Network identifier; see GET /assets. New networks may be added.

    • addressstringrequired

      The address in its canonical form.

    • memo_typeMemoType (string)

      A Stellar memo's type. id is a number up to 2^64-1, text at most 28 bytes.

      One of: id, text.

    • memostring
    • labelstring
    • kindstringrequired

      refund when a payer gave it for a refund.

      One of: payout, refund.

    • active_atTimestamp (string (date-time))required

      When it became, or will become, payable.

    • created_atTimestamp (string (date-time))required
    • disabled_atTimestamp (string (date-time))
  • waiting_reasonstring

    Present on a queued payout that is waiting for something on Nowgate's side.

    One of: liquidity, gas_funding, fees, signer_limit.

  • failure_reasonstring

    Present on a failed payout.

  • external_idstring
  • batchPayoutBatchID (string)
  • send_atTimestamp (string (date-time))
  • approved_atTimestamp (string (date-time))
  • transactionstring

    The transaction that carries it

  • metadatamap of stringrequired
  • created_atTimestamp (string (date-time))required
  • updated_atTimestamp (string (date-time))required
  • closed_atTimestamp (string (date-time))
  • versioninteger (int64)required

    Increases with every change; use it to ignore stale webhook events.

• networkNetwork (string)required

  Network identifier; see GET /assets. New networks may be added.

• assetAssetSymbol (string)required

  Asset symbol on the network; see GET /assets.

• destinationPayoutDestinationID (string)required

  An active destination of yours on the asset's network.

• modeForwardingMode (string)required

  payment forwards each payment's credit; daily the whole available balance once a day.

  One of: payment, daily.

• hourinteger

  The hour, UTC, of a daily rule; not given for payment.

  From 0 to 23.

• min_amountAmount (string)

  Nothing smaller is forwarded (default 0); it stays in your balance.

• created_atTimestamp (string (date-time))

  When the rule was first set; ignored in a request.

• updated_atTimestamp (string (date-time))

  When it last changed; ignored in a request.