Get balances (yekar.paypal.get-balances) | Read | The PayPal account's balances, per currency: total is everything in the account, available is what can actually be spent or withdrawn, and withheld is the difference - a rolling reserve or funds under review. They are separate currencies and must not be added together. Requires the Transaction Search feature on the app. |
List transactions (yekar.paypal.list-transactions) | Read | A page of account transactions in a date window - payments, refunds, fees, payouts and transfers - with the gross amount, PayPal's fee, the payer and the resulting balance. The window is at most 31 days per call (PayPal's limit; longer periods need several calls) and data can lag up to 3 hours. Requires the Transaction Search feature on the app. This endpoint DOES report a true total for the window. |
Get order (yekar.paypal.get-order) | Read | One checkout order by id, with its purchase units, captures and refunds. The STATUS is the thing to read: CREATED means nobody has paid yet (the buyer still has to approve), APPROVED means they approved but the money has NOT been taken until it is captured, and only COMPLETED means funds moved. |
Get capture (yekar.paypal.get-capture) | Read | One captured payment by id: its status, the gross amount, PayPal's fee and the NET that reached the merchant balance. A PENDING capture has not put money in the account yet. This id is what Refund capture takes. |
Get refund (yekar.paypal.get-refund) | Read | One refund by id: status, amount, the part of PayPal's fee returned with it, and the total refunded against the parent capture. On most PayPal accounts the fixed part of the fee is NOT returned, so a full refund still costs the merchant something - paypalFee here is what actually came back. |
List invoices (yekar.paypal.list-invoices) | Read | A page of invoices with their status, totals and what is still due. status is the thing to read: a DRAFT has not been sent to anyone, SENT is awaiting payment, and dueAmount is what is actually outstanding. The total across all pages is PayPal's own count, requested explicitly rather than derived from the page. |
Get invoice (yekar.paypal.get-invoice) | Read | One invoice by id with its line items (up to 25; itemsOmitted counts the rest), recipient, due date and the amount still outstanding. recipientViewUrl is the page the customer pays on, when PayPal supplies one. |
List disputes (yekar.paypal.list-disputes) | Read | Open and recent disputes and chargebacks, with the amount, the stage they have reached (INQUIRY → CHARGEBACK → ARBITRATION) and - most importantly - sellerResponseDue, the deadline after which a case is usually lost by default. Filter by REQUIRED_ACTION to see only the ones waiting on the merchant. Read-only: responding to a dispute needs evidence and a human. |
Get dispute (yekar.paypal.get-dispute) | Read | One dispute by id: reason, amount, lifecycle stage, the transaction it concerns and the seller's response deadline. Read-only - contesting a dispute requires evidence and a human decision. |
Create order (yekar.paypal.create-order) | Write | Create a PayPal checkout order and return the link the BUYER must approve. This takes no money - approval is a page the buyer completes, and the funds only move when the order is captured afterwards. Amounts are decimal strings with a currency code (PayPal does not use minor units). Set invoiceId to your own reference: PayPal enforces it is unique per merchant, so it is a real guard against charging twice for the same thing. |
Capture order (yekar.paypal.capture-order) | Write | Capture an approved PayPal order - this is the step that actually TAKES the money. The order must already have been approved by the buyer (Get order shows status APPROVED); capturing a CREATED order fails because nobody has consented yet. Capturing an already-captured order is reported as a conflict, not repeated. |
Refund capture (yekar.paypal.refund-capture) | Write | Refund a captured PayPal payment, fully or partially. Amounts are decimal strings with a currency code, not minor units. This moves real money back to the buyer and cannot be undone. Note PayPal usually does NOT return the fixed part of its processing fee, so even a full refund leaves the merchant out of pocket by that amount. |
Create draft invoice (yekar.paypal.create-draft-invoice) | Write | Create a DRAFT invoice. Nothing is emailed and nobody is asked for money - the invoice sits in PayPal until Send invoice is run explicitly. Amounts are decimal strings with a currency code, not minor units. |
Send invoice (yekar.paypal.send-invoice) | Write | Send a draft invoice - this EMAILS the recipient and asks them to pay. It cannot be recalled. Running it again on an already-sent invoice sends a reminder, so it is not safe to repeat blindly. Read the invoice first if you are unsure whether it has already gone out. |