Customer Vault

The Customer Vault API allows you to create customer profiles containing their payment information – i.e., tokens – and then to make repeat payments without having to directly access sensitive payment information. It is a highly efficient and secure method for enabling repeat customer payments.

Click the links below to view our code samples.

Verify That the Service Is Accessible

boolean isOnline = apiClient.customerVaultService().monitor();

Customer Profile

Profile profile =

    Profile.builder()

      .merchantCustomerId("0f8fad5bd9cb469fa16570867728950e")

      .locale(Locale.en_US)

      .firstName("John")

      .lastName("Smith")

      .email("john.smith@example.com")

      .phone("713-444-5555")

      .build();



apiClient.customerVaultService().create(profile);

Profile profile =

    Profile.builder()

      .merchantCustomerId("0f8fad5bd9cb469fa16570867728950e")

      .locale(Locale.en_US)

      .firstName("John")

      .lastName("Smith")

      .email("john.smith@example.com")

      .phone("713-444-5555")

      .card()

      .singleUseToken("SCrGrrRANmOVtcVc")

      .done()

      .build();



apiClient.customerVaultService().create(profile);

Profile lookupResponse = apiClient.customerVaultService().lookup(profile.getId());

Profile updatedProfile =

    Profile.builder()

      .id(profile.getId())

      .merchantCustomerId(profile.getMerchantCustomerId())

      .firstName("Jack")

      .build();



Profile updatedProfileResponse = apiClient.customerVaultService().update(updatedProfile);

boolean profileDeleted = apiClient.customerVaultService().delete(profile.getId());

Profile Addresses

Address address =

   Address.builder()

     .profileId(profile.getId())

     .nickName("home")

     .street("100 Queen Street West")

     .street2("Unit 201")

     .city("Toronto")

     .country("CA")

     .state("ON")

     .zip("M5H 2N2")

     .recipientName("Jane Doe")

     .phone("647-788-3901")

     .build();



 apiClient.customerVaultService().create(address);

Address addressResponse = apiClient.customerVaultService().lookup(address.getId());

Address addressToUpdate =

    Address.builder()

      .profileId(profile.getId())

      .id(address.getId())

      .nickName("New Home")

      .build();



Address updatedAddress = apiClient.customerVaultService().update(addressToUpdate);

boolean addressDeleted = apiClient.customerVaultService().delete(address.getId());;

Profile Cards

Card card =

    Card.builder()

      .profileId(profile.getId())

      .nickName("John's corporate Visa2")

      .holderName("MR. JOHN SMITH")

      .cardNum("4111111111111111")

      .cardExpiry()

       .month(12)

       .year(2019)

       .done()

      .billingAddressId(address.getId())

      .build();

apiClient.customerVaultService().create(card);

Card cardResponse = apiClient.customerVaultService().lookup(card.getId());

Card cardUpdate =

     Card.builder()

       .profileId(profile.getId())

       .id(cardResponse.getId())

       .nickName("NEW CARD NAME")

       .build();



 Card updatedCard = apiClient.customerVaultService().update(cardUpdate);

boolean cardDeleted = apiClient.customerVaultService().delete(card.getId());

Profile Bank Accounts

Managing ACH Bank Accounts

ACHBankAccounts achBankAccounts=

  ACHBankAccounts.builder()

    .nickName("John RBC Business Bank Account")

    .accountNumber("511201")

    .routingNumber("123456789")

    .accountHolderName("XYZ Business")

    .billingAddressId("60022f38-fd17-4731-909c-923930d0d5d4")

    .accountType("CHECKING")

    .profileId(profile.getId())

    .build();



ACHBankAccounts achBankAccountsRes=apiClient.customerVaultService().create(achBankAccounts);

ACHBankAccounts achBankAccounts=

  ACHBankAccounts.builder()

    .profileId(achBankAccountsRes.getProfileId())

    .id(achBankAccountsRes.getId())

    .build();



ACHBankAccounts response=apiClient.customerVaultService().lookup(achBankAccounts);

ACHBankAccounts achBankAccountsToUpdate=

  ACHBankAccounts.builder()

    .nickName("John RBC Business Bank Account")

    .profileId(achBankAccountsRes.getProfileId())

    .id(achBankAccountsRes.getId())

    .build();



ACHBankAccounts response=apiClient.customerVaultService().update(achBankAccountsToUpdate);

ACHBankAccounts delACHBankAccount=

  ACHBankAccounts.builder()

    .profileId(achBankAccounts.getProfileId())

    .id(achBankAccounts.getId())

    .build();



