Real-time account updater for multiparty

Use real-time account updates to reduce declined card payments. Real-time account updater increases payment success by asking the card issuer for updates about the buyer's card, and applying any changes to the current card.

Use this integration guide if you are a developer from a third-party platform or marketplace that offers PayPal as a payment processing gateway to your sellers.

If you are new to PayPal, visit this page to learn more about the third-party platforms available for your integration.

If you are a merchant and already have a shop set up with any of PayPal's third-party partners, ask your provider if they already support this feature. If the partner can offer you this feature, you don't need to follow the instructions in this guide.

What is real-time account updater?

A buyer's credit or debit card can be declined for many reasons. When a card on file expires, is lost or stolen, or changes for any other reason, payments using that saved card are declined. A declined card can interrupt or prevent a transaction and impact your relationship with that customer.

Only cards that the customer has saved for future payments are eligible for real-time updates. The card can be saved from a previous successful transaction in the partner's vault, or a third-party PCI-compliant vaulting solution provider. When triggered, real-time account updater obtains the updated card information to use for the payment. The API response includes data about the card used to complete the payment. For details on how to save a card for future payments, visit Save payment methods.

Examples of payments using a card on file include:

• Recurring payments on a subscription for a service or a product.
• Online or mobile checkout using a previously saved credit or debit card.

Real-time account updater doesn't apply to mobile payments from a digital wallet, such as Apple Pay, Google Pay, and Samsung Pay.

Note: Even cards that qualify for real-time updates may not be updated during a transaction. Read PayPal's Online Card Payment Services Agreement for details.

Eligibility

Real-time account updater is a limited early access program for all partners with the following integrations enabled:

• Advanced credit and debit card payments.
• Save payment methods.

Real-time account updates only occur on subsequent card payments using a card on file. For examples of subsequent payment scenarios, see the Strong Customer Authentication payment indicators page.

Real-time account updater works when issuers agree to share card updates via card networks. PayPal can’t provide a card update when the card issuer or cardholder opts out of automatic updates. When a card account doesn’t support real-time account updates, request a card update directly from the cardholder.

If you're interested in using real-time account updater and are already a partner affiliated with PayPal, contact your PayPal sales representative. To apply to become a PayPal partner, go to the PayPal Partners page and select Contact us.

Supported countries

The following table shows the card types and countries that real-time account updater supports.

• Issuing country: The country of the bank that issues the card.
• Merchant country: The country where the merchant receives the payment.

How it works

PayPal works with Mastercard and Visa to reduce declined payments using real-time account updates.

API responses for real-time account updater

Real-time account updates use specific fields and error codes that could impact your existing integration.

Real-time account updater supports multiparty payments for cards and tokens.

Payment requests with a card

Payment requests that use a card return 2 additional parameters: expiry and from_request.

expiry response

The expiry response field is included in the card object and returns the expiration date of the card used for payment.

from_request response

The from_request response field shows the last 4 digits and expiration date of the card submitted for the payment.

Sample payment response

1{
2  "payment_source": {
3    "card": {
4        "last_digits": "2557",
5        "expiry": "2040-12",
6        "from_request": {
7            "expiry": "2023-01",
8            "last_digits": "4792"
9        },
10        "brand": "MASTER_CARD",
11        "type": "CREDIT"
12    }
13  }
14}

Sample payment response for closed card error

The HTTP 422 error response is returned when a card on file when a card on file that is marked as closed is used for payment.

1{
2    "name": "UNPROCESSABLE_ENTITY",
3    "details": [
4            {
5                "field": "payment_source/card",
6                "location": "body",
7                "issue": "CARD_CLOSED",
8                "description": "The card is closed."
9            }
10    ],
11    "message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
12    "debug_id": "6a20810eaecc5",
13    "links": [
14            {
15                "href": "/docs/api/orders/v2/#error-CARD_CLOSED",
16                "rel": "information_link",
17                "method": "GET"
18            }
19    ]
20  }

Payment requests with a token

Payment requests that use a payment token return 2 additional parameters: expiry and last_digits.

When PayPal completes a payment using an updated expiration or primary account number (PAN):

• The response fields pass the new values instead of the old values stored in the payment method in PayPal's vault.
• PayPal updates the vaulted payment method with the new values.

expiry response

The expiry response field is included in the card object and returns the expiration date of the card used for payment.

last_digits response

The last_digits response field is included in the card object and returns the last 4 digits of the card number used for payment.

Sample payment response

1{
2  "payment_source": {
3    "card": {
4        "last_digits": "2557",
5        "expiry": "2040-12",
6        "brand": "MASTER_CARD",
7        "type": "CREDIT"
8    }
9  }

Sample payment response for closed card error

The HTTP 422 error response is returned when a card on file that is marked as closed is used for payment.

1{
2    "name": "UNPROCESSABLE_ENTITY",
3    "details": [
4            {
5                "field": "payment_source/card",
6                "location": "body",
7                "issue": "CARD_CLOSED",
8                "description": "The card is closed."
9            }
10    ],
11    "message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
12    "debug_id": "6a20810eaecc5",
13    "links": [
14            {
15                "href": "/docs/api/orders/v2/#error-CARD_CLOSED",
16                "rel": "information_link",
17                "method": "GET"
18            }
19    ]
20  }

Postman collection

Download the Postman collection for real-time account updater to test making updates to cards.

Sample card change scenarios

This section shows how real-time account updater responds to 6 different card changes.

Note: The payment token id in these code samples is a placeholder. Generate and use your own payment token.

1{
2    "intent": "CAPTURE",
3    "payment_source": {
4        "card": {
5            "number": "4417164131206198",
6            "expiry": "2022-01",
7            "name": "Firstname Lastname",
8            "stored_credential": {
9                "payment_initiator": "CUSTOMER",
10                "payment_type": "UNSCHEDULED",
11                "usage": "SUBSEQUENT"
12            }
13        }
14    },
15    "payer": {
16        "name": {
17            "given_name": "Firstname Lastname",
18            "surname": "user"
19        },
20        "address": {
21            "address_line_1": "123 Main St.",
22            "address_line_2": "",
23            "admin_area_2": "Anytown",
24            "admin_area_1": "CA",
25            "postal_code": "12345",
26            "country_code": "US"
27        }
28    },
29    "purchase_units": [
30        {
31            "reference_id": "123_34897583499",
32            "description": "Item bought at Hemm Store",
33            "custom_id": "1111",
34            "soft_descriptor": "",
35            "amount": {
36                "currency_code": "USD",
37                "value": "80.00"
38            },
39            "shipping": {
40                "address": {
41                    "address_line_1": "123 Main St.",
42                    "address_line_2": "",
43                    "admin_area_2": "Anytown",
44                    "admin_area_1": "CA",
45                    "postal_code": "12345",
46                    "country_code": "US"
47                }
48            },
49            "payee": {
50                "email_address": "payer@example.com"
51            }
52        }
53    ]
54}