--- updatedAt: 2026-07-07T16:41:47.000Z agentTools: projectIndex: https://docs.vopay.com/llms.txt --- # credit-card This endpoint retrieves a list of credit cards associated with your VoPay account # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "2.0", "title": "Payment Methods", "description": "The Payment Methods API allows you to manage your payment methods. You can add, delete, and set default payment methods.", "contact": { "name": "API Support", "email": "help@vopay.com" } }, "paths": { "/credit-card": { "get": { "description": "This endpoint retrieves a list of credit cards associated with your VoPay account", "summary": "credit-card", "tags": [ "Credit Card Endpoints" ], "operationId": "CreditCardGET", "deprecated": false, "parameters": [ { "name": "AccountID", "in": "query", "required": true, "description": "Your account ID", "schema": { "type": "string" } }, { "name": "Key", "in": "query", "required": true, "description": "API key for the account", "schema": { "type": "string" } }, { "name": "Signature", "in": "query", "required": true, "description": "Hashed signature for the request", "schema": { "type": "string" } }, { "name": "CreditCardToken", "in": "query", "required": false, "description": "When provided, this endpoint will only return the credit card associated with this token", "schema": { "type": "string" } }, { "name": "ClientAccountID", "in": "query", "required": false, "description": "When provided, this endpoint will only return credit cards associated with this Client Account ID", "schema": { "type": "string" } }, { "name": "ClientControlled", "in": "query", "required": false, "description": "When set to true, this endpoint will only return credit cards linked to your VoPay account. When set to false, it will return a list of your customer's credit cards.", "schema": { "type": "boolean" } }, { "name": "Limit ", "in": "query", "required": false, "description": "Limit the number of records that are returned.", "schema": { "type": "integer" } }, { "name": "Offset ", "in": "query", "required": false, "description": "Use this parameter to set the starting point in the dataset.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "True if the request was successful, false if it failed", "example": true }, "ErrorMessage": { "type": "string", "description": "Contains a description of the error if the request failed", "example": "" }, "CreditCards": { "type": "object", "description": "Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of the credit cards belonging to the account or client account", "properties": { "0": { "type": "object", "properties": { "CreditCardHolderName": { "type": "string", "description": "Credit card holder's name.", "example": "John Smith" }, "CreditCardNumber": { "type": "string", "description": "Masked credit card number.", "example": "*****1234" }, "CreditCardExpiryYear": { "type": "string", "description": "Expiry year of the credit card", "example": "2023" }, "CreditCardExpiryMonth": { "type": "string", "description": "Expiry month of the credit card", "example": "12" }, "CreditCardBrand": { "type": "string", "description": "Credit card brand", "example": "visa" }, "CreditCardToken": { "type": "string", "description": "Credit card token.", "example": "ACBDF-GAFSHD-AHBS-123456" }, "IsDefault": { "type": "boolean", "description": "Is this the VoPay account holder's default credit card", "example": true }, "ClientAccountID": { "type": "string", "description": "ClientAccountID attached to the credit card.", "example": "ClientAccount1" }, "SendingEligibility": { "type": "string", "description": "This credit card's eligibility to send funds.", "example": "1" }, "ReceivingEligibility": { "type": "string", "description": "This credit card's eligibility to receive funds.", "example": "1" }, "Type": { "type": "string", "description": "Verified card type.", "example": "credit" }, "Brand": { "type": "string", "description": "Verified card brand.", "example": "mastercard" }, "FundsAvailability": { "type": "string", "description": "Funds availability time frame after receiving a payment transaction.", "example": "immediate" }, "InstitutionName": { "type": "string", "description": "Financial institution name.", "example": "bankcorp bank, the" }, "InstitutionCountry": { "type": "string", "description": "Financial institution country.", "example": "usa" }, "AccountStatementCurrency": { "type": "string", "description": "Currency of cardholder's account statement", "example": "usd" }, "AcceptanceBrand": { "type": "string", "description": "Acceptance Brand", "example": "mcc" }, "ProductType": { "type": "string", "description": "Product Type", "example": "consumer" } }, "required": [ "CreditCardHolderName", "CreditCardNumber", "CreditCardExpiryYear", "CreditCardExpiryMonth", "CreditCardBrand", "CreditCardToken", "IsDefault", "ClientAccountID", "SendingEligibility", "ReceivingEligibility", "Type", "Brand", "FundsAvailability", "InstitutionName", "InstitutionCountry", "AccountStatementCurrency", "AcceptanceBrand", "ProductType" ] } }, "x-list-of": "inline", "x-empty-when": "no credit cards match" }, "Pagination": { "type": "object", "description": "Pagination metadata", "properties": { "TotalRecords": { "type": "string", "description": "Total number of credit card records in that search range.", "example": "1000" }, "Offset": { "type": "string", "description": "Use this parameter to set the starting point in the dataset.", "example": "1000" }, "Limit": { "type": "string", "description": "Limit the number of records that are returned.", "example": "1000" } }, "x-absent-when": "response uses PaginationMetaData; present only when pagination is requested", "required": [ "TotalRecords", "Offset", "Limit" ] } }, "required": [ "Success", "ErrorMessage", "CreditCards" ] } } } } } } } }, "servers": [ { "url": "https://earthnode-dev.vopay.com/api/v2" } ] } ```