boolean response=apiClient.customerVaultService().delete(delACHBankAccount);

Managing BACS Bank Accounts

BACSBankAccounts bacsBankAccounts=

  BACSBankAccounts.builder()

    .nickName("Sally's Bank of Montreal Account")

    .accountNumber("34898396")

    .accountHolderName("Sally")

    .sortCode("070116")

    .billingAddressId(address.getId())

    .profileId(profile.getId())

    .build();



BACSBankAccounts bacsBankAccountsRes=apiClient.customerVaultService().create(bacsBankAccounts);

ArrayList<Mandates> m = new ArrayList<Mandates>();

Mandates mandts =

  Mandates.builder()

    .reference("SUBCRIP345")

    .build();

    m.add(mandts);



BACSBankAccounts bacsBankAccounts=

  BACSBankAccounts.builder()

    .nickName("Sally's Bank of Montreal Account")

    .accountNumber("34898396")

    .accountHolderName("Sally")

    .sortCode("070116")

    .mandates(m)

    .billingAddressId(address.getId())

    .profileId(profile.getId())

    .build());



BACSBankAccounts bacsBankAccountsRes=apiClient.customerVaultService().create(bacsBankAccounts);

BACSBankAccounts bacsBankAccounts=

  BACSBankAccounts.builder()

    .profileId(bacsBankAccountsRes.getProfileId())

    .id(bacsBankAccountsRes.getId())

    .build();



BACSBankAccounts response=apiClient.customerVaultService().lookup(bacsBankAccounts);

BACSBankAccounts bacsBankAccountsToUpdate=

  BACSBankAccounts.builder()

    .nickName("Sally's Bank of Montreal Account")

    .profileId(bacsBankAccountsRes.getProfileId())

    .id(bacsBankAccountsRes.getId())

    .build();



BACSBankAccounts response=apiClient.customerVaultService().update(bacsBankAccountsToUpdate);

BACSBankAccounts delbacsBankAccounts=

  BACSBankAccounts.builder()

    .profileId(bacsBankAccountsRes.getProfileId())

    .id(bacsBankAccountsRes.getId())

    .build();



boolean response=apiClient.customerVaultService().delete(delbacsBankAccounts);

Managing EFT Bank Accounts

EFTBankAccounts eftBankAccounts=

  EFTBankAccounts.builder()

    .nickName("Sally's Bank of Montreal Account")

    .accountNumber("511201")

    .accountHolderName("Sally")

    .transitNumber("25039")

    .institutionId("001")

    .billingAddressId(address.getId())

    .profileId(profile.getId())

    .build();



EFTBankAccounts eftBankAccountsRes=apiClient.customerVaultService().create(eftBankAccounts);

EFTBankAccounts eftBankAccounts=

  EFTBankAccounts.builder()

    .profileId(eftBankAccountsRes.getProfileId())

    .id(eftBankAccountsRes.getId())

    .build();



EFTBankAccounts response=apiClient.customerVaultService().lookup(eftBankAccounts);

EFTBankAccounts eftBankAccountsToUpdate=

  EFTBankAccounts.builder()

    .nickName("Sally's Bank of Montreal Account")

    .profileId(eftBankAccountsRes.getProfileId())

    .id(eftBankAccountsRes.getId())

    .build();



EFTBankAccounts response=apiClient.customerVaultService().update(eftBankAccountsToUpdate);

EFTBankAccounts deleftBankAccounts=

  EFTBankAccounts.builder()

    .profileId(eftBankAccountsRes.getProfileId())

    .id(eftBankAccountsRes.getId())

    .build();



boolean response=apiClient.customerVaultService().delete(deleftBankAccounts);

Managing SEPA Bank Accounts

SEPABankAccounts sepaBankAccounts=

  SEPABankAccounts.builder()

    .nickName("John RBC Business Bank Account")

    .accountHolderName("XYZ Business")

    .bic("ABNANL2A")

    .iban("NL25BSAB9133933065")

    .billingAddressId(address.getId())

    .profileId(profile.getId())

    .build();



SEPABankAccounts sepaBankAccountsRes=apiClient.customerVaultService().create(sepaBankAccounts);

ArrayList<Mandates> m = new ArrayList<Mandates>();

  Mandates mandts =

    Mandates.builder()

      .reference("SUBCRIP345")

      .build();

      m.add(mandts);

  SEPABankAccounts sepaBankAccounts=

    SEPABankAccounts.builder()

      .nickName("John RBC Business Bank Account")

      .accountHolderName("XYZ Business")

      .bic("HANDFIHH")

      .mandates(m)

      .iban("AL51934179606309730572538012")

      .billingAddressId(address.getId())

      .profileId(profile.getId())

      .build());



