Collect recurring payment

POST/v1/payments/recurring-payments/{id}/collectRun in dashboard

If submission cannot be confirmed immediately, a 200 response returns the same transfer as processing with its known signature; reconciliation settles it, and the next due time advances only after exact on-chain confirmation.

Requires an API key with the recurring.execute action.

Path parametersCopy Anchor Link

• id · string · required · min length 1 · example prp_example

  SDP recurring payment record ID.

HeadersCopy Anchor Link

• x-project-id · string · min length 1 · example prj_example

  Required for dashboard sessions. API keys use their assigned project.

• Idempotency-Key · string · required

  Use a unique 1–255 printable ASCII key per operation. Reuse it with the same request on retries. An in-flight attempt returns 409; a changed request returns 422. Retry and recovery rules.

ResponsesCopy Anchor Link

• 200 Recurring payment collection result

  • data · object · required

    Recurring payment collection response payload.

    • recurringPayment · object · required

      SDP-custody outbound recurring payment record.

      • id · string · required · example prp_example

        SDP recurring payment ID.

      • organizationId · string · required · min length 1 · example org_example

        Organization identifier.

      • projectId · string · required · min length 1 · example prj_example

        Project identifier.

      • sourceCustodyWalletId · string | null · required · example cwlt_example

        Exact source SDP Wallet ID, or null for unresolved legacy records.

      • sourceProviderWalletId · string · required · min length 1 · example privy_wallet_123

        Source Provider wallet ID retained as evidence.

      • sourceAddress · string · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        Source wallet address.

      • counterpartyId · string · required · example cpty_example

        Counterparty ID.

      • counterpartyAccountId · string · required · example cpacct_example

        Counterparty account ID.

      • destinationAddress · string · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        Counterparty wallet owner address.

      • destinationTokenAccount · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        Derived counterparty token account used for collection.

      • token · string · required

        SPL token mint address.

      • amount · string · required · example 100.00

        Token amount in UI units (decimal string).

      • periodHours · integer · required · greater than 0 · example 720

      • firstCollectionAt · string | null · required · format date-time · example 2025-01-01T00:00:00.000Z

        Requested first collection timestamp.

      • nextCollectionDueAt · string | null · required · format date-time · example 2025-01-01T00:00:00.000Z

        Next due collection timestamp.

      • planId · string | null · required

        Linked SDP subscription plan ID.

      • subscriptionId · string | null · required

        Linked SDP subscription ID.

      • planPda · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        On-chain plan PDA.

      • planCreatedAt · string | null · required

        On-chain plan createdAt value as an unsigned integer string.

      • planCreationSignature · string | null · required

        Solana signature for plan creation.

      • subscriptionPda · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        On-chain subscription PDA.

      • subscriptionAuthorityAddress · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        On-chain subscription authority address.

      • authorizationSignature · string | null · required

        Solana signature for subscription authorization.

      • status · string · required · one of pending_activation, activating, active, updating, canceling, resuming, paused, canceled, expired · example active

        Recurring payment status.

      • pausedReason · string | null · required · one of custody_policy_refused, failed_attempts · example null

        Why SDP paused the recurring payment, set exactly while status is paused: custody_policy_refused when the custody provider's policy refused to sign a collection, failed_attempts when one due period failed 5 times. Resume clears it.

      • metadataUri · string | null · required

        Optional plan metadata URI.

      • createdBy · string | null · required

        Creator user ID or API key ID.

      • createdAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

      • updatedAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

    • collectionAttempt · object · required

      Recurring payment collection attempt record.

      • id · string · required · example psca_example

        Collection attempt ID.

      • organizationId · string · required · min length 1 · example org_example

        Organization identifier.

      • projectId · string · required · min length 1 · example prj_example

        Project identifier.

      • subscriptionId · string · required

        Subscription ID.

      • transferId · string | null · required · min length 1 · example xfr_example

        Payment transfer record ID when linked.

      • token · string · required

        Token mint or normalized token identifier.

      • amount · string · required · example 100.00

        Token amount in UI units (decimal string).

      • dueAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

      • attemptedAt · string | null · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

      • status · string · required · one of pending, processing, confirmed, failed, skipped · example pending

        Collection attempt status.

      • signature · string | null · required

        Solana transaction signature.

      • error · string | null · required

        Collection error, if any.

      • metadata · object · required

        Provider/job metadata for the attempt.

        One of:

        • source: "manual"

          • recurringPaymentId · string · required

          • initiatedByKeyId · string | null · required

          • source · string · required · always manual

        • source: "automated"

          • recurringPaymentId · string · required

          • initiatedByKeyId · string | null · required

          • source · string · required · always automated

        • source: "retry"

          • recurringPaymentId · string · required

          • initiatedByKeyId · string | null · required

          • source · string · required · always retry

          • initialSource · string · required · one of manual, automated

          • transferId · string | null · required

          • error · string · required

          • retryAfterAt · string · required

        • source: "linked_transfer"

          • recurringPaymentId · string · required

          • initiatedByKeyId · string | null · required

          • source · string · required · always linked_transfer

          • initialSource · string · required · one of manual, automated

          • transferId · string · required

      • createdAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

      • updatedAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

    • transfer · object · required

      Transfer transaction record.

      • fireblocks · object

        Native Fireblocks transfer tracking. A processing payment may await approval in Fireblocks; network fees are paid by its source vault. A missing transaction ID means submission is still being reconciled. Do not create a replacement payment while its outcome is unknown.

        • transactionId · string | null · required

        • status · string · required

        • subStatus · string | null · required

      • id · string · required · min length 1 · example xfr_example

        Transfer identifier (SDP record ID, not the on-chain signature).

      • organizationId · string · required · min length 1 · example org_example

        Organization identifier.

      • custodyWalletId · string | null · required · example cwlt_example

        Exact SDP Wallet ID associated with the persisted transfer, or null for unresolved legacy and observed rows.

      • providerWalletId · string · required · min length 1 · example privy_wallet_123

        Provider wallet ID retained as evidence; not an execution selector.

      • projectId · string · min length 1 · example prj_example

        Project identifier for the transfer.

      • type · string · required · example transfer

        Transfer type.

      • kind · string · required

        Dashboard transaction kind derived from the transfer type and originating Payments resource.

      • direction · string · required · one of inbound, outbound · example outbound

        Transfer direction.

      • status · string · required · one of pending, processing, confirmed, finalized, failed, awaiting_payment, settling, completed, canceled, expired · example confirmed

        Transfer status.

      • signature · string | null · required · example sig_example

        Solana transaction signature (tx id/hash).

      • serializedTx · string | null · required · min length 1 · example base64_tx_example

        Base64-encoded transaction payload, if available. Always null for transfer batch chunks, whose signed bytes stay server-side.

      • slot · integer | null · required · example 123456

        Slot number, if confirmed.

      • blockTime · string | null · required · format date-time · example 2025-01-01T00:00:00.000Z

        Block time, if confirmed.

      • confirmedAt · string · format date-time · example 2025-01-01T00:00:00.000Z

        When SDP confirmed the transfer. A ramp is confirmed once its delivery is verified onchain.

      • fee · integer | null · required · example 5000

        Transaction fee in lamports.

      • error · string | null · required · example Signature failed

        Error message if the transaction failed.

      • initiatedBy · object

        Initiator that triggered the transfer.

        • type · string · required · one of api_key, user, system · example api_key

          Initiator type.

        • id · string

          Initiator identifier if applicable.

        • display · string

          Human-friendly label for the initiator.

      • source · string · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        Source wallet address.

      • destination · string · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        Destination wallet address.

      • memo · string · max length 256

        Optional memo for the transfer.

      • rampsMemo · object · required

        Free-form key-value memo for offchain reconciliation of ramp transfers. At most 20 entries.

        • * · string · min length 1 · max length 256

      • token · string

        Token symbol or mint address.

      • amount · string · example 100.00

        Token amount in UI units (decimal string).

      • counterpartyId · string · example cpty_example

        Counterparty tied to the transfer record, when available.

      • counterpartyDisplayName · string · example Acme Studio

        Current display name of the counterparty tied to the transfer.

      • providerReference · string · example ramp_quote_example

        Provider quote or transaction reference used for ramp correlation.

      • deliveryMode · string · one of hosted, manual_instructions, session_widget · example session_widget

        Ramp delivery mode. Hosted flows require the customer to complete a provider-hosted UI; manual instructions require the customer to fund displayed instructions; session widgets use a provider SDK session.

      • fiatCurrency · string · example USD

        Fiat currency for the ramp leg.

      • fiatAmount · string · example 100.00

        Quoted fiat amount for the ramp leg: what the customer pays on an on-ramp, the payout quoted on an off-ramp. It never changes after the quote; an off-ramp's final payout is fiatPayout.

      • fiatPayout · object

        What the provider reports paying out once it settles an off-ramp sale. Provider-reported: SDP cannot verify a bank payout.

        • amount · string · required · example 20.82

          Fiat paid out, in display units. Differs from the quoted fiatAmount when the provider re-prices the sale at receipt.

        • currency · string · required · example USD

          ISO currency of the payout, as the provider reports it.

        • reportedAt · string · format date-time · example 2025-01-02T00:00:00.000Z

          When the provider reported the payout.

      • deliveryMismatch · object

        Present while SDP holds a provider-settled ramp in settling because the chain contradicts the provider's delivery. A new provider report clears it.

        • reason · string · required · one of provider_report_mismatch, transaction_failed, predates_transfer, not_delivered, amount_mismatch, transaction_not_found · example amount_mismatch

          Why the chain contradicts the provider: provider_report_mismatch (its report contradicts SDP's record), transaction_failed, predates_transfer (the transaction landed before the transfer), not_delivered (nothing of the quoted asset reached the quoted wallet), amount_mismatch, or transaction_not_found (no finalized transaction an hour after the report; SDP keeps checking, and a later delivery completes the transfer).

        • checkedAt · string · required · format date-time · example 2025-01-02T00:00:00.000Z

          When SDP's delivery check reached this verdict.

        • reportedAmount · string · example 20

          What the provider reported delivering, in display units.

        • observedAmount · string · example 0.5

          What the chain shows the quoted wallet received, in display units.

      • risk · object

        Optional risk evaluation for the transfer.

        • provider · string · required · example trm

          Risk scoring provider.

        • score · string · required · example 0.12

          Provider-specific risk score.

        • level · string · required · one of low, medium, high, unknown · example low

          Risk level classification.

        • evaluatedAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

          Timestamp when risk was evaluated.

      • createdAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        Creation timestamp.

      • updatedAt · string · required · format date-time · example 2025-01-02T00:00:00.000Z

        Last update timestamp.

  • meta · object · required

    Response metadata.

    • requestId · string · required · min length 1 · example req_example

      Request identifier for tracing.

    • timestamp · string · required · format date-time · example 2025-01-01T00:00:00.000Z

      ISO 8601 timestamp.

• 400 Bad Request

  • error · object · required

    Standard error payload.

    • code · string · required

      Machine-readable error code.

    • message · string · required

      Human-readable error message.

    • details · object

      Optional error details for debugging.

      • * · any

  • meta · object

    • requestId · string · min length 1 · example req_example

      Request identifier for tracing.

• 401 Unauthorized

  Same fields as 400.

• 403 Forbidden. Requires the recurring.execute action: an API key must hold it (a module's manage or execute also covers its read), and a signed-in member's organization role must include it. Without it the error is INSUFFICIENT_PERMISSIONS and error.details.action names the action. Any other 403 names its own reason.

  Same fields as 400.

• 404 Not Found

  Same fields as 400.

• 409 Conflict

  Same fields as 400.

• 422 Unprocessable Entity

  Same fields as 400.

• 500 Internal Server Error

  Same fields as 400.