Masterarbeit

Search

SearchSearch

PayPal APIs

Jun 20, 202422 min read

Search Link: https://www.google.com/search?channel=fs&client=ubuntu-sn&q=postman+collection+19024122-92a85d0e-51e7-47da-9f83-c45dcb1cdf24

Overview

GET /v1/identity/oauth2/userinfo

Summary: User Info

Shows user profile information. Filters the response by a schema. Supported schema value is paypalv1.1.

GET /v2/checkout/orders/{order_id}

Summary: Show order details

Shows details for an order, by ID.

Note: For error handling and troubleshooting, see Orders v2 errors.

PATCH /v2/checkout/orders/{order_id}

Summary: Update order

Updates an order with a CREATED or APPROVED status. You cannot update an order with the COMPLETED status.

To make an update, you must provide a reference_id. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to default which enables you to use the path: “/purchase_units/@reference_id==‘default’/{attribute-or-object}“.

Note: For error handling and troubleshooting, see Orders v2 errors.
Patchable attributes or objects:

AttributeOpNotes
intentreplace
payerreplace, addUsing replace op for payer will replace the whole payer object with the value sent in request.
purchase_unitsreplace, add
purchase_units[].custom_idreplace, add, remove
purchase_units[].descriptionreplace, add, remove
purchase_units[].payee.emailreplace
purchase_units[].shipping.namereplace, add
purchase_units[].shipping.addressreplace, add
purchase_units[].shipping.typereplace, add
purchase_units[].soft_descriptorreplace, remove
purchase_units[].amountreplace
purchase_units[].invoice_idreplace, add, remove
purchase_units[].payment_instructionreplace
purchase_units[].payment_instruction.disbursement_modereplaceBy default, disbursement_mode is INSTANT.
purchase_units[].payment_instruction.platform_feesreplace, add, remove

PARAMETERS /v2/checkout/orders/{order_id}

POST /v2/checkout/orders/{order_id}/authorize

Summary: Authorize payment for order

Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.

Note: For error handling and troubleshooting, see Orders v2 errors.

PARAMETERS /v2/checkout/orders/{order_id}/authorize

POST /v2/checkout/orders/{order_id}/capture

Summary: Capture payment for order

Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.

Note: For error handling and troubleshooting, see Orders v2 errors.

PARAMETERS /v2/checkout/orders/{order_id}/capture

GET /v2/payments/authorizations/{authorization_id}

Summary: Show details for authorized payment

Shows details for an authorized payment, by ID.

PARAMETERS /v2/payments/authorizations/{authorization_id}

POST /v2/payments/authorizations/{authorization_id}/reauthorize

Summary: Reauthorize authorized payment

Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.

If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.

A reauthorized payment itself has a new honor period of three days.

You can reauthorize an authorized payment once for up to 115% of the original authorized amount, not to exceed an increase of $75 USD.

Supports only the amount request parameter.

Note: This request is currently not supported for Partner use cases.

PARAMETERS /v2/payments/authorizations/{authorization_id}/reauthorize

POST /v2/payments/authorizations/{authorization_id}/void

Summary: Void authorized payment

Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.

PARAMETERS /v2/payments/authorizations/{authorization_id}/void

POST /v2/payments/authorizations/{authorization_id}/capture

Summary: Capture authorized payment

Captures an authorized payment, by ID.

PARAMETERS /v2/payments/authorizations/{authorization_id}/capture

GET /v2/payments/captures/{capture_id}

Summary: Show captured payment details

Shows details for a captured payment, by ID.

PARAMETERS /v2/payments/captures/{capture_id}

POST /v2/payments/captures/{capture_id}/refund

Summary: Refund captured payment

Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an amount object in the JSON request body.

PARAMETERS /v2/payments/captures/{capture_id}/refund

GET /v2/payments/refunds/{refund_id}

Summary: Show refund details

Shows details for a refund, by ID.

PARAMETERS /v2/payments/refunds/{refund_id}

