Provide Lifecycle Updates
Last updated: Sept 23rd, 8:12pm
You can set up lifecycle updates to keep customer data fresh. The following lifecycle event types are supported:
- Update an instrument
- Expiration date changed
- Billing address changed
- Card number changed
- Remove an instrument
Note: This step is optional, but recommended for a better user experience. You can choose to provide lifecycle updates for any or none of these events.
Lifecycle updates flow sequence diagram
The following diagram illustrates the end-to-end flow used for lifecycle updates.
Update an instrument
To update a provisioned instrument, use the Update Instrument API. You can update the card expiration date, billing address, and account information.
Endpoints
-
Live:
https://api-m.paypal.com/v1/payment-networks/card-accounts/<id >
-
Test/Sandbox:
https://api-m.sandbox.paypal.com/v1/payment-networks/card-accounts/<id >
-
Sample request
1curl -v -X PATCH https://api-m.sandbox.paypal.com/payment-networks/v1/card-accounts/<id > \2 -H "PayPal-Request-Id: 12345" \3 -H "Content-Type: application/json" \4 -H "Authorization: Bearer Access-Token" \5 -d '[{6 "op": "replace",7 "path": "/billing_address",8 "value": {9 "address_line_1" : "100 Newhall St",10 "admin_area_2" : "Santa Clara",11 "admin_area_1" : "CA"12 "country_code" : "US"13 "postal_code" : "95125"14 },15 {16 "op": "replace",17 "path": "/expiry_date",18 "value": "2099-12"19 }20 {21 "op": "replace",22 "path": "/card_pan",23 "value": "4417119667593658"24 }25 ]'
Remove an instrument
To remove a provisioned instrument from the PayPal wallet, use the Remove Instrument API. Removal requests may result from a system action (closed account, fraud, lost or stolen card) or user action (user unlinks instrument).
Endpoints
-
Live:
https://api-m.paypal.com/v1/payment-networks/v1/card-accounts/<id >/remove
-
Test/Sandbox:
https://api-m.sandbox.paypal.com/v1/payment-networks/card-accounts/<id >/remove
-
Sample request
1curl -v -X POST https://api-m.sandbox.paypal.com/payment-networks/v1/card-accounts/<id >/remove \2 -H "PayPal-Request-Id: 12345" \3 -H "Content-Type: application/json" \4 -H "Authorization: Bearer <Access-Token>" \5 -d '{6 "reason": "REISSUED"7}'
- Sample responses
Source | Description |
---|---|
Partner-initiated requests | 204 No Content |
PayPal-initiated requests | { "status":"204 No Content", "headers": { "PayPal-Request-Id": "12345", "Content-Type":"application/json" } |
Next
See Reference for resources used by this integration.