Home
HomeGuidesAPI ReferenceChangelogPOS PaymentsOnline Payments
Home
API Reference

Create PayPal refund

post
https://example.com/api/v1/paymentmethods/paypal/v1/transactions//refunds

Create a refund for an existing PayPal transaction. The transactionId parameter must be the ID of the transaction to be refunded.

The amount field is required and must be a positive value, which is the amount to be refunded.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
length between 36 and 36

ID received in the POST transaction response root object, which can be used in up following calls like refunds or cancellations as transactionId.

Body Params
integer
1 to 99999999

Denomination in the smallest currency subunit, as for example euro cents. If empty, the refund amount will be the remaining available amount of the transaction (i.e., total payment amount minus already refunded amounts minus the amounts of the pending refund requests).

string
length ≤ 255

The description for the refund for administrative purpose only. This reason will be visible in the portal.

Responses

Updated about 1 month ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago