Creating a Recipient (optional)

Recipients define where funds should be sent. Create one with crypto settlement, fiat settlement, or both.

Crypto Recipient with Smart Wallet

Omit toAddress to auto-generate a smart wallet:

TypeScript

const recipient = await orda.recipients.create({
  name: 'Alice',
  cryptoSettlementDetails: {
    toChain: '8453',  // Base
    toToken: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'  // USDC
  }
});

console.log(recipient.smartWallet?.address);

Crypto Recipient with Specific Address

TypeScript

const recipient = await orda.recipients.create({
  name: 'Bob',
  cryptoSettlementDetails: {
    toChain: '8453',
    toToken: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913',
    toAddress: '0xYourRecipientAddress'
  }
});

Fiat Recipient (for Off-Ramp)

TypeScript

const recipient = await orda.recipients.create({
  name: 'Carlos',
  fiatSettlementDetails: {
    toCurrency: 'BRL',
    pixKey: '[e-mail]'
  },
  kycInformation: {
    taxId: '12345678901',
    taxIdCountry: 'BRA',
    email: '[e-mail]',
    name: 'Carlos Silva'
  }
});

Update Recipient

TypeScript

await orda.recipients.updateSettlement({
  recipientId: 'recipient-id',
  cryptoSettlementDetails: {
    toChain: '1',
    toToken: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'
  }
});

Deactivate Recipient

TypeScript

await orda.recipients.deactivate({
  recipientId: 'recipient-id'
});