GET /v2/invoicing/invoices/{invoice_id}

Summary: Show invoice details

Shows details for an invoice, by ID.

PUT /v2/invoicing/invoices/{invoice_id}

Summary: Fully update invoice

Fully updates an invoice, by ID. In the JSON request body, include a complete invoice object. This call does not support partial updates.

DELETE /v2/invoicing/invoices/{invoice_id}

Summary: Delete invoice

Deletes a draft or scheduled invoice, by ID. Deletes invoices in the draft or scheduled state only. For invoices that have already been sent, you can cancel the invoice. After you delete a draft or scheduled invoice, you can no longer use it or show its details. However, you can reuse its invoice number.

PARAMETERS /v2/invoicing/invoices/{invoice_id}

GET /v2/invoicing/invoices

Summary: List invoices

Lists invoices. To filter the invoices that appear in the response, you can specify one or more optional query parameters.

POST /v2/invoicing/invoices/{invoice_id}/generate-qr-code

Summary: Generate QR code

Generates a QR code for an invoice, by ID. The QR code is a PNG image in Base64-encoded format that corresponds to the invoice ID. You can generate a QR code for an invoice and add it to a paper or PDF invoice. When customers use their mobile devices to scan the QR code, they are redirected to the PayPal mobile payment flow where they can view the invoice and pay online with PayPal or a credit card. Before you get a QR code, you must create an invoice and send an invoice to move the invoice from a draft to payable state. Do not include an email address if you do not want the invoice emailed.

PARAMETERS /v2/invoicing/invoices/{invoice_id}/generate-qr-code

POST /v2/invoicing/invoices/{invoice_id}/send

Summary: Send invoice

Sends or schedules an invoice, by ID, to be sent to a customer. The action depends on the invoice issue date:

  • If the invoice issue date is current or in the past, sends the invoice immediately.
  • If the invoice issue date is in the future, schedules the invoice to be sent on that date.
To suppress the merchant’s email notification, set the send_to_invoicer body parameter to false. To send the invoice through a share link and not through PayPal, set the send_to_recipient parameter to false in the notification object. The send_to_recipient parameter does not apply to a future issue date because the invoice is scheduled to be sent through PayPal on that date.
Notes:
  • After you send an invoice, resending it has no effect.
  • To send a notification for updates, update the invoice and set the send_to_recipient body parameter to true.

PARAMETERS /v2/invoicing/invoices/{invoice_id}/send

POST /v2/invoicing/invoices/{invoice_id}/remind

Summary: Send invoice reminder

Sends a reminder to the payer about an invoice, by ID. In the JSON request body, include a notification object that defines the subject of the reminder and other details.

PARAMETERS /v2/invoicing/invoices/{invoice_id}/remind

POST /v2/invoicing/invoices/{invoice_id}/cancel

Summary: Cancel sent invoice

Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and CC: emails.

PARAMETERS /v2/invoicing/invoices/{invoice_id}/cancel

POST /v2/invoicing/search-invoices

Summary: Search for invoices

Searches for and lists invoices that match search criteria. If you pass multiple criteria, the response lists invoices that match all criteria.

POST /v2/invoicing/invoices/{invoice_id}/payments

Summary: Record payment for invoice

Records a payment for the invoice. If no payment is due, the invoice is marked as PAID. Otherwise, the invoice is marked as PARTIALLY PAID.

PARAMETERS /v2/invoicing/invoices/{invoice_id}/payments

DELETE /v2/invoicing/invoices/{invoice_id}/payments/{transaction_id}

Summary: Delete external payment

Deletes an external payment, by invoice ID and transaction ID.

PARAMETERS /v2/invoicing/invoices/{invoice_id}/payments/{transaction_id}

POST /v2/invoicing/invoices/{invoice_id}/refunds

Summary: Record refund for invoice

Records a refund for the invoice. If all payments are refunded, the invoice is marked as REFUNDED. Otherwise, the invoice is marked as PARTIALLY REFUNDED.

