VoPay Digital Wallet Endpoints API
The Digital Wallet Endpoints API from VoPay — 16 operation(s) for digital wallet endpoints.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/vopay-digital-wallet-endpoints-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Vopay Digital Wallet Endpoints API
version: '2.0'
contact:
name: API Support
email: help@vopay.com
description: 'Operations tagged Digital Wallet Endpoints across 2 of this provider''s published API definitions: vopay-payment-method-api-reference.json, vopay-payment-rails-api-reference.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://earthnode-dev.vopay.com/api/v2
tags:
- name: Digital Wallet Endpoints
paths:
/google-pay/generate-embed-url:
post:
description: This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to login to their Google account and generate a token, which can be used in the /google-pay/charge endpoint.
summary: google-pay/generate-embed-url
tags:
- Digital Wallet Endpoints
operationId: GooglePayGenerateEmbedURLPOST
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
ClientAccountID:
description: When provided, the Google Pay token generated will be attached to the Client Account ID
type: string
RedirectURL:
description: URL to redirect the user to after the Google account is connected.
type: string
RedirectMethod:
description: This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.
type: string
ClientControlled:
description: When set to true, the Google Pay token added will be linked to your VoPay account. Default is false.
type: boolean
required:
- AccountID
- Key
- Signature
- RedirectURL
required: true
responses:
'200':
description: ''
headers: {}
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: ''
EmbedURL:
type: string
description: Custom generated iQ11 iframe url for users to use
example: https://earthnode-dev.vopay.com/iq11/embed/{Key Returned by Vopay}
IframeKey:
type: string
description: Unique key attached to the generated iFrame
example: a1b2c3
required:
- Success
- ErrorMessage
- EmbedURL
- IframeKey
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/google-pay/delete:
post:
description: This endpoint allows you to delete a Google Pay token associated with your VoPay account
summary: google-pay/delete
tags:
- Digital Wallet Endpoints
operationId: GooglePayDeletePOST
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
GooglePayToken:
description: Google Pay token
type: string
required:
- AccountID
- Key
- Signature
- GooglePayToken
required: true
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: ''
required:
- Success
- ErrorMessage
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/google-pay:
get:
description: This endpoint retrieves a list of Google Pay credit cards associated with your VoPay account
summary: google-pay
tags:
- Digital Wallet Endpoints
operationId: GooglePayGET
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: GooglePayToken
in: query
required: false
description: When provided, this endpoint will only return the Google Pay credit cards associated with this token
schema:
type: string
- name: ClientAccountID
in: query
required: false
description: When provided, this endpoint will only return Google Pay 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 Google Pay credit cards linked to your VoPay account. When set to false, it will return a list of your customer's Google Pay tokens.
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 Google Pay 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
GooglePayToken:
type: string
description: Google Pay 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
required:
- CreditCardHolderName
- CreditCardNumber
- CreditCardExpiryYear
- CreditCardExpiryMonth
- CreditCardBrand
- GooglePayToken
- IsDefault
- ClientAccountID
x-list-of: inline
x-empty-when: no Google Pay 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
/google-pay/set-my-google-pay:
post:
description: This endpoint allows you to identify a Google Pay credit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a Google Pay credit card as being the VoPay account holder's default Google Pay credit card. Note, a VoPay account can only have one default Google Pay credit card.
summary: google-pay/set-my-google-pay
tags:
- Digital Wallet Endpoints
operationId: GooglePaySetMyGooglePayPOST
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
GooglePayToken:
description: Google Pay token
type: string
ClientAccountID:
description: Client Account ID
type: string
SetAsDefault:
description: Identify credit card as default Google Pay credit card
type: boolean
required:
- AccountID
- Key
- Signature
- GooglePayToken
required: true
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: ''
GooglePayToken:
type: string
description: Google Pay token
example: ACBDF-GAFSHD-AHBS-123456
IsDefault:
type: boolean
description: Is this the VoPay account holder's default Google Pay credit card
example: true
required:
- Success
- ErrorMessage
- GooglePayToken
- IsDefault
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/google-pay/default-google-pay:
get:
description: This endpoint retrieves the default Google Pay credit card associated with your VoPay account
summary: google-pay/default-google-pay
tags:
- Digital Wallet Endpoints
operationId: GooglePayDefaultGooglePayGET
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: ClientAccountID
in: query
required: false
description: When provided, this endpoint will return the default Google Pay credit card associated with this Client Account ID
schema:
type: string
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: ''
DefaultCreditCard:
type: object
description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items. Default Google Pay credit card associated with the Account or Client Account'
properties:
'0':
type: object
properties:
GooglePayToken:
type: string
description: A unique token associated with the credit card.
example: ACBDF-GAFSHD-AHBS-123456
CreditCardHolderName:
type: string
description: Credit card holder name.
example: Natalie Merchant
CreditCardNumber:
type: string
description: Masked credit card number.
example: '**** **** **** 1234'
CreditCardExpiryYear:
type: string
description: Expiry year of credit card.
example: '2022'
CreditCardExpiryMonth:
type: string
description: Expiry month of credit card.
example: '03'
CreditCardBrand:
type: string
description: Credit card brand
example: visa
required:
- GooglePayToken
- CreditCardHolderName
- CreditCardNumber
- CreditCardExpiryYear
- CreditCardExpiryMonth
- CreditCardBrand
x-list-of: inline
x-empty-when: no default Google Pay card
required:
- Success
- ErrorMessage
- DefaultCreditCard
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/apple-pay/generate-embed-url:
post:
description: This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to login to their Apple account and generate a token, which can be used in the /apple-pay/charge endpoint.
summary: apple-pay/generate-embed-url
tags:
- Digital Wallet Endpoints
operationId: ApplePayGenerateEmbedURLPOST
deprecated: false
requestBody:
$ref: '#/components/requestBodies/ApplePayGenerateEmbedURLPOST'
responses:
'200':
description: ''
headers: {}
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: ''
EmbedURL:
type: string
description: Custom generated iQ11 iframe url for users to use
example: https://earthnode-dev.vopay.com/iq11/embed/{Key Returned by Vopay}
IframeKey:
type: string
description: Unique key attached to the generated iFrame
example: a1b2c3
required:
- Success
- ErrorMessage
- EmbedURL
- IframeKey
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/apple-pay/delete:
post:
description: This endpoint allows you to delete a Apple Pay token associated with your VoPay account
summary: apple-pay/delete
tags:
- Digital Wallet Endpoints
operationId: ApplePayDeletePOST
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
ApplePayToken:
description: Apple Pay token
type: string
required:
- AccountID
- Key
- Signature
- ApplePayToken
required: true
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: ''
required:
- Success
- ErrorMessage
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/apple-pay:
get:
description: This endpoint retrieves a list of Apple Pay credit cards associated with your VoPay account
summary: apple-pay
tags:
- Digital Wallet Endpoints
operationId: ApplePayGET
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: ApplePayToken
in: query
required: false
description: When provided, this endpoint will only return the Apple Pay credit cards associated with this token
schema:
type: string
- name: ClientAccountID
in: query
required: false
description: When provided, this endpoint will only return Apple Pay 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 Apple Pay credit cards linked to your VoPay account. When set to false, it will return a list of your customer's Apple Pay tokens.
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 Apple Pay 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
ApplePayToken:
type: string
description: Apple Pay 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
required:
- CreditCardHolderName
- CreditCardNumber
- CreditCardExpiryYear
- CreditCardExpiryMonth
- CreditCardBrand
- ApplePayToken
- IsDefault
- ClientAccountID
x-list-of: inline
x-empty-when: no Apple Pay 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
/apple-pay/set-my-apple-pay:
post:
description: This endpoint allows you to identify a Apple Pay credit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a Apple Pay credit card as being the VoPay account holder's default Apple Pay credit card. Note, a VoPay account can only have one default Apple Pay credit card.
summary: apple-pay/set-my-apple-pay
tags:
- Digital Wallet Endpoints
operationId: ApplePaySetMyApplePayPOST
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
ApplePayToken:
description: Apple Pay token
type: string
ClientAccountID:
description: Client Account ID
type: string
SetAsDefault:
description: Identify credit card as default Apple Pay credit card
type: boolean
required:
- AccountID
- Key
- Signature
- ApplePayToken
required: true
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: ''
ApplePayToken:
type: string
description: Apple Pay token
example: ACBDF-GAFSHD-AHBS-123456
IsDefault:
type: boolean
description: Is this the VoPay account holder's default Apple Pay credit card
example: true
required:
- Success
- ErrorMessage
- ApplePayToken
- IsDefault
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/apple-pay/default-apple-pay:
get:
description: This endpoint retrieves the default Apple Pay credit card associated with your VoPay account
summary: apple-pay/default-apple-pay
tags:
- Digital Wallet Endpoints
operationId: ApplePayDefaultApplePayGET
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: ClientAccountID
in: query
required: false
description: When provided, this endpoint will return the default Apple Pay credit card associated with this Client Account ID
schema:
type: string
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: ''
DefaultCreditCard:
type: object
description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items. Default Apple Pay credit card associated with the Account or Client Account'
properties:
'0':
type: object
properties:
ApplePayToken:
type: string
description: A unique token associated with the credit card.
example: ACBDF-GAFSHD-AHBS-123456
CreditCardHolderName:
type: string
description: Credit card holder name.
example: Natalie Merchant
CreditCardNumber:
type: string
description: Masked credit card number
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vopay/refs/heads/main/openapi/vopay-digital-wallet-endpoints-api-openapi.yml