PayPal Vault Id Deletion

Overview

The PayPal Vault Id Deletion API call removes the Vault Id by deleting the associated Vault Id. This ensures that the payment details are no longer available for future transactions.

To initiate deletion, the request must include the payPalVaultData element containing the Vault Id. Once processed, this ID can no longer be used for payment authorization.

URI Description

Action	URI Template	URI Example	Request Content Type	Response Content Type
POST	/vM.m/stores/{StoreID}/payments/payment-method/delete/{tenderType}.json	/v1.0/stores/TMSUS/payments/payment-method/delete/PY.json	application/json	application/json

Request Elements

Element	Required	Description	Type	Restriction
createTimestamp	Required	Timestamp when the request is sent	String	dateTime
@requestId	Yes	RequestId is used to uniquely identify a request, including as part of idempotent duplicate request processing. The value must be unique. It is recommended to use a variant 4 UUID for the request ID. The same request ID should only be reused if a read timeout occurs when attempting to receive a response from the payment service, or the payment service responds with a fault response. In all other cases a new request ID must be sent for retried requests, including responses such as Fail, Timeout or PaymentProcessorTimeout.	String	40 Characters
OrderInformation/ OrderId	Yes	Order identifier.	String	minLength: 3, maxLength: 40
Amount/ Total/ Value	Yes	The Amount is always 0.	Decimal	2 precision points. (123.34)
Amount/ Total/ CurrencyCode	Yes	Preferred currency.	String	3-character ISO 4217 code (for example, USD, CAD, EUR). See http://en.wikipedia.org/ wiki/ISO_4217.
PaymentMethod/ PayPalVaultData/ Token	No	Token from SetExpress response	String	20 single-byte characters
PaymentMethod/ PayPalVaultData/ CustomerId	Yes	Customer Id	String	Between 1 and 22 Characters.

Request Example

The request is a JSON data.

Copy

{
    "orderInformation": {
        "orderId": "1206323641"
    },
    "amounts": {
        "total": {
            "value": 0,
            "currencyCode": "USD"
        }
    },
    "paymentMethod": {
        "tender": "PY",
        "payPalVaultData": {
            "id": "2lb93782wc434364b"
        }
    },
    "requestId": "PAYAU1206323641",
    "createTimestamp": "2025-03-06T05:21:56Z"
}

Response Elements

The response is a JSON data.

Element	Required	Description	Type	Restriction
Success	Yes	Success or Failure.	Boolean	true or false
Result/ ResponseCode	Yes	Response code.	String	Success, Fail, Approved, Declined, Cancelled, Error or Timeout
Result/ ResponseCodeDescription	Yes	Response code description.	String	Generated by PayPal

Success Response Example

The response is a PayPalSetExpressCheckoutReply message.

Copy

{
    "success" : true,
    "requestId" : "PAYAU1206323641",
    "result" : {
        "responseCode" : "Success",
        "responseCodeDescription" : "PayPal vault delete request processed."
    }
}

Timeout Response

In the event of a Timeout, ensure the same request ID is passed to support idempotency detection.

Copy

{
    "success" : false,
    "errors" : [
        {
            "systemId" : "fe7daf05-b8ae-42a8-ac8e-b8ca9e799634",
            "code" : "TIMEOUT",
            "message" : "A gateway timeout occurred while processing the request."
        }
    ]
}

Fault Response

The errors are the list.

Copy

{
    "success": false,
    "errors": [
        {
            "systemId": "84d256fa-5515-48a9-bd2f-cdb1495ba28a",
            "code": "InvalidRequestJsonException",
            "message": "$: required property 'createTimestamp' not found"
        },
        {
            "systemId": "322a1744-92de-4821-a483-0c6006c544e8",
            "code": "InvalidRequestJsonException",
            "message": "$: required property 'requestId' not found"
        }
    ]
}