PARAMETERS /v2/invoicing/invoices/{invoice_id}/refunds

DELETE /v2/invoicing/invoices/{invoice_id}/refunds/{transaction_id}

Summary: Delete external refund

Deletes an external refund, by invoice ID and transaction ID.

PARAMETERS /v2/invoicing/invoices/{invoice_id}/refunds/{transaction_id}

GET /v2/invoicing/templates

Summary: List templates

Lists merchant-created templates with associated details. The associated details include the emails, addresses, and phone numbers from the user’s PayPal profile.
The user can select which values to show in the business information section of their template.

GET /v2/invoicing/templates/{template_id}

Summary: Show template details

Shows details for a template, by ID.

PUT /v2/invoicing/templates/{template_id}

Summary: Fully update template

Fully updates a template, by ID. In the JSON request body, include a complete template object. This call does not support partial updates.

DELETE /v2/invoicing/templates/{template_id}

Summary: Delete template

Deletes a template, by ID.

PARAMETERS /v2/invoicing/templates/{template_id}

GET /v1/catalogs/products

Summary: List products

Lists products.

GET /v1/catalogs/products/{product_id}

Summary: Show product details

Shows details for a product, by ID.

PATCH /v1/catalogs/products/{product_id}

Summary: Update product

Updates a product, by ID. You can patch these attributes and objects:

Attribute or objectOperations
descriptionadd, replace, remove
categoryadd, replace, remove
image_urladd, replace, remove
home_urladd, replace, remove

PARAMETERS /v1/catalogs/products/{product_id}

GET /v1/billing/plans

Summary: List plans

Lists billing plans.

GET /v1/billing/plans/{billing_plan_id}

Summary: Show plan details

Shows details for a plan, by ID.

PATCH /v1/billing/plans/{billing_plan_id}

Summary: Update plan

Updates a plan with the CREATED or ACTIVE status. For an INACTIVE plan, you can make only status updates.
You can patch these attributes and objects:

Attribute or objectOperations
descriptionreplace
payment_preferences.auto_bill_outstandingreplace
taxes.percentagereplace
payment_preferences.payment_failure_thresholdreplace
payment_preferences.setup_feereplace
payment_preferences.setup_fee_failure_actionreplace
namereplace

PARAMETERS /v1/billing/plans/{billing_plan_id}

POST /v1/billing/plans/{billing_plan_id}/deactivate

Summary: Deactivate plan

Deactivates a plan, by ID.

PARAMETERS /v1/billing/plans/{billing_plan_id}/deactivate

POST /v1/billing/plans/{billing_plan_id}/activate

Summary: Activate plan

Activates a plan, by ID.

PARAMETERS /v1/billing/plans/{billing_plan_id}/activate

POST /v1/billing/plans/{billing_plan_id}/update-pricing-schemes

Summary: Update pricing

Updates pricing for a plan. For example, you can update a regular billing cycle from 7 per month.

PARAMETERS /v1/billing/plans/{billing_plan_id}/update-pricing-schemes

GET /v1/billing/subscriptions/{subscription_id}

Summary: Show subscription details

Shows details for a subscription, by ID.

PATCH /v1/billing/subscriptions/{subscription_id}

Summary: Update subscription

Updates a subscription which could be in ACTIVE or SUSPENDED status. You can override plan level default attributes by providing customised values for plan path in the patch request.

  • You cannot update attributes that have already completed (Example - trial cycles can’t be updated if completed).
  • Once overridden, changes to plan resource will not impact subscription.
  • Any price update will not impact billing cycles within next 10 days (Applicable only for subscriptions funded by PayPal account).
