Delete Recipient

This method allows you to delete an existing recipient from your recipient list in Rampable.

Method Signature

async deleteRecipient({recipientId: string, rampableAccessToken?: string}): Promise<DeleteRecipientResponse>

Parameters

recipientId: string - The unique identifier of the recipient to delete rampableAccessToken: string (optional) - The Rampable access token

ℹ️

A rampableAccessToken is required if you want to use rampable operations and not setup HTTP Signature Authentication (Personal Token)

Returns

Promise<DeleteRecipientResponse> - The deleted recipient object.

Example Usage

const deletedRecipient = await sdk.rampableRecipient.deleteRecipient('recipient_123');

Response Example

{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "bank": [
    {
      "accountName": "John Doe",
      "bankName": "Example Bank",
      "accountNumber": 23123232123,
      "paymentCode": "CODE123",
      "currency": "USD",
      "country": "UNITED STATES",
      "achNumber": "1",
      "fedwireNumber": "1",
      "ibanNumber": "1",
      "accountType": "Checking",
      "_id": "bank_123"
    }
  ],
  "organizationId": "org_123",
  "userId": "user_123",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "city": "New York",
  "postCode": "10001",
  "address": "123 Main St",
  "reference": "EMP001",
  "id": "recipient_123"
}

⚠️

This action cannot be undone. Make sure you have the correct recipient ID before proceeding with deletion.

For more information, see the Rampable Recipients API Documentation (opens in a new tab).

Create Recipient Update Recipient