Issuance Cards Integration Guide
Last updated: Sept 24th, 12:28am
Use the Issuance Cards API to manage and query PayPal debit cards associated with a PayPal wallet.
Important: You cannot run the following sample requests as-is. Replace all call-specific parameter values, such as tokens and IDs with your own values.
Integration steps
To create and activate a PayPal debit card:
| 1. | Required | Set up your development environment. |
| 2. | Required | Create a PayPal debit card. |
| 3. | Required | Mark the card for activation. |
| 4. | Required | Activate the card. |
Set up your development environment
Before you can integrate Issuance Cards, 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 Cards.
Create PayPal debit card
To create a PayPal-issued debit card, pass information about the card_holder and the product_name in a create card call.
Include these parameters in the card_holder object:
| Parameter | Description |
|---|---|
user_id |
Required. The card holder's user ID. |
wallet_id |
Required. The card holder's wallet ID. |
address_id |
Required. The card holder's address ID. |
user_phone |
Optional. The card holder's phone number. |
first_name |
Required. The card holder's first name. |
last_name |
Required. The card holder's last name. |
is_primary_card_holder |
Optional. Indicates whether the card holder is the primary account holder. Default is TRUE. |
1curl -v -X POST https://api-m.sandbox.paypal.com/v1/issuance/cards \2 -H "Content-Type: application/json" \3 -H "Authorization: Bearer <Access-Token>" \4 -d '{5 "product_name": "BUSINESS_DEBIT_MASTERCARD_EMV_US",6 "card_holder": {7 "user_id": "ZQARVWM8J3Z9L",8 "wallet_id": "ZQARVWM8J3Z9L",9 "address_id": {10 "id": "252097"11 },12 "first_name": "Sonia",13 "last_name": "Michael"14 },15 "shipping_address": {16 "id": "252098"17 },18 "application_id": "56a71992-413d-49f1-95ff-66011f4adb21"19}'
The response shows card information.
1{2 "id": "2712-d1b2b4ca-2ae4-4835-a8e4-7f802703412e",3 "product_name": "BUSINESS_DEBIT_MASTERCARD_EMV_US",4 "expiry_date": "2020-03-01",5 "card_state": "PENDING_ACTIVE",6 "card_holder": {7 "user_id": "ZQARVWM8J3Z9L",8 "wallet_id": "ZQARVWM8J3Z9L",9 "billing_address": {10 "id": "252097"11 },12 "first_name": "Sonia",13 "last_name": "Michael"14 },15 "tokenized_value": "ZQARVWM8J3Z9L",16 "time_created": "2016-10-16T17:57:36Z",17 "card_limits": {18 "pos_limit": {19 "currency_code": "USD",20 "value": "3000.00"21 },22 "atm_limit": {23 "currency_code": "USD",24 "value": "400.00"25 },26 "id": "1"27 },28 "links": [{29 "rel": "self",30 "href": "https://api-m.sandbox.paypal.com/v1/issuance/cards/2712-d1b2b4ca-2ae4-4835-a8e4-7f802703412e",31 "method": "GET"32 }]33}
Next, you can mark the card for activation.
Mark card for activation
To mark the card for activation, make a warm card call. Include the card ID in the URI and the provision_result in the JSON request body.
Note: The vendor usually sends the provision_result value. For example, Instrument shipped successfully.
1curl -v -X POST https://api-m.sandbox.paypal.com/v1/issuance/cards/2712-d1b2b4ca-2ae4-4835-a8e4-7f802703412e/warm \2 -H "Content-Type: application/json" \3 -H "Authorization: Bearer <Access-Token>" \4 -d '{5 "carrier": "fedex",6 "tracking_number": "9247826492794562",7 "provision_result": "Instrument shipped successfully",8 "shipped_date": "2017-06-07",9 "provision_status": "GOOD",10 "issue_history_id": "2718-51a2e85d-2580-4332-aacd-99841ae5094d"11}'
The response shows card information with the state set to PENDING_ACTIVE.
1{2 "id": "2718-d5edbd0f-05dd-4df0-a39c-4aac8e139191",3 "product_name": "BUSINESS_DEBIT_MASTERCARD_EMV_US",4 "expiry_date": "2020-03-01",5 "state": "PENDING_ACTIVE",6 "card_holder": {7 "user_id": "H5FXY4SEJHB9W",8 "wallet_id": "H5FXY4SEJHB9W",9 "billing_address": {10 "id": "6921304228265665502"11 },12 "first_name": "Sonia",13 "last_name": "Michael"14 },15 "tokenized_value": "H5FXY4SEJHB9W",16 "time_created": "2016-10-16T17:57:36Z",17 "card_limits": {18 "pos_limit": {19 "currency_code": "USD",20 "value": "3000.00"21 },22 "atm_limit": {23 "currency_code": "USD",24 "value": "400.00"25 },26 "id": "5"27 },28 "links": [{29 "rel": "self",30 "href": "https://api-m.sandbox.paypal.com/v1/issuance/cards/2718-d5edbd0f-05dd-4df0-a39c-4aac8e139191",31 "method": "GET"32 }]33}
Next, you can activate the debit card.
Activate card
To activate a PayPal-issued debit card, pass the card_id in an activate card call.
1curl -v -X POST https://api-m.sandbox.paypal.com/v1/issuance/cards/2712-d1b2b4ca-2ae4-4835-a8e4-7f802703412e/activate \2 -H "Content-Type: application/json" \3 -H "Authorization: Bearer <Access-Token>" \4 -d '{5 "expiry_date": "2020-03-01"6}'
The response shows card details with the state set to ACTIVE.
1{2 "id": "2712-d1b2b4ca-2ae4-4835-a8e4-7f802703412e",3 "product_name": "BUSINESS_DEBIT_MASTERCARD_EMV_US",4 "expiry_date": "2020-03-01",5 "card_state": "ACTIVE",6 "card_holder": {7 "user_id": "ZQARVWM8J3Z9L",8 "wallet_id": "ZQARVWM8J3Z9L",9 "billing_address": {10 "id": "252097"11 },12 "first_name": "Sonia",13 "last_name": "Michael"14 },15 "tokenized_value": "ZQARVWM8J3Z9L",16 "time_created": "2016-10-16T17:57:36Z",17 "time_activated": "2016-11-16T17:57:36Z",18 "card_limits": {19 "pos_limit": {20 "currency_code": "USD",21 "value": "3000.00"22 },23 "atm_limit": {24 "currency_code": "USD",25 "value": "400.00"26 },27 "id": "1"28 },29 "links": [{30 "rel": "self",31 "href": "https://api-m.sandbox.paypal.com/v1/issuance/cards/2712-d1b2b4ca-2ae4-4835-a8e4-7f802703412e",32 "method": "GET"33 }]34}
Next
You can deactivate, reactivate, reissue, or close a PayPal debit card.