Following are the fields eligible for patch.
Attribute or objectOperations
billing_info.outstanding_balancereplace
custom_idadd,replace
plan.billing_cycles[@sequence==n].
pricing_scheme.fixed_price		add,replace
plan.billing_cycles[@sequence==n].
pricing_scheme.tiers		replace
plan.billing_cycles[@sequence==n].
total_cycles		replace
plan.payment_preferences.
auto_bill_outstanding		replace
plan.payment_preferences.
payment_failure_threshold		replace
plan.taxes.inclusiveadd,replace
plan.taxes.percentageadd,replace
shipping_amountadd,replace
start_timereplace
subscriber.shipping_addressadd,replace
subscriber.payment_source (for subscriptions funded
by card payments)		replace

PARAMETERS /v1/billing/subscriptions/{subscription_id}

POST /v1/billing/subscriptions/{subscription_id}/revise

Summary: Revise plan or quantity of subscription

Updates the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the shipping_amount, shipping_address values for the subscription. This type of update requires the buyer’s consent.

PARAMETERS /v1/billing/subscriptions/{subscription_id}/revise

POST /v1/billing/subscriptions/{subscription_id}/suspend

Summary: Suspend subscription

Suspends the subscription.

PARAMETERS /v1/billing/subscriptions/{subscription_id}/suspend

POST /v1/billing/subscriptions/{subscription_id}/activate

Summary: Activate subscription

Activates the subscription.

PARAMETERS /v1/billing/subscriptions/{subscription_id}/activate

POST /v1/billing/subscriptions/{subscription_id}/cancel

Summary: Cancel subscription

Cancels the subscription.

PARAMETERS /v1/billing/subscriptions/{subscription_id}/cancel

POST /v1/billing/subscriptions/{subscription_id}/capture

Summary: Capture authorized payment on subscription

Captures an authorized payment from the subscriber on the subscription.

PARAMETERS /v1/billing/subscriptions/{subscription_id}/capture

GET /v1/billing/subscriptions/{subscription_id}/transactions

Summary: List transactions for subscription

Lists transactions for a subscription.

PARAMETERS /v1/billing/subscriptions/{subscription_id}/transactions

GET /v1/payments/payouts/{payout_batch_id}

Summary: Show payout batch details

Shows the latest status of a batch payout. Includes the transaction status and other data for individual payout items.

PARAMETERS /v1/payments/payouts/{payout_batch_id}

GET /v1/payments/payouts-item/{payout_item_id}

Summary: Show payout item details

Shows details for a payout item, by ID. A payout_item_id helps you identify denied payments. If a payment is denied, you can use the payout_item_id to identify the payment even if it lacks a transaction_id.

PARAMETERS /v1/payments/payouts-item/{payout_item_id}

POST /v1/payments/payouts-item/{payout_item_id}/cancel

Summary: Cancel unclaimed payout item

Cancels an unclaimed payout item, by ID. If no one claims the unclaimed item within 30 days, the API automatically returns the funds to the sender. Use this call to cancel the unclaimed item before the automatic 30-day refund. You can cancel payout items with a transaction_status of UNCLAIMED.

PARAMETERS /v1/payments/payouts-item/{payout_item_id}/cancel

GET /v1/notifications/webhooks

Summary: List webhooks

Lists webhooks for an app.

GET /v1/notifications/webhooks/{webhook_id}

Summary: Show webhook details

Shows details for a webhook, by ID.

DELETE /v1/notifications/webhooks/{webhook_id}

Summary: Delete webhook

Deletes a webhook, by ID.

PATCH /v1/notifications/webhooks/{webhook_id}

Summary: Update webhook

Updates a webhook to replace webhook fields with new values. Supports only the replace operation. Pass a json_patch object with replace operation and path, which is /url for a URL or /event_types for events. The value is either the URL or a list of events.

PARAMETERS /v1/notifications/webhooks/{webhook_id}

GET /v1/notifications/webhooks-events

Summary: List event notifications

Lists webhooks event notifications. Use query parameters to filter the response.

GET /v1/notifications/webhooks/{webhook_id}/event-types

Summary: List event subscriptions for webhook

Lists event subscriptions for a webhook, by ID.

PARAMETERS /v1/notifications/webhooks/{webhook_id}/event-types

GET /v1/notifications/webhooks-events/{event_id}

