Last updated: Jan 7th, 8:14am
Refund a captured payment from a seller back to a buyer.
To use this integration you must:
Pass the PayPal-Auth-Assertion and the PayPal-Partner-Attribution-Id headers with the standard Content-Type, Authorization, and PayPal-Request-ID headers. On the client side, you can generate the value of the PayPal-Auth-Assertion header as follows:
1function encodeObjectToBase64(object) {2 const objectString = JSON.stringify(object);3 return window.btoa(objectString);4}56const clientId = "CLIENT-ID";7const sellerPayerId = "SELLER-PAYER-ID"; // preferred8// const sellerEmail = "SELLER-ACCOUNT-EMAIL"; // use instead of payer-id if required910const header = {11 alg: "none"12};13const encodedHeader = encodeObjectToBase64(header);1415const payload = {16 iss: clientId,17 payer_id: sellerPayerId18 // email: sellerEmail19};20const encodedPayload = encodeObjectToBase64(payload);2122const jwt = `${encodedHeader}.${encodedPayload}.`; // json web token23console.log(`Paypal-Auth-Assertion=${jwt}`);
Copy the code and modify the following:
clientId.sellerPayerId is the payer ID of the receiving seller's PayPal account. You can also use email instead of payer_id and supply the email address of the seller's PayPal account.
To refund an order, use the /v2/payments/captures/{CAPTURE-ID}/refund endpoint. The CAPTURE-ID can be read from the purchase_units/payments/captures/id field of the order you want to refund.
1curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/captures/2GG279541U471931P/refund \2 -H 'Content-Type: application/json' \3 -H 'Authorization: Bearer ACCESS-TOKEN' \4 -H 'PayPal-Partner-Attribution-Id: BN-CODE' \5 -H 'PayPal-Auth-Assertion: AUTH-ASSERTION-JWT' \6 -H 'PayPal-Request-Id: REQUEST-ID' \7 -d '{}'
For a full refund, include an empty payload in the JSON request body.
For a partial refund, include the amount object in the JSON request body. You can also issue multiple partial refunds up to the total captured amount. If you are unsure how much captured amount is remaining to be refunded after one or more partial refunds, make the API call with the total captured amount or leave the amount field blank. The API will automatically calculate and issue the refund for the remaining value.
Copy the code and modify the following:
ACCESS-TOKEN to your access token.BN-CODE to your PayPal Attribution ID to receive revenue attribution. To find your BN code, see Code and Credential Reference.AUTH-ASSERTION-JWT to your PayPal-Auth-Assertion token.REQUEST-ID to a set of unique alphanumeric characters such as a timestamp to prevent duplicate transactions.A successful request returns the HTTP 201 Created status code. If you didn't receive a response, making the same API call without changing the request should result in an HTTP 200 OK with a confirmation of the refund.
For more information about the refunds API, see the Payment API.
Go through the integration checklist before you go live.