Blockstream Enterprise

Request

RecipientsAddRequest

interface RecipientsAddRequest {
  action: 'add'
  resource: '/recipients'
  details: {
    id: string
    type: 'individual' | 'company'
    name: string
    email: string | undefined
    description: string | undefined
    payment_details: {
      name: string
      type: 'wallet' | 'address'
      value: string
    } []
  }
}

Prop

Type

Response

RecipientsAddResponse_success

interface RecipientsAddResponse_success {
  status: 'success'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
  details: {
    id: string
    type: 'individual' | 'company'
    name: string
    email: string | undefined
    description: string | undefined
    payment_details: {
      id: string
      name: string
      type: 'wallet' | 'address'
      value: string
      created_at: string
      created_by: string
    } []
    recipient_groups: {
      id: string
      type: 'whitelist' | 'blacklist'
    } []
    created_at: string
    created_by: string
    updated_at: string
    updated_by: string
  }
  metadata: unknown
}

Prop

Type

RecipientsAddResponse_failed | pending | unauthorized | rejected

interface RecipientsAddResponse_failed | pending | unauthorized | rejected {
  status: 'failed' | 'pending' | 'unauthorized' | 'rejected'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
}

Prop

Type

Example

import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'

const response = await broadcastRequest<
  typeof resourceSchema.shape.recipients.shape.add
>(
  {
    action: 'add',
    resource: '/recipients',
    details: {
      // TODO: fill in required fields
    },
  },
  blockstream,
)

Add Recipients

Request

Response

Example

On this page