Summary: Show event notification details

Shows details for a webhooks event notification, by ID.

PARAMETERS /v1/notifications/webhooks-events/{event_id}

POST /v1/notifications/webhooks-events/{event_id}/resend

Summary: Resend event notification

Resends a webhook event notification, by ID. Any pending notifications are not resent.

PARAMETERS /v1/notifications/webhooks-events/{event_id}/resend

GET /v1/shipping/trackers/{tracking_id}

Summary: Show tracking information

Shows tracking information, by tracker ID, for a PayPal transaction.

PUT /v1/shipping/trackers/{tracking_id}

Summary: Update or cancel tracking information for PayPal transaction

Updates or cancels the tracking information for a PayPal transaction, by ID. To cancel tracking information, call this method and set the status to CANCELLED. For more information, see Update or cancel tracking information.

PARAMETERS /v1/shipping/trackers/{tracking_id}

GET /v1/reporting/transactions

Summary: List transactions

Lists transactions. Specify one or more query parameters to filter the transaction that appear in the response.

Notes:
  • If you specify one or more optional query parameters, the ending_balance response field is empty.
  • It takes a maximum of three hours for executed transactions to appear in the list transactions call.
  • This call lists transaction for the previous three years.

GET /v1/reporting/balances

Summary: List all balances

List all balances. Specify date time to list balances for that time that appear in the response.

Notes:
  • It takes a maximum of three hours for balances to appear in the list balances call.
  • This call lists balances upto the previous three years.

GET /v1/customer/disputes

Summary: List disputes

Lists disputes with a summary set of details, which shows the dispute_id, reason, status, dispute_state, dispute_life_cycle_stage, dispute_channel, dispute_amount, create_time and update_time fields.

To filter the disputes in the response, specify one or more optional query parameters. To limit the number of disputes in the response, specify the page_size query parameter.

To list multiple disputes, set these query parameters in the request:

  • page_size=2
  • start_time instead of disputed_transaction_id

If the response contains more than two disputes, it lists two disputes and includes a HATEOAS link to the next page of results.

GET /v1/customer/disputes/{dispute_id}

Summary: Show dispute details

Shows details for a dispute, by ID.

Note: The fields that appear in the response depend on whether you access this call through first- or third-party access. For example, if the merchant shows dispute details through third-party access, the customer’s email ID does not appear.

PATCH /v1/customer/disputes/{dispute_id}

Summary: Partially update dispute

Partially updates a dispute, by ID. Seller can update the communication_detail value or The partner can add the partner action information.

PARAMETERS /v1/customer/disputes/{dispute_id}

POST /v1/customer/disputes/{dispute_id}/accept-claim

Summary: Accept claim

Accepts liability for a claim, by ID. When you accept liability for a claim, the dispute closes in the customer’s favor and PayPal automatically refunds money to the customer from the merchant’s account. Allowed accept_claim_type values for the request is available in dispute details allowed response options object.

PARAMETERS /v1/customer/disputes/{dispute_id}/accept-claim

POST /v1/customer/disputes/{dispute_id}/appeal

Summary: Appeal dispute

Appeals a dispute, by ID. To appeal a dispute, use the appeal link in the HATEOAS links from the show dispute details response. If this link does not appear, you cannot appeal the dispute. Submit new evidence as a document or notes in the JSON request body. The following rules apply to document file types and sizes:

  • The merchant can upload up to 50 MB of files for a case.
  • Individual files must be smaller than 10 MB.
  • The supported file formats are JPG, GIF, PNG, and PDF.

To make this request, specify the dispute ID in the URI and specify the evidence in the JSON request body. For information about dispute reasons, see dispute reasons.

PARAMETERS /v1/customer/disputes/{dispute_id}/appeal

POST /v1/customer/disputes/{dispute_id}/adjudicate

Summary: Settle dispute

