Stay organized with collections
Save and categorize content based on your preferences.
Step 1: Get familiar with the Virtual Cards APIs
The Reference section
contains details about Virtual Cards APIs.
As the first step for your implementation, we recommend getting familiar with
the sequence diagrams and corresponding APIs for Virtual Cards,
including,
enrollment,
retrieval,
unenrollment
and
transaction management
flows.
Overview and benefits of the product is on the
Home page, whereas frequently asked questions can
be found on the FAQ page.
Step 3: Work with Google to set up your configuration
Google needs to configure host(s) and
application layer
encryption (PGP or JWE) to establish communication with the
Virtual Cards APIs you implement.
First, you need to determine the URL for the host(s) on your side responsible
for serving the APIs. If your implementation is split across multiple hosts
(e.g. a 3rd party core or other service provider), indicate which endpoints are
served directly by you and which are handled on your behalf by a service
provider.
Second, if you are hosting any of the APIs, you need to setup either
PGP
(preferred) or
JWE
that should be used for application layer encryption with your endpoints.
Once you have verified you can meet the integration requirements
(step 2),
have your PGP/JWE encryption configured, and have a
Payment Integrator Account ID (PIAID)
from Google
(step 3),
you are ready to implement and
test the Google hosted echo
and your hosted echo endpoints. Refer to echo definitions in the
Virtual Cards APIs under
Reference.
These scripts use the Google-hosted Sandbox environment echo method to test
baseline connectivity:
Once you have the echo endpoints working in sandbox, you're ready to
integrate with the rest of the Virtual Cards APIs.
Refer to Virtual Cards APIs under the
Reference section.
Step 6: Testing
As development wraps up follow the
testing process
to prepare for launch, which includes the
test cases
expected to be executed to validate your Virtual Cards APIs
implementation.
Step 7: Launch!
Follow the
launch process
to ensure as smooth a release as possible.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eFamiliarize yourself with Virtual Cards APIs, including enrollment, retrieval, unenrollment, and transaction management flows.\u003c/p\u003e\n"],["\u003cp\u003eEnsure your system meets security and protocol standards, especially regarding transport, application layers, and idempotency.\u003c/p\u003e\n"],["\u003cp\u003eCollaborate with Google to set up your configuration, including host details, application layer encryption, and obtaining a unique Payment Integrator Account ID (PIAID).\u003c/p\u003e\n"],["\u003cp\u003eEstablish sandbox echo connectivity to test baseline communication with Google's hosted environment using provided scripts.\u003c/p\u003e\n"],["\u003cp\u003eIntegrate with the Virtual Cards APIs, rigorously test your implementation according to provided guidelines, and then follow the launch process for a smooth release.\u003c/p\u003e\n"]]],["First, review the Virtual Cards APIs, including enrollment, retrieval, unenrollment, and transaction management. Next, ensure support for transport and application layer security, plus idempotency. Then, provide Google with host URLs and configure PGP/JWE encryption. After receiving your Payment Integrator Account ID (PIAID), establish sandbox echo connectivity using provided scripts. Integrate with the Virtual Cards APIs, then complete the defined testing process before launching.\n"],null,["# Implementation Steps\n\nStep 1: Get familiar with the Virtual Cards APIs\n------------------------------------------------\n\nThe [Reference](/pay/virtual-cards-v1/reference/vcn-sequence-diagrams) section\ncontains details about Virtual Cards APIs.\nAs the first step for your implementation, we recommend getting familiar with\nthe sequence diagrams and corresponding APIs for Virtual Cards,\nincluding,\n[enrollment](/pay/virtual-cards-v1/reference/vcn-sequence-diagrams#enrollment),\n[retrieval](/pay/virtual-cards-v1/reference/vcn-sequence-diagrams#retrieval),\n[unenrollment](/pay/virtual-cards-v1/reference/vcn-sequence-diagrams#unenrollment)\nand\n[transaction management](/pay/virtual-cards-v1/reference/vcn-sequence-diagrams#transaction_management)\nflows.\n\nOverview and benefits of the product is on the\n[Home](/pay/virtual-cards-v1) page, whereas frequently asked questions can\nbe found on the [FAQ](/pay/virtual-cards-v1/support/faq) page.\n\nStep 2: Connectivity and idempotency requirements\n-------------------------------------------------\n\nIt is important to understand and ensure you are able to support the\n[transport layer](/pay/virtual-cards-v1/guides/connectivity/security/transport-layer)\nand [application layer](/pay/virtual-cards-v1/guides/connectivity/security/application-layer)\nsecurity requirements as well as the\n[protocol standards](/pay/virtual-cards-v1/guides/connectivity/protocol-standards),\nnotably those related to\n[idempotency](/pay/virtual-cards-v1/guides/connectivity/protocol-standards#request_idempotency),\nprior to integrating.\n\nStep 3: Work with Google to set up your configuration\n-----------------------------------------------------\n\nGoogle needs to configure host(s) and\n[application layer](/pay/virtual-cards-v1/guides/connectivity/security/application-layer)\nencryption (PGP or JWE) to establish communication with the\nVirtual Cards APIs you implement.\n\nFirst, you need to determine the URL for the host(s) on your side responsible\nfor serving the APIs. If your implementation is split across multiple hosts\n(e.g. a 3rd party core or other service provider), indicate which endpoints are\nserved directly by you and which are handled on your behalf by a service\nprovider.\n\nSecond, if you are hosting any of the APIs, you need to setup either\n[PGP](/pay/virtual-cards-v1/guides/connectivity/security/application-layer#generating_a_new_pgp_key)\n(preferred) or\n[JWE](/pay/virtual-cards-v1/guides/connectivity/security/application-layer#jwe_encryption_with_jws_signing)\nthat should be used for application layer encryption with your endpoints.\n\nTo create your unique ID and initiate the key exchange process, submit the [Virtual Card Number integration request form](https://support.google.com/faqs/contact/vcn_request).\nOnce Google has set up your configuration, Google replies with your\n[Payment Integrator Account ID (PIAID)](/pay/virtual-cards-v1/reference/glossary#payment_integrator_account_id)\nand Google's public PGP/JWE key specific to the endpoints you are hosting.\n\nStep 4: Establish sandbox echo connectivity\n-------------------------------------------\n\nOnce you have verified you can meet the integration requirements\n([step 2](#step_2_connectivity_and_idempotency_requirements)),\nhave your PGP/JWE encryption configured, and have a\n[Payment Integrator Account ID (PIAID)](/pay/virtual-cards-v1/reference/glossary#payment_integrator_account_id)\nfrom Google\n([step 3](#step_3_work_with_google_to_set_up_your_configuration)),\nyou are ready to implement and\n[test the Google hosted `echo`](/pay/virtual-cards-v1/guides/connectivity/establish-connectivity#echo_from_partner_to_google)\nand your hosted `echo` endpoints. Refer to `echo` definitions in the\nVirtual Cards APIs under\n[Reference](/pay/virtual-cards-v1/reference/vcn-sequence-diagrams).\n\nThese scripts use the Google-hosted Sandbox environment echo method to test\nbaseline connectivity:\n\n- Script using V1 [`echo`](https://developers.google.com/standard-payments/payment-integrator-diagnostic-api/v1/TopLevel/echo): [gsp_sandbox_echo.sh](/static/standard-payments/shared/reference/assets/gsp_sandbox_echo.sh)\n- Script using V2 [`echo`](https://developers.google.com/standard-payments/payment-integrator-diagnostic-api/v2/TopLevel/echo): [gsp_sandbox_echo_v2.sh](/static/standard-payments/shared/reference/assets/gsp_sandbox_echo_v2.sh)\n\nStep 5: Integrate with the APIs\n-------------------------------\n\nOnce you have the `echo` endpoints working in sandbox, you're ready to\nintegrate with the rest of the Virtual Cards APIs.\n\nRefer to Virtual Cards APIs under the\n[Reference](/pay/virtual-cards-v1/reference/vcn-sequence-diagrams) section.\n\nStep 6: Testing\n---------------\n\nAs development wraps up follow the\n[testing process](/pay/virtual-cards-v1/guides/testing-and-launch/testing)\nto prepare for launch, which includes the\n[test cases](/pay/virtual-cards-v1/guides/testing-and-launch/testing#test_cases)\nexpected to be executed to validate your Virtual Cards APIs\nimplementation.\n| **Warning:** Your integration cannot be launched until testing is complete.\n\nStep 7: Launch!\n---------------\n\nFollow the\n[launch process](/pay/virtual-cards-v1/guides/testing-and-launch/launch-process)\nto ensure as smooth a release as possible."]]