Create customer payment method by external ID | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.customers.createPaymentMethod("externalId", {
        confirmationToken: "ctok_1GqIC8L2eZvKYlo2C0a1b2c3d4",
        returnUrl: "https://myapp.com/payment-methods/confirmation",
        metadata: {
            "source": "mobile_app",
        },
    });
}
main();

{
  "id": "pm_1GqID9L2eZvKYlo2XyZ7a8b9",
  "type": "card",
  "card": {
    "brand": "visa",
    "last4": "4242",
    "expMonth": 12,
    "expYear": 2026
  },
  "usBankAccount": {
    "bankName": "Wells Fargo",
    "last4": "6789",
    "accountType": "checking"
  },
  "isDefault": true,
  "createdAt": "2024-01-15T09:30:00Z"
}

Creates a new payment method for a customer using a Stripe confirmation token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

externalIdstringRequired

The external ID of the customer

Request

This endpoint expects an object.

confirmationTokenstringRequired

Stripe confirmation token for the payment method

returnUrlstringRequired

URL to redirect to after payment method setup

metadatamap from strings to anyOptional

Optional metadata to attach to the payment method

Response

Payment method created successfully

idstring or null

The payment method ID (typically from Stripe)

typeenum or null

The type of payment method

Allowed values:

cardobject or null

Card details (present when type is ‘card’)

usBankAccountobject or null

US bank account details (present when type is ‘us_bank_account’)

isDefaultboolean or null

Whether this is the customer's default payment method

createdAtdatetime or null

Authentication

Path parameters

Request

Response

Errors