Important: This method is for sandbox use only.
Settles a dispute in either the customer's or merchant's favor. Merchants can make this call in the sandbox to complete end-to-end dispute resolution testing, which mimics the dispute resolution that PayPal agents normally complete. To make this call, the dispute status must be UNDER_REVIEW.

PARAMETERS /v1/customer/disputes/{dispute_id}/adjudicate

POST /v1/customer/disputes/{dispute_id}/require-evidence

Summary: Update dispute status

Important: This method is for sandbox use only.
Updates the status of a dispute, by ID, from UNDER_REVIEW to either:
  • WAITING_FOR_BUYER_RESPONSE
  • WAITING_FOR_SELLER_RESPONSE
This status change enables either the customer or merchant to submit evidence for the dispute. To make this call, the dispute status must be UNDER_REVIEW. Specify an action value in the JSON request body to indicate whether the status change enables the customer or merchant to submit evidence:
If action isThe status updates to
BUYER_EVIDENCE WAITING_FOR_BUYER_RESPONSE
SELLER_EVIDENCE WAITING_FOR_SELLER_RESPONSE

PARAMETERS /v1/customer/disputes/{dispute_id}/require-evidence

POST /v1/customer/disputes/{dispute_id}/make-offer

Summary: Make offer to resolve dispute

Makes an offer to the other party to resolve a dispute, by ID. To make this call, the stage in the dispute lifecycle must be INQUIRY. If the customer accepts the offer, PayPal automatically makes a refund. Allowed offer_type values for the request is available in dispute details allowed response options object.

PARAMETERS /v1/customer/disputes/{dispute_id}/make-offer

POST /v1/customer/disputes/{dispute_id}/provide-evidence

Summary: Provide evidence

Provides evidence for a dispute, by ID. A merchant can provide evidence for disputes with the WAITING_FOR_SELLER_RESPONSE status while customers can provide evidence for disputes with the WAITING_FOR_BUYER_RESPONSE status. Evidence can be a proof of delivery or proof of refund document or notes, which can include logs. A proof of delivery document includes a tracking number while a proof of refund document includes a refund ID. For other evidence type, notes and documents can be given. The following rules apply to document file types and sizes:

  • The merchant can upload up to 50 MB of files for a case.
  • Individual files must be smaller than 10 MB.
  • The supported file formats are JPG, GIF, PNG, and PDF.

To make this request, specify the dispute ID in the URI and specify the evidence in the JSON request body. For information about dispute reasons, see dispute reasons.

PARAMETERS /v1/customer/disputes/{dispute_id}/provide-evidence

POST /v1/customer/disputes/{dispute_id}/acknowledge-return-item

Summary: Acknowledge returned item

Acknowledges that the customer returned an item for a dispute, by ID. A merchant can make this request for disputes with the MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED reason. Allowed acknowledgement_type values for the request is available in dispute details allowed response options object.

PARAMETERS /v1/customer/disputes/{dispute_id}/acknowledge-return-item

POST /v1/customer/disputes/{dispute_id}/provide-supporting-info

Summary: Provide supporting information for dispute

Provides supporting information for a dispute, by ID. A merchant or buyer can make this request for disputes if they find the provide-supporting-info link in the HATEOAS links in the list disputes response. The party can provide the supporting information to PayPal to defend themselves only when the dispute_life_cycle_stage is CHARGEBACK, PRE_ARBITRATION, or ARBITRATION. They can provide a note that describes their part with details or upload any supporting documents to support their side. The following rules apply to document file types and sizes:

  • The party can upload up to 50 MB of files for a case.
  • Individual files must be smaller than 10 MB.
  • The supported file formats are JPG, GIF, PNG, and PDF.

To make this request, specify the dispute ID in the URI and specify the notes in the JSON request body. This method differs from the provide evidence method which supports only multipart request, where PayPal asks the concerned party for evidence.

PARAMETERS /v1/customer/disputes/{dispute_id}/provide-supporting-info

POST /v1/customer/disputes/{dispute_id}/escalate

Summary: Escalate dispute to claim

