24/7 Support: 800.608.6482

Navigation

CustomerPaymentCardList_Load_Query

This function is used to load a list of saved credit cards (payment cards) for a specific customer. Requires MivaPay to be enabled on the store.

Only one of the following request parameters is required: Customer_ID, Edit_Customer, Customer_Login

Request Body Parameters

count Type:
Number		 Title:
Count		 Count is used to tell Miva how many payment cards you want returned. If for example you are querying thousands of payment cards you'll want to set the count to limit how many you get back in a single request.
offset Type:
Offset		 Title:
Number		 Used in conjunction with the Count parameter for paginating results of large datasets. Default is 0 whcih is no offset.
sort Type:
String		 Title:
Sort		 Field to sort results by. Avaiilable sorting fields listed above. Use - prefix for a decending sort.
Filter Type:
Object		 Title:
Filter		 Array of Object containing search filters. See usage here: List Load Query Overview
customer_login Type:
String		 Title:
Customer Login		 Customer Login
edit_customer Type:
String		 Title:
Edit Customer		 Login of customer to edit
customer_id Type:
Number		 Title:
Customer ID		 Customer ID

Response Parameters

total_count Type:
Number		 Title:
Total Product Count		 total_count is the total number of records that match your search criteria. Note: this is not always the total products returned. Based on the Count and Offset parameters passed, the number of records returned could be different than the total_count.
start_offset Type:
Number		 Title:
Start Offset		 Number number of the starting offset number of products to return. Used in conjunction with the Count parameter for paginating results of large datasets.
id Type:
Number		 Title:
Payment Card ID		 The ID of the payment card
cust_id Type:
Number		 Title:
Customer ID		 Customer ID linked to Payment Card
fname Type:
String		 Title:
First Name		 First Name linked to Payment Card
lname Type:
String		 Title:
Last Name		 Last Name linked to Payment Card
exp_month Type:
Number		 Title:
Expiration Month		 Payment Card Expiration Month
exp_year Type:
Number		 Title:
Expiration Year		 Payment Card Expiration Year
lastfour Type:
Number		 Title:
Last Four		 Payment Card Last 4 Digits
addr1 Type:
String		 Title:
Address Line 1		 Payment Card Address Line 1
addr2 Type:
String		 Title:
Address Line 2		 Payment Card Address Line 2
city Type:
String		 Title:
City		 Payment Card City
state Type:
String		 Title:
State		 Payment Card State
zip Type:
String		 Title:
Zip Code		 Payment Card Zip Code
cntry Type:
String		 Title:
Country		 Payment Card Country Code
lastused Type:
Date/Time		 Title:
Last Used		 Date Time of Last Time Card was Used. 0 = not used.
token Type:
String		 Title:
Token		 MivaPay Payment Card Token
type_id Type:
Number		 Title:
Payment Card Type Id		 Payment Card Type Id. Defaults: 1 = Visa, 2 = Mastercard, 3 = American Express, 4 = Discover
refcount Type:
Number		 Title:
Reference Count		 Number of Subscriptions Payment Card is Linked to
type Type:
String		 Title:
Payment Card Type		 Payment Card Type
mod_code Type:
String		 Title:
Module Code		 Payment Module Code linked to Payment Card
meth_code Type:
String		 Title:
Method Code		 Payment Method Code Linked To Payment Card

Example Request

Example Response

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2023 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.