SEPABankAccounts sepaBankAccountsRes=apiClient.customerVaultService().create(sepaBankAccounts);

SEPABankAccounts sepaBankAccounts=

  SEPABankAccounts.builder()

    .profileId(sepaBankAccountsRes.getProfileId())

    .id(sepaBankAccountsRes.getId())

    .build();



SEPABankAccounts response=apiClient.customerVaultService().lookup(sepaBankAccounts);

SEPABankAccounts sepaBankAccountsToUpdate=

  SEPABankAccounts.builder()

    .nickName("John RBC Business Bank Account")

    .profileId(sepaBankAccountsRes.getProfileId())

    .id(sepaBankAccountsRes.getId())

    .build();



SEPABankAccounts response=apiClient.customerVaultService().update(sepaBankAccountsToUpdate);

SEPABankAccounts delsepaBankAccounts=

  SEPABankAccounts.builder()

    .profileId(sepaBankAccountsRes.getProfileId())

    .id(sepaBankAccountsRes.getId())

    .build();



boolean response=apiClient.customerVaultService().delete(delsepaBankAccounts);

Mandates

Mandates mandates=

  Mandates.builder()

    .reference("SUBSCRIPTION103")

    .profileId(profile.getId())

    .bankAccountId(bacsBankAccounts.getId().toString())

    .build();



Mandates mandatesRes=apiClient.customerVaultService().create(mandates,"BACS");

Mandates mandates=

  Mandates.builder()

    .reference("SUBSCRIPTION103")

    .profileId(profile.getId())

    .bankAccountId(sepaBankAccounts.getId().toString())

    .build();



Mandates mandatesRes=apiClient.customerVaultService().create(mandates,"SEPA");

Mandates mandates=

  Mandates.builder()

    .id(mandatesRes.getId())

    .profileId(mandatesRes.getProfileId())

    .build();



Mandates response=apiClient.customerVaultService().lookup(mandates);

Mandates mandatesToUpdate=

  Mandates.builder()

    .status(Status.CANCELLED)

    .profileId(mandatesRes.getProfileId())

    .id(mandatesRes.getId())

    .build());



Mandates response=apiClient.customerVaultService().update(mandatesToUpdate);

Mandates mandatesToDelete=

  Mandates.builder()

    .id(mandatesRes.getId())

    .profileId(mandatesRes.getProfileId())

    .build());



boolean response=apiClient.customerVaultService().delete(mandatesToDelete);

Process a Payment Using a Payment Token

Authorization auth =

    Authorization.builder()

      .merchantRefNum("0f8fad5bd9cb469fa16570867728950e")

      .amount(1295)

      .settleWithAuth(true)

      .card()

      .paymentToken(card.getPaymentToken())

      .done()

      .build();



apiClient.cardPaymentService().authorize(auth);

Authorization auth =

    Authorization.builder()

      .merchantRefNum("0f8fad5bd9cb469fa16570867728950e")

      .card()

        .paymentToken(cardResponse.getPaymentToken())

        .done()

      .build();



Verification verificationResponse = apiClient.cardPaymentService().verify(auth);

Was this page helpful?

On this Page

Verify That the Service Is Accessible
Customer Profile
Profile Addresses
Profile Cards
Profile Bank Accounts
Managing ACH Bank Accounts
Managing BACS Bank Accounts
Managing EFT Bank Accounts
Managing SEPA Bank Accounts
Mandates
Process a Payment Using a Payment Token

Search Overlay

Customer Vault

Create a customer profile

Create a customer profile using a single-use token

Look up a customer profile

Update a customer profile

Delete a customer profile

Create a customer address

Look up a customer address

Update a customer address

Delete a customer address

Create a customer card

Look up a customer card

Update a customer card

Delete a customer card

Create an ACH bank account

Look up an ACH bank account

Update an ACH bank account

Delete an ACH bank account

Create a BACS bank account

Create a BACS bank account with a mandate

Look up a BACS bank account

Update a BACS bank account

Delete a BACS bank account

Create an EFT bank account

Look up an EFT bank account

Update an EFT bank account

Delete an EFT bank account

Create a SEPA bank account

Create a SEPA bank account with a mandate

Look up a SEPA bank account

Update a SEPA bank account

Delete a SEPA bank account

Create a BACS bank account mandate

Create a SEPA bank account mandate

Look up a mandate

Update a mandate

Delete a mandate

Process an authorization with a payment token

Verify a card using a payment token

Was this page helpful?

Thank you for your response!