For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get support
HomeDocsAPI ReferenceRelease Notes
HomeDocsAPI ReferenceRelease Notes
  • Payments API
    • POSTRefresh API Keys
    • POSTCharge
    • POSTCapture
    • POSTVoid or Refund
    • POSTCheck Surcharge
    • POSTCreate Hosted Payment Page
    • PUTEdit Hosted Payment Page
    • POSTCreate Vault Payment Account
    • GETGet Vault Payment Account
    • DELDelete a Vault Payment Account
    • PUTUpdate Vault Account Details
    • POSTCreate Billing Plan
    • GETGet Billing Plan
    • DELCancel Billing Plan
  • Authentication (Reporting & Boarding)
    • POSTGet access token
  • Reporting API
    • GETGet transactions data
    • GETGet deposits data
    • GETGet chargebacks data
    • GETGet adjustments data
  • Boarding API
    • GETList merchants
    • POSTCreate a new merchant
    • GETGet a single merchant
Get support
LogoLogo

Get Vault Payment Account

GET
https://javelin.runpayments.io/api/v1/vault_payment_accounts/:uuid
GET
/api/v1/vault_payment_accounts/:uuid
$curl https://javelin.runpayments.io/api/v1/vault_payment_accounts/uuid \
>     -H "Authorization: Bearer <token>"
1{
2  "id": 1024,
3  "vaults_id": "vault_987654321",
4  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5  "mid": "MID123456789",
6  "account_token": "tok_1Hh1YZ2eZvKYlo2C0a1b2c3d4e",
7  "card_brand_id": "1",
8  "vault_account_type_id": "1",
9  "name": "John A. Doe",
10  "nickname": "Personal Visa",
11  "last_four": "4242",
12  "expiration": "2026-11",
13  "account_zip": "94107",
14  "address1": "123 Market St",
15  "address2": "Suite 400",
16  "city": "San Francisco",
17  "region": "CA",
18  "country": "US",
19  "email": "john.doe@example.com",
20  "phone": "+14155552671",
21  "custom_06": "Preferred customer",
22  "custom_07": "Loyalty tier: Gold",
23  "entry_class": "PPD",
24  "is_deleted": "0",
25  "is_default": "1",
26  "updated": "2024-01-15T09:30:00Z",
27  "updated_by": "system_admin",
28  "created": "2023-06-10T14:22:00Z",
29  "created_by": "system_admin",
30  "profile_id": "profile_123456",
31  "ach_acct_type_id": "1",
32  "product_id": "prod_visa_001"
33}
Retrieve details of a vault payment account by uuid
Was this page helpful?
Previous

Delete a Vault Payment Account

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

uuidstringRequired
The UUID of the payment account to get

Response

Vault payment account retrieved successfully
idinteger
Internal database ID for the vault record
vaults_idstring
Legacy vault identifier
uuidstringformat: "uuid"
Universal unique identifier for the payment account
midstring
Merchant ID associated with this vault
account_tokenstring
Tokenized representation of the payment account
card_brand_idstring

Identifier for the card brand/network (1=Visa, 2=Mastercard, 3=Amex, 4=Discover)

vault_account_type_idstring

Identifier for the account type (1=Credit, 2=Debit, 3=Checking, 4=Savings)

namestring
Cardholder or account holder name
nicknamestring or null

User-defined friendly name for the payment method

last_fourstring
Last four digits of the account number
expirationstring or null

Card expiration date (for card accounts)

account_zipstring

Billing address ZIP/postal code

address1string
Billing address line 1
address2string or null

Billing address line 2 (optional)

citystring
Billing address city
regionstring

Billing address state/province/region

countrystring
Billing address country code
emailstring
Customer email address
phonestring
Customer phone number
custom_06string or null

Custom field for merchant-specific data

custom_07string or null

Custom field for merchant-specific data

custom_08string or null

Custom field for merchant-specific data

custom_09string or null

Custom field for merchant-specific data

custom_10string or null

Custom field for merchant-specific data

entry_classstring or null

ACH entry class code (for bank accounts)

is_deletedstring

Soft delete flag (0=Active, 1=Deleted)

is_defaultstring

Default payment method flag (0=Not Default, 1=Default)

updatedstringformat: "date-time"
Timestamp of last update
updated_bystring

User/system that last updated the record

createdstringformat: "date-time"
Timestamp when the vault was created
created_bystring

User/system that created the record

profile_idstring or null
Associated customer profile identifier
ach_acct_type_idstring or null

ACH account type identifier (1=Checking, 2=Savings)

product_idstring

Card product identifier (Gateway Product Identifier)

Errors

401
Unauthorized Error
404
Not Found Error