Issuance PINs Integration Guide

DOCS

Last updated: Sept 24th, 12:26am

Use the Issuance PINs API to enable electronic wallets and other financial accounts that do not typically accept a personal identification number (PIN) at point-of-sale terminals (POS) or automatic teller machines (ATM) to set up and use a PIN. The API validates and manages the lifecycle of these PINs.

Overview

The Issuance PINs solution enables external API users, such as Google with AndroidPay, to manage PINs for tokens that are loaded onto mobile devices.

You can create one PIN to share among multiple instruments, which can be tokens or cards.

Integration steps

1. Required Set up your development environment.
2. Required Create shared PIN.
3. Optional List PINs.
4. Optional Show PIN details.
5. Optional Update PIN.

Set up your development environment

Before you can integrate Issuance PINs, you must set up your development environment. After you get a token that lets you access protected REST API resources, you create sandbox accounts to test your web and mobile apps. For details, see Get started.

Then, return to this page to integrate Issuance PINs.

Create shared PIN

You can create a shared PIN that is associated with a card, tokenized card, or account.

To create a shared PIN for any of these instruments, include a user-provided PIN and the PIN profile name. The product configuration engine must configure this name.

Additionally, provide a PIN owner reference, which is a card number, PayPal account ID, or external account ID, for the instrument:

Instrument PIN owner reference
PayPal wallet

The encrypted account number that identifies the PayPal wallet.

PayPal balance account The encrypted account number for the balance account.
Third-party wallet The third-party account ID or billing agreement number.
PayPal debit card The resource ID for the card.

For more information about these parameters, see pin_create_request. To create a shared PIN, see create shared PIN.

Update PIN

You can update a shared PIN. For example, you might want to update the PIN number itself, the PIN profile name, or the PIN reference owner.

For information, see update PIN.

Show PIN details

You can show details for a PIN, by ID.

For details, see show PIN details.

List PINs

You can list PINs that match the search criteria. You specify search criteria through these query parameters:

owner_ref Required Filters the PINs in the response by a PIN owner reference. Can be a card number, PayPal account ID, or external account ID.
profile_name Optional Filters the PINs in the response by a PIN profile name. You can specify multiple profile names separated by a comma (,) character: ?profile_name=ANDROIDPAY_US_PIN,APPLEPAY_US_PIN

For details, see list PINs.

Next