Escalates the dispute, by ID, to a PayPal claim. To make this call, the stage in the dispute lifecycle must be INQUIRY.

PARAMETERS /v1/customer/disputes/{dispute_id}/escalate

POST /v1/customer/disputes/{dispute_id}/accept-offer

Summary: Accept offer to resolve dispute

The customer accepts the offer from merchant to resolve a dispute, by ID. PayPal automatically refunds the amount proposed by merchant to the customer.

PARAMETERS /v1/customer/disputes/{dispute_id}/accept-offer

POST /v1/customer/disputes/{dispute_id}/send-message

Summary: Send message about dispute to other party

Sends a message about a dispute, by ID, to the other party in the dispute. Merchants and customers can only send messages if the dispute_life_cycle_stage value is INQUIRY.

PARAMETERS /v1/customer/disputes/{dispute_id}/send-message

POST /v1/customer/disputes/{dispute_id}/deny-offer

Summary: Deny offer to resolve dispute

Denies an offer that the merchant proposes for a dispute, by ID.

PARAMETERS /v1/customer/disputes/{dispute_id}/deny-offer

GET /v3/customer/managed-accounts

Summary: Search managed account through external id

Show details for managed accounts, based on search criteria.

The detailed description for the endpoint can be found on PayPal Developer Portal under Managed Accounts.

GET /v3/customer/managed-accounts/{id}

Summary: Search managed account by Seller Id

Shows details for a managed account, by account ID.

The detailed description for the endpoint can be found on PayPal Developer Portal under Managed Accounts.

PATCH /v3/customer/managed-accounts/{id}

Summary: Partially updates information for a managed account

Partially updates information for a managed account, by account ID. For information about the paths where you can replace, add, or delete information.

The fields and endpoint description can be found on PayPal Developer Portal under Managed Accounts.

PARAMETERS /v3/customer/managed-accounts/{id}

GET /v3/customer/managed-accounts/{id}/wallet-domains

Summary: Shows collection of registered wallet domains

Shows collection of registered wallet domains

Please look at sample (200 - Add Wallet Domain) attached under Manage Accounts PATCH Partially updates information for a managed account API.

The detailed description for the endpoint can be found on PayPal Developer Portal under Managed Accounts.

PARAMETERS /v3/customer/managed-accounts/{id}/wallet-domains

POST /v1/customer/supporting-documents/{token}/upload

Summary: Upload document by verification token

Upload reuqired document from local file directory to pass Third Party Verification (TPV).

After uploading document successfully with 204 status code, it will be automaticlly approve or reject by system simulator.

In POST Document Upload API, uploading a file containing approve keyword in attachment filed, the document will be automaticlly approved and Third Party Verification (TPV) will be completed; if uploading a file containing reject keyword, then document will be rejected and Third Party Verification (TPV) still need to reupload document.

This document upload API only works for accounts successfully created by POST call but not passed Third Party Verification (TPV), which status should be NEED_MORE_DATA.

Please refer to the required_document field in sample (200 - [EKYC Failed/Document Required] Get Account with Process View) attached under Manage Accounts GET Search managed account through external id API or GET Search managed account by Seller Id API .

PARAMETERS /v1/customer/supporting-documents/{token}/upload

GET /v3/vault/setup-tokens/{setup_token_id}

Summary: Retrieve a setup token

Returns a readable representation of temporarily vaulted payment source associated with the setup token id.

PARAMETERS /v3/vault/setup-tokens/{setup_token_id}

GET /v3/vault/payment-tokens/{payment_token_id}

Summary: Retrieve a payment token

Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.

DELETE /v3/vault/payment-tokens/{payment_token_id}

Summary: Delete payment token

Delete the payment token associated with the payment token id.

PARAMETERS /v3/vault/payment-tokens/{payment_token_id}

GET /v3/vault/payment-tokens

Summary: List all payment tokens for customer

Returns all payment tokens for a customer.

Graph View

Backlinks

  • No backlinks found