Get contact payment method

Retrieves the saved card on file for a contact, or null when none is saved. One card is supported per contact.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Path Parameters

idRequiredstring

Contact id, discoverable via list_contacts

GET/v1/contacts/{id}/payment-methods

curl -X GET "https://api.3common.com/v1/contacts/string/payment-methods" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": {
    "id": "string",
    "contactId": "string",
    "card": {
      "brand": "string",
      "last4": "string",
      "expMonth": -9007199254740991,
      "expYear": -9007199254740991,
      "country": "string",
      "funding": "string"
    },
    "billingDetails": {
      "name": "string",
      "email": "string",
      "phone": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    },
    "status": "active",
    "detachedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

TypeScript

export interface Response {
  data: {
    id: string;
    contactId: string;
    card: {
      brand: string;
      last4: string;
      expMonth: number;
      expYear: number;
      country?: string;
      funding?: string;
    };
    billingDetails?: {
      name?: string;
      email?: string;
      phone?: string;
      addressLine1?: string;
      addressLine2?: string;
      city?: string;
      state?: string;
      postalCode?: string;
      country?: string;
    };
    status: "active" | "detached" | "expired";
    detachedAt?: string;
    createdAt: string;
    updatedAt: string;
  } | null;
}