Sign in
Payments

List recurring payments

Lists SDP-custody outbound recurring payments for the authenticated organization or project scope.

get/v1/payments/recurring-payments

Query parameters

counterpartyIdstring

Filter recurring payments by counterparty.

Example:cpty_example

Filter recurring payments by counterparty.

status'pending_activation' | 'activating' | 'active' | 'updating' | 'canceling' | 'resuming' | 'paused' | 'canceled' | 'expired'

Recurring payment status.

Example:active

Recurring payment status.

pageinteger
pageSizeinteger

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Response

Recurring payment list

Example response

{
  "data": {
    "recurringPayments": [
      {
        "id": "prp_example",
        "organizationId": "org_example",
        "projectId": "prj_example",
        "sourceWalletId": "privy_wallet_123",
        "sourceAddress": "So11111111111111111111111111111111111111112",
        "counterpartyId": "cpty_example",
        "counterpartyAccountId": "cpa_example",
        "destinationAddress": "So11111111111111111111111111111111111111112",
        "destinationTokenAccount": "So11111111111111111111111111111111111111112",
        "amount": "100.00",
        "periodHours": 720,
        "firstCollectionAt": "2025-01-01T00:00:00.000Z",
        "nextCollectionDueAt": "2025-01-01T00:00:00.000Z",
        "planPda": "So11111111111111111111111111111111111111112",
        "subscriptionPda": "So11111111111111111111111111111111111111112",
        "subscriptionAuthorityAddress": "So11111111111111111111111111111111111111112",
        "status": "active",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ]
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes

Changed in 1 of the 9 revisions of this API.4

  • 3e302bba53864See the full diff
    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 500

      response-property-enum-value-added