v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Retrieve Enrolled Payment Method by Id PCI data

get/customers/{customer_id}/payment-methods/{payment_method_id}

Path parameters

customer_idstring required

The unique identifier of the customer, created using the Create Customer endpoint (UUID, 36 chars).

payment_method_idstring required

The unique identifier of the payment_method. This information was received as the vaulted_token by enrolling a payment method using Enroll Payment Method (UUID, 36 chars).

Response

200

idempotency_keystring

idstring

account_idstring

namestring

descriptionstring

typestring

categorystring

countrystring

statusstring

sub_statusstring nullable

Additional status detail.

vaulted_tokenstring

actionstring

redirect_urlstring nullable

URL to redirect the customer to, for redirect workflows.

created_atstring

updated_atstring

last_successfully_usedboolean nullable

Whether the payment method was successfully used at least once.

last_successfully_used_atstring nullable

Timestamp of the last successful use (ISO 8601).

preferredboolean nullable

Whether this is the customer's preferred payment method.

Example response

{
  "idempotency_key": "2ca58c6d-8794-4c8f-a2f6-bba4b7498b74",
  "id": "2fd6bf11-2129-4061-9c2a-34e196f89753",
  "account_id": "493e9374-510a-4201-9e09-de669d75f256",
  "name": "VISA ****1111",
  "description": "VISA ****1111",
  "type": "CARD",
  "category": "CARD",
  "country": "US",
  "status": "ENROLLED",
  "vaulted_token": "7ced7717-f860-4705-a376-58a714953de9",
  "action": "FORM",
  "created_at": "2024-06-04T12:47:46.992602Z",
  "updated_at": "2024-06-04T12:47:46.992603Z",
  "provider": {
    "id": "YUNO",
    "type": "YUNO",
    "token": "e47299a5-269e-42a1-9be1-9f64e400413a"
  },
  "customer_payer": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "gender": "M",
    "date_of_birth": "1990-02-28",
    "document": {
      "document_number": "123456789",
      "document_type": "SSN"
    },
    "phone": {
      "number": "5551234567",
      "country_code": "1"
    },
    "billing_address": {
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 4B",
      "country": "US",
      "state": "NY",
      "city": "New York",
      "zip_code": "10001"
    }
  },
  "card_data": {
    "number": "4111111111111111",
    "iin": "41111111",
    "lfd": "1111",
    "expiration_month": 3,
    "expiration_year": 26,
    "number_length": 16,
    "security_code_length": 3,
    "brand": "VISA",
    "issuer": "JPMORGAN CHASE BANK N A",
    "category": "CREDIT",
    "type": "CREDIT",
    "fingerprint": "55a7fe38-cdc3-45dc-8c5f-820751799c76",
    "network_token": {
      "network": "VISA",
      "number": "4895370000004321",
      "status": "ACTIVE",
      "par": "V0010013022182956191212272716",
      "network_token_id": "DM4MMC1GB000000011cdd1c11c874e27",
      "token_data": {
        "iin": "489537",
        "lfd": "4321",
        "expiration_month": 9,
        "expiration_year": 2030
      },
      "response": {
        "code": "00",
        "message": "Approved"
      }
    }
  }
}