Revoke a handle's connection

client.paymentHandles.revoke(, ?): PaymentHandleConnection { connect_id, handle, status }

DELETE/v3/payments/handles/{handle}/connection

Revokes this partner’s grant for the customer. Only your grant is removed; the customer’s wallet at the provider is untouched.

ParametersExpand Collapse

handle: string

ReturnsExpand Collapse

PaymentHandleConnection { connect_id, handle, status }

connect_id?: string

Returned only by connect, and only while the ceremony is pending. Nothing on our side persists it — it comes back from the provider and is required again to verify — so hold it until you submit the code.

handle?: string

status?: "not_connected" | "pending" | "connected" | "revoked"

One of the following:

"not_connected"

"pending"

"connected"

"revoked"

Revoke a handle's connection

import LinqAPIV3 from '@linqapp/sdk';

const client = new LinqAPIV3({
  apiKey: process.env['LINQ_API_V3_API_KEY'], // This is the default and can be omitted
});

const paymentHandleConnection = await client.paymentHandles.revoke('handle');

console.log(paymentHandleConnection.connect_id);

{
  "connect_id": "cs_01HZY8",
  "handle": "+14155550123",
  "status": "connected"
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2001/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}

Returns Examples

{
  "connect_id": "cs_01HZY8",
  "handle": "+14155550123",
  "status": "connected"
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2001/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}