{"items":[{"type":"group","fsPath":"api-reference/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/api-reference","routeSlug":"/api-reference","items":[{"type":"link","fsPath":"api-reference/index.md","metadata":{"type":"markdown"},"link":"/api-reference#getting-started","routeSlug":"/api-reference","label":"Getting Started"},{"type":"link","fsPath":"api-reference/index.md","metadata":{"type":"markdown"},"link":"/api-reference#authentication","routeSlug":"/api-reference","label":"Authentication"},{"type":"link","fsPath":"api-reference/index.md","metadata":{"type":"markdown"},"link":"/api-reference#pagination","routeSlug":"/api-reference","label":"Pagination"},{"type":"link","fsPath":"api-reference/index.md","metadata":{"type":"markdown"},"link":"/api-reference#rate-limits","routeSlug":"/api-reference","label":"Rate Limits"}]},{"type":"group","fsPath":"merchant-api/@v5/openapi.yaml","link":"/merchant-api/openapi","routeSlug":"/merchant-api/openapi","label":"Merchant API","items":[{"type":"group","label":"Introduction","link":"/merchant-api/openapi/introduction","routeSlug":"/merchant-api/openapi/introduction","items":[],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Access Keys","link":"/merchant-api/openapi/access-keys","routeSlug":"/merchant-api/openapi/access-keys","items":[{"label":"Mint an access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/access-keys/issueaccesskeytoken","routeSlug":"/merchant-api/openapi/access-keys/issueaccesskeytoken","metadata":{"seo":{"title":"Mint an access token","description":"Exchange an OAuth access key for a bearer token by providing its client_id and client_secret in the request body."}},"httpPath":"/access-keys/token","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Webhooks","link":"/merchant-api/openapi/webhooks","routeSlug":"/merchant-api/openapi/webhooks","items":[{"type":"link","label":"Webhook Event Structure","link":"/merchant-api/openapi/webhooks/webhook-event-structure","routeSlug":"/merchant-api/openapi/webhooks/webhook-event-structure","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Supported Event Types","link":"/merchant-api/openapi/webhooks/supported-event-types","routeSlug":"/merchant-api/openapi/webhooks/supported-event-types","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Invoice Events","link":"/merchant-api/openapi/webhooks/invoice-events","routeSlug":"/merchant-api/openapi/webhooks/invoice-events","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Customer Events","link":"/merchant-api/openapi/webhooks/customer-events","routeSlug":"/merchant-api/openapi/webhooks/customer-events","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Order Events","link":"/merchant-api/openapi/webhooks/order-events","routeSlug":"/merchant-api/openapi/webhooks/order-events","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Payment Events","link":"/merchant-api/openapi/webhooks/payment-events","routeSlug":"/merchant-api/openapi/webhooks/payment-events","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Payout Events","link":"/merchant-api/openapi/webhooks/payout-events","routeSlug":"/merchant-api/openapi/webhooks/payout-events","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Verifying Webhook Signatures","link":"/merchant-api/openapi/webhooks/verifying-webhook-signatures","routeSlug":"/merchant-api/openapi/webhooks/verifying-webhook-signatures","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"JavaScript Example","link":"/merchant-api/openapi/webhooks/javascript-example","routeSlug":"/merchant-api/openapi/webhooks/javascript-example","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Retry Policy","link":"/merchant-api/openapi/webhooks/retry-policy","routeSlug":"/merchant-api/openapi/webhooks/retry-policy","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Best Practices","link":"/merchant-api/openapi/webhooks/best-practices","routeSlug":"/merchant-api/openapi/webhooks/best-practices","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"List webhook endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/webhooks/listwebhookendpoints","routeSlug":"/merchant-api/openapi/webhooks/listwebhookendpoints","metadata":{"seo":{"title":"List webhook endpoints","description":"Returns a list of all configured webhook endpoints for the merchant account."}},"httpPath":"/webhooks","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Create or update webhook endpoints","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/webhooks/upsertwebhookendpoints","routeSlug":"/merchant-api/openapi/webhooks/upsertwebhookendpoints","metadata":{"seo":{"title":"Create or update webhook endpoints","description":"Create a new webhook endpoint or update an existing one. If an endpoint with the same URL already exists, it will be updated with the new event subscriptions."}},"httpPath":"/webhooks","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Delete webhook endpoints","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/webhooks/deletewebhookendpoints","routeSlug":"/merchant-api/openapi/webhooks/deletewebhookendpoints","metadata":{"seo":{"title":"Delete webhook endpoints","description":"Delete a webhook endpoint and all its event subscriptions."}},"httpPath":"/webhooks","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Invoices","link":"/merchant-api/openapi/invoices","routeSlug":"/merchant-api/openapi/invoices","items":[{"label":"List all invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/invoices/listinvoices","routeSlug":"/merchant-api/openapi/invoices/listinvoices","metadata":{"seo":{"title":"List all invoices","description":"Return a list of invoices."}},"httpPath":"/invoices","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Create an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/invoices/createinvoice","routeSlug":"/merchant-api/openapi/invoices/createinvoice","metadata":{"seo":{"title":"Create an invoice","description":"Create a new advanced or non-advanced invoice with the desired terms."}},"httpPath":"/invoices","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Fetch an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/invoices/fetchinvoice","routeSlug":"/merchant-api/openapi/invoices/fetchinvoice","metadata":{"seo":{"title":"Fetch an invoice","description":"Retrieve an existing invoice by its ID."}},"httpPath":"/invoices/{invoice_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Update an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/invoices/updateinvoice","routeSlug":"/merchant-api/openapi/invoices/updateinvoice","metadata":{"seo":{"title":"Update an invoice","description":"Update an invoice."}},"httpPath":"/invoices/{invoice_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Delete an invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/invoices/deleteinvoice","routeSlug":"/merchant-api/openapi/invoices/deleteinvoice","metadata":{"seo":{"title":"Delete an invoice","description":"Delete an invoice."}},"httpPath":"/invoices/{invoice_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Send an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/invoices/sendinvoice","routeSlug":"/merchant-api/openapi/invoices/sendinvoice","metadata":{"seo":{"title":"Send an invoice","description":"Send an invoice to the customer."}},"httpPath":"/invoices/{invoice_id}/send","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Void an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/invoices/voidinvoice","routeSlug":"/merchant-api/openapi/invoices/voidinvoice","metadata":{"seo":{"title":"Void an invoice","description":"Void an invoice."}},"httpPath":"/invoices/{invoice_id}/void","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Cancel an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/invoices/cancelinvoice","routeSlug":"/merchant-api/openapi/invoices/cancelinvoice","metadata":{"seo":{"title":"Cancel an invoice","description":"Cancel an invoice."}},"httpPath":"/invoices/{invoice_id}/cancel","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Customers","link":"/merchant-api/openapi/customers","routeSlug":"/merchant-api/openapi/customers","items":[{"label":"List all customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/customers/listcustomers","routeSlug":"/merchant-api/openapi/customers/listcustomers","metadata":{"seo":{"title":"List all customers","description":"Return a list of customers."}},"httpPath":"/customers","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Create a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/customers/createcustomer","routeSlug":"/merchant-api/openapi/customers/createcustomer","metadata":{"seo":{"title":"Create a customer","description":"Create a customer."}},"httpPath":"/customers","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Fetch a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/customers/fetchcustomer","routeSlug":"/merchant-api/openapi/customers/fetchcustomer","metadata":{"seo":{"title":"Fetch a customer","description":"Retrieve an existing customer by its ID."}},"httpPath":"/customers/{customer_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Update a customer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/customers/updatecustomer","routeSlug":"/merchant-api/openapi/customers/updatecustomer","metadata":{"seo":{"title":"Update a customer","description":"Update a customer."}},"httpPath":"/customers/{customer_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Request a credit check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/customers/requestcustomercreditcheck","routeSlug":"/merchant-api/openapi/customers/requestcustomercreditcheck","metadata":{"seo":{"title":"Request a credit check","description":"You may request a credit check on a customer who hasn't previously been credit checked.This endpoint returns no content. You'll be able to see the date you requested the credit check(credit_check_requested_at) and credit_status updated to pending or, in the case of an instant decision,approved or declined by fetching the Customer entity."}},"httpPath":"/customers/{customer_id}/credit-check","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Enroll a customer","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/customers/enroll-a-customer","routeSlug":"/merchant-api/openapi/customers/enroll-a-customer","metadata":{"seo":{"title":"Enroll a customer","description":"<div style=\"border-sizing: border-box; padding: 10px; background-color: rgba(212, 31, 28, 0.07); color: rgb(212, 31, 28);\">As of <strong>July 2023</strong>, this route has been replaced with a stub response and will soon be deprecated.The <strong>confirm_enrollment</strong> status no longer exists and, once approved by Resolve, customers will either be <strong>enrolled</strong>(if they applied through an application) or <strong>pending_enrollment</strong> (if credit checked).</div>"}},"httpPath":"/customers/{customer_id}/enroll","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Charges","link":"/merchant-api/openapi/charges","routeSlug":"/merchant-api/openapi/charges","items":[{"label":"List charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/charges/listcharges","routeSlug":"/merchant-api/openapi/charges/listcharges","metadata":{"seo":{"title":"List charges","description":"Return a paginated list of charges."}},"httpPath":"/charges","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Fetch a charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/charges/fetchcharge","routeSlug":"/merchant-api/openapi/charges/fetchcharge","metadata":{"seo":{"title":"Fetch a charge","description":"Retrieve an existing charge by its ID."}},"httpPath":"/charges/{charge_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Update a charge","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/charges/updatecharge","routeSlug":"/merchant-api/openapi/charges/updatecharge","metadata":{"seo":{"title":"Update a charge","description":"Update a charge."}},"httpPath":"/charges/{charge_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Capture a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/charges/capturecharge","routeSlug":"/merchant-api/openapi/charges/capturecharge","metadata":{"seo":{"title":"Capture a charge","description":"Capture an authorized charge."}},"httpPath":"/charges/{charge_id}/capture","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Cancel a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/charges/cancelcharge","routeSlug":"/merchant-api/openapi/charges/cancelcharge","metadata":{"seo":{"title":"Cancel a charge","description":"Cancel an existing charge."}},"httpPath":"/charges/{charge_id}/cancel","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Orders","link":"/merchant-api/openapi/orders","routeSlug":"/merchant-api/openapi/orders","items":[{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/orders/listorders","routeSlug":"/merchant-api/openapi/orders/listorders","metadata":{"seo":{"title":"List orders","description":"Return a paginated list of orders."}},"httpPath":"/orders","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/orders/createorder","routeSlug":"/merchant-api/openapi/orders/createorder","metadata":{"seo":{"title":"Create an order","description":"Authorize a new order for a customer."}},"httpPath":"/orders","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Fetch an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/orders/fetchorder","routeSlug":"/merchant-api/openapi/orders/fetchorder","metadata":{"seo":{"title":"Fetch an order","description":"Retrieve an existing order by its ID."}},"httpPath":"/orders/{order_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Update an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/orders/updateorder","routeSlug":"/merchant-api/openapi/orders/updateorder","metadata":{"seo":{"title":"Update an order","description":"Update an authorized order's amount, order number, PO number, line items, or metadata. At least one field must be provided."}},"httpPath":"/orders/{order_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Capture an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/orders/captureorder","routeSlug":"/merchant-api/openapi/orders/captureorder","metadata":{"seo":{"title":"Capture an order","description":"Capture an authorized order. An order can be captured multiple times up to the full authorized amount."}},"httpPath":"/orders/{order_id}/capture","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Cancel an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/orders/cancelorder","routeSlug":"/merchant-api/openapi/orders/cancelorder","metadata":{"seo":{"title":"Cancel an order","description":"Cancel an authorized order, releasing any remaining authorized amount. If the order has been partially captured, only the uncaptured portion of the authorization is canceled — previously captured amounts are not affected."}},"httpPath":"/orders/{order_id}/cancel","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Payouts","link":"/merchant-api/openapi/payouts","routeSlug":"/merchant-api/openapi/payouts","items":[{"label":"List Payouts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/payouts/listpayouts","routeSlug":"/merchant-api/openapi/payouts/listpayouts","metadata":{"seo":{"title":"List Payouts","description":"List Payouts"}},"httpPath":"/payouts","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Get a Payout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/payouts/getpayout","routeSlug":"/merchant-api/openapi/payouts/getpayout","metadata":{"seo":{"title":"Get a Payout","description":"Get a Payout"}},"httpPath":"/payouts/{payout_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Payout Transactions","link":"/merchant-api/openapi/payout-transactions","routeSlug":"/merchant-api/openapi/payout-transactions","items":[{"label":"List Payout Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/payout-transactions/listpayouttransactions","routeSlug":"/merchant-api/openapi/payout-transactions/listpayouttransactions","metadata":{"seo":{"title":"List Payout Transactions","description":"List Payout Transactions"}},"httpPath":"/payout-transactions","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Get a Payout Transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/payout-transactions/getpayouttransaction","routeSlug":"/merchant-api/openapi/payout-transactions/getpayouttransaction","metadata":{"seo":{"title":"Get a Payout Transaction","description":"Get a Payout Transaction"}},"httpPath":"/payout_transactions/{payout_transaction_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Payments","link":"/merchant-api/openapi/payments","routeSlug":"/merchant-api/openapi/payments","items":[{"label":"List payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/payments/listpayments","routeSlug":"/merchant-api/openapi/payments/listpayments","metadata":{"seo":{"title":"List payments","description":"Return a list of payments."}},"httpPath":"/payments","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Fetch a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/payments/fetchpayment","routeSlug":"/merchant-api/openapi/payments/fetchpayment","metadata":{"seo":{"title":"Fetch a payment","description":"Retrieve an existing payment by its ID."}},"httpPath":"/payments/{payment_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Credit Notes","link":"/merchant-api/openapi/credit-notes","routeSlug":"/merchant-api/openapi/credit-notes","items":[{"label":"List credit notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/credit-notes/listcreditnotes","routeSlug":"/merchant-api/openapi/credit-notes/listcreditnotes","metadata":{"seo":{"title":"List credit notes","description":"Return a list of credit notes."}},"httpPath":"/credit-notes","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Create a credit note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/credit-notes/createcreditnote","routeSlug":"/merchant-api/openapi/credit-notes/createcreditnote","metadata":{"seo":{"title":"Create a credit note","description":"Create a new credit note."}},"httpPath":"/credit-notes","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Request to void a credit note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/credit-notes/voidcreditnote","routeSlug":"/merchant-api/openapi/credit-notes/voidcreditnote","metadata":{"seo":{"title":"Request to void a credit note","description":"Request to void an existing credit note."}},"httpPath":"/credit-notes/{credit_note_id}/void","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Fetch a credit note","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/credit-notes/fetchcreditnote","routeSlug":"/merchant-api/openapi/credit-notes/fetchcreditnote","metadata":{"seo":{"title":"Fetch a credit note","description":"Retrieve an existing credit note by its ID."}},"httpPath":"/credit-notes/{credit_note_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","label":"Shipments","link":"/merchant-api/openapi/shipments","routeSlug":"/merchant-api/openapi/shipments","items":[{"type":"link","label":"Supported Couriers","link":"/merchant-api/openapi/shipments/supported-couriers","routeSlug":"/merchant-api/openapi/shipments/supported-couriers","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Major Carriers","link":"/merchant-api/openapi/shipments/major-carriers","routeSlug":"/merchant-api/openapi/shipments/major-carriers","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"link","label":"Complete List of Supported Couriers","link":"/merchant-api/openapi/shipments/complete-list-of-supported-couriers","routeSlug":"/merchant-api/openapi/shipments/complete-list-of-supported-couriers","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"List Shipments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/shipments/listshipments","routeSlug":"/merchant-api/openapi/shipments/listshipments","metadata":{"seo":{"title":"List Shipments","description":"List Shipments"}},"httpPath":"/shipments","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Create a Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/shipments/createshipment","routeSlug":"/merchant-api/openapi/shipments/createshipment","metadata":{"seo":{"title":"Create a Shipment","description":"Create a Shipment"}},"httpPath":"/shipments","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Get a Shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/shipments/getshipment","routeSlug":"/merchant-api/openapi/shipments/getshipment","metadata":{"seo":{"title":"Get a Shipment","description":"Get a Shipment"}},"httpPath":"/shipments/{shipment_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Update a Shipment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/shipments/updateshipment","routeSlug":"/merchant-api/openapi/shipments/updateshipment","metadata":{"seo":{"title":"Update a Shipment","description":"Update a Shipment"}},"httpPath":"/shipments/{shipment_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Delete a Shipment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/shipments/deleteshipment","routeSlug":"/merchant-api/openapi/shipments/deleteshipment","metadata":{"seo":{"title":"Delete a Shipment","description":"Delete a Shipment"}},"httpPath":"/shipments/{shipment_id}","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"label":"Sync Shipment Tracking","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/merchant-api/openapi/shipments/syncshipmenttracking","routeSlug":"/merchant-api/openapi/shipments/syncshipmenttracking","metadata":{"seo":{"title":"Sync Shipment Tracking","description":"Synchronizes shipment tracking information by fetching real-time data from the courier using the existing tracking number. This endpoint retrieves the latest tracking updates directly from the shipping provider and performs instant verification of the shipment status, ensuring that the shipment data is current and accurate."}},"httpPath":"/shipments/{shipment_id}/sync","version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"}],"metadata":{"type":"openapi","title":"Resolve API Reference","version":"V5","description":"API Support: [accounts@resolvepay.com](mailto:accounts@resolvepay.com?subject=API)\n\nLegacy (v2) API documentation: [https://app.resolvepay.com/docs/api/v2](https://app.resolvepay.com/docs/api/v2)\n"},"version":"v5","isDefault":true,"versionFolderId":"dae0c0d1"},{"type":"group","fsPath":"partners-api/openapi.yaml","link":"/partners-api/openapi","routeSlug":"/partners-api/openapi","label":"Partners API","items":[{"type":"group","label":"Active Maintenance","link":"/partners-api/openapi/active-maintenance","routeSlug":"/partners-api/openapi/active-maintenance","items":[]},{"type":"group","label":"Introduction","link":"/partners-api/openapi/introduction","routeSlug":"/partners-api/openapi/introduction","items":[]},{"type":"group","label":"Access Keys","link":"/partners-api/openapi/access-keys","routeSlug":"/partners-api/openapi/access-keys","items":[{"label":"Mint an access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/access-keys/issueaccesskeytoken","routeSlug":"/partners-api/openapi/access-keys/issueaccesskeytoken","metadata":{"seo":{"title":"Mint an access token","description":"Exchange an OAuth access key for a bearer token by providing its client_id and client_secret in the request body."}},"httpPath":"/access-keys/token"}]},{"type":"group","label":"Webhooks","link":"/partners-api/openapi/webhooks","routeSlug":"/partners-api/openapi/webhooks","items":[{"type":"link","label":"Webhook Event Structure","link":"/partners-api/openapi/webhooks/webhook-event-structure","routeSlug":"/partners-api/openapi/webhooks/webhook-event-structure"},{"type":"link","label":"Supported Event Types","link":"/partners-api/openapi/webhooks/supported-event-types","routeSlug":"/partners-api/openapi/webhooks/supported-event-types"},{"type":"link","label":"Invoice Events","link":"/partners-api/openapi/webhooks/invoice-events","routeSlug":"/partners-api/openapi/webhooks/invoice-events"},{"type":"link","label":"Customer Events","link":"/partners-api/openapi/webhooks/customer-events","routeSlug":"/partners-api/openapi/webhooks/customer-events"},{"type":"link","label":"Payout Events","link":"/partners-api/openapi/webhooks/payout-events","routeSlug":"/partners-api/openapi/webhooks/payout-events"},{"type":"link","label":"Merchant Events","link":"/partners-api/openapi/webhooks/merchant-events","routeSlug":"/partners-api/openapi/webhooks/merchant-events"},{"type":"link","label":"Verifying Webhook Signatures","link":"/partners-api/openapi/webhooks/verifying-webhook-signatures","routeSlug":"/partners-api/openapi/webhooks/verifying-webhook-signatures"},{"type":"link","label":"JavaScript Example","link":"/partners-api/openapi/webhooks/javascript-example","routeSlug":"/partners-api/openapi/webhooks/javascript-example"},{"type":"link","label":"Retry Policy","link":"/partners-api/openapi/webhooks/retry-policy","routeSlug":"/partners-api/openapi/webhooks/retry-policy"},{"type":"link","label":"Best Practices","link":"/partners-api/openapi/webhooks/best-practices","routeSlug":"/partners-api/openapi/webhooks/best-practices"},{"label":"List webhook endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/webhooks/listwebhookendpoints","routeSlug":"/partners-api/openapi/webhooks/listwebhookendpoints","metadata":{"seo":{"title":"List webhook endpoints","description":"Returns a list of all configured webhook endpoints for your account."}},"httpPath":"/webhooks"},{"label":"Create or update webhook endpoints","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/webhooks/upsertwebhookendpoints","routeSlug":"/partners-api/openapi/webhooks/upsertwebhookendpoints","metadata":{"seo":{"title":"Create or update webhook endpoints","description":"Create a new webhook endpoint or update an existing one. If an endpoint with the same URL already exists, it will be updated with the new event subscriptions."}},"httpPath":"/webhooks"},{"label":"Delete webhook endpoints","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/webhooks/deletewebhookendpoints","routeSlug":"/partners-api/openapi/webhooks/deletewebhookendpoints","metadata":{"seo":{"title":"Delete webhook endpoints","description":"Delete a webhook endpoint and all its event subscriptions."}},"httpPath":"/webhooks"}]},{"type":"group","label":"Invoices","link":"/partners-api/openapi/invoices","routeSlug":"/partners-api/openapi/invoices","items":[{"label":"List all invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/invoices/listinvoices","routeSlug":"/partners-api/openapi/invoices/listinvoices","metadata":{"seo":{"title":"List all invoices","description":"Return a list of invoices across your sub-merchants."}},"httpPath":"/invoices"},{"label":"Create an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/invoices/createinvoice","routeSlug":"/partners-api/openapi/invoices/createinvoice","metadata":{"seo":{"title":"Create an invoice","description":"Create a new advanced or non-advanced invoice for a sub-merchant with the desired terms. The merchant_id field is required and must reference a valid sub-merchant under your partner account."}},"httpPath":"/invoices"},{"label":"Fetch an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/invoices/fetchinvoice","routeSlug":"/partners-api/openapi/invoices/fetchinvoice","metadata":{"seo":{"title":"Fetch an invoice","description":"Retrieve an existing invoice by its ID."}},"httpPath":"/invoices/{invoice_id}"},{"label":"Update an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/invoices/updateinvoice","routeSlug":"/partners-api/openapi/invoices/updateinvoice","metadata":{"seo":{"title":"Update an invoice","description":"Update an invoice."}},"httpPath":"/invoices/{invoice_id}"},{"label":"Delete an invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/invoices/deleteinvoice","routeSlug":"/partners-api/openapi/invoices/deleteinvoice","metadata":{"seo":{"title":"Delete an invoice","description":"Delete an invoice."}},"httpPath":"/invoices/{invoice_id}"},{"label":"Send an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/invoices/sendinvoice","routeSlug":"/partners-api/openapi/invoices/sendinvoice","metadata":{"seo":{"title":"Send an invoice","description":"Send an invoice to the customer."}},"httpPath":"/invoices/{invoice_id}/send"},{"label":"Void an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/invoices/voidinvoice","routeSlug":"/partners-api/openapi/invoices/voidinvoice","metadata":{"seo":{"title":"Void an invoice","description":"Void an invoice."}},"httpPath":"/invoices/{invoice_id}/void"},{"label":"Cancel an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/invoices/cancelinvoice","routeSlug":"/partners-api/openapi/invoices/cancelinvoice","metadata":{"seo":{"title":"Cancel an invoice","description":"Cancel an invoice."}},"httpPath":"/invoices/{invoice_id}/cancel"}]},{"type":"group","label":"Customers","link":"/partners-api/openapi/customers","routeSlug":"/partners-api/openapi/customers","items":[{"label":"List all customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/customers/listcustomers","routeSlug":"/partners-api/openapi/customers/listcustomers","metadata":{"seo":{"title":"List all customers","description":"Return a list of customers. For single-merchant partners, this returns customers belonging to your sub-merchants. For marketplace partners, this returns customers belonging to your marketplace."}},"httpPath":"/customers"},{"label":"Create a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/customers/createcustomer","routeSlug":"/partners-api/openapi/customers/createcustomer","metadata":{"seo":{"title":"Create a customer","description":"Create a customer"}},"httpPath":"/customers"},{"label":"Fetch a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/customers/fetchcustomer","routeSlug":"/partners-api/openapi/customers/fetchcustomer","metadata":{"seo":{"title":"Fetch a customer","description":"Retrieve an existing customer by its ID."}},"httpPath":"/customers/{customer_id}"},{"label":"Update a customer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/customers/updatecustomer","routeSlug":"/partners-api/openapi/customers/updatecustomer","metadata":{"seo":{"title":"Update a customer","description":"Update a customer"}},"httpPath":"/customers/{customer_id}"},{"label":"Request a credit check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/customers/requestcustomercreditcheck","routeSlug":"/partners-api/openapi/customers/requestcustomercreditcheck","metadata":{"seo":{"title":"Request a credit check","description":"You may request a credit check on a customer who hasn't previously been credit checked.This endpoint returns no content. You'll be able to see the date you requested the credit check(credit_check_requested_at) and credit_status updated to pending or, in the case of an instant decision,approved or declined by fetching the Customer entity."}},"httpPath":"/customers/{customer_id}/credit-check"}]},{"type":"group","label":"Payouts","link":"/partners-api/openapi/payouts","routeSlug":"/partners-api/openapi/payouts","items":[{"label":"List Payouts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/payouts/listpayouts","routeSlug":"/partners-api/openapi/payouts/listpayouts","metadata":{"seo":{"title":"List Payouts","description":"List Payouts"}},"httpPath":"/payouts"},{"label":"Get a Payout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/payouts/getpayout","routeSlug":"/partners-api/openapi/payouts/getpayout","metadata":{"seo":{"title":"Get a Payout","description":"Get a Payout"}},"httpPath":"/payouts/{payout_id}"}]},{"type":"group","label":"Payout Transactions","link":"/partners-api/openapi/payout-transactions","routeSlug":"/partners-api/openapi/payout-transactions","items":[{"label":"List Payout Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/payout-transactions/listpayouttransactions","routeSlug":"/partners-api/openapi/payout-transactions/listpayouttransactions","metadata":{"seo":{"title":"List Payout Transactions","description":"List Payout Transactions"}},"httpPath":"/payout-transactions"},{"label":"Get a Payout Transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/payout-transactions/getpayouttransaction","routeSlug":"/partners-api/openapi/payout-transactions/getpayouttransaction","metadata":{"seo":{"title":"Get a Payout Transaction","description":"Get a Payout Transaction"}},"httpPath":"/payout_transactions/{payout_transaction_id}"}]},{"type":"group","label":"Payments","link":"/partners-api/openapi/payments","routeSlug":"/partners-api/openapi/payments","items":[{"label":"List payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/payments/listpayments","routeSlug":"/partners-api/openapi/payments/listpayments","metadata":{"seo":{"title":"List payments","description":"Return a list of payments across your sub-merchants."}},"httpPath":"/payments"},{"label":"Create a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/payments/createpayment","routeSlug":"/partners-api/openapi/payments/createpayment","metadata":{"seo":{"title":"Create a payment","description":"Create a forwarded payment for an invoice belonging to one of your sub-merchants."}},"httpPath":"/payments"},{"label":"Fetch a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/payments/fetchpayment","routeSlug":"/partners-api/openapi/payments/fetchpayment","metadata":{"seo":{"title":"Fetch a payment","description":"Retrieve an existing payment by its ID."}},"httpPath":"/payments/{payment_id}"}]},{"type":"group","label":"Credit Notes","link":"/partners-api/openapi/credit-notes","routeSlug":"/partners-api/openapi/credit-notes","items":[{"label":"List credit notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/credit-notes/listcreditnotes","routeSlug":"/partners-api/openapi/credit-notes/listcreditnotes","metadata":{"seo":{"title":"List credit notes","description":"Return a list of credit notes."}},"httpPath":"/credit-notes"},{"label":"Create a credit note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/credit-notes/createcreditnote","routeSlug":"/partners-api/openapi/credit-notes/createcreditnote","metadata":{"seo":{"title":"Create a credit note","description":"Create a new credit note."}},"httpPath":"/credit-notes"},{"label":"Request to void a credit note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/credit-notes/voidcreditnote","routeSlug":"/partners-api/openapi/credit-notes/voidcreditnote","metadata":{"seo":{"title":"Request to void a credit note","description":"Request to void an existing credit note."}},"httpPath":"/credit-notes/{credit_note_id}/void"},{"label":"Fetch a credit note","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/credit-notes/fetchcreditnote","routeSlug":"/partners-api/openapi/credit-notes/fetchcreditnote","metadata":{"seo":{"title":"Fetch a credit note","description":"Retrieve an existing credit note by its ID."}},"httpPath":"/credit-notes/{credit_note_id}"}]},{"type":"group","label":"Merchants","link":"/partners-api/openapi/merchants","routeSlug":"/partners-api/openapi/merchants","items":[{"label":"List Merchants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/merchants/listmerchants","routeSlug":"/partners-api/openapi/merchants/listmerchants","metadata":{"seo":{"title":"List Merchants","description":"Returns sub-merchants under the authenticated partner account."}},"httpPath":"/merchants"},{"label":"Create Merchant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/merchants/createmerchant","routeSlug":"/partners-api/openapi/merchants/createmerchant","metadata":{"seo":{"title":"Create Merchant","description":"Creates a sub-merchant under the authenticated partner and starts underwriting lifecycle tracking."}},"httpPath":"/merchants"},{"label":"Get Merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/merchants/getmerchant","routeSlug":"/partners-api/openapi/merchants/getmerchant","metadata":{"seo":{"title":"Get Merchant","description":"Retrieves a single sub-merchant belonging to the authenticated partner."}},"httpPath":"/merchants/{merchant_id}"},{"label":"Update Merchant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/merchants/updatemerchant","routeSlug":"/partners-api/openapi/merchants/updatemerchant","metadata":{"seo":{"title":"Update Merchant","description":"Updates a sub-merchant belonging to the authenticated partner."}},"httpPath":"/merchants/{merchant_id}"},{"label":"List Merchant Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/merchants/listmerchantdocuments","routeSlug":"/partners-api/openapi/merchants/listmerchantdocuments","metadata":{"seo":{"title":"List Merchant Documents","description":"Returns document presence and validation lifecycle status for a specific sub-merchant."}},"httpPath":"/merchants/{merchant_id}/documents"},{"label":"Create a Merchant Document Upload Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/merchants/createmerchantdocumentuploadrequest","routeSlug":"/partners-api/openapi/merchants/createmerchantdocumentuploadrequest","metadata":{"seo":{"title":"Create a Merchant Document Upload Request","description":"Creates a new merchant document record for a sub-merchant and initializes document transfer to the Resolve document validation service."}},"httpPath":"/merchants/{merchant_id}/documents"}]},{"type":"group","label":"Shipments","link":"/partners-api/openapi/shipments","routeSlug":"/partners-api/openapi/shipments","items":[{"type":"link","label":"Supported Couriers","link":"/partners-api/openapi/shipments/supported-couriers","routeSlug":"/partners-api/openapi/shipments/supported-couriers"},{"type":"link","label":"Major Carriers","link":"/partners-api/openapi/shipments/major-carriers","routeSlug":"/partners-api/openapi/shipments/major-carriers"},{"type":"link","label":"Complete List of Supported Couriers","link":"/partners-api/openapi/shipments/complete-list-of-supported-couriers","routeSlug":"/partners-api/openapi/shipments/complete-list-of-supported-couriers"},{"label":"List Shipments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/shipments/listshipments","routeSlug":"/partners-api/openapi/shipments/listshipments","metadata":{"seo":{"title":"List Shipments","description":"Return a list of shipments across your sub-merchants."}},"httpPath":"/shipments"},{"label":"Create a Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/shipments/createshipment","routeSlug":"/partners-api/openapi/shipments/createshipment","metadata":{"seo":{"title":"Create a Shipment","description":"Create a shipment for an invoice belonging to one of your sub-merchants."}},"httpPath":"/shipments"},{"label":"Get a Shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/shipments/getshipment","routeSlug":"/partners-api/openapi/shipments/getshipment","metadata":{"seo":{"title":"Get a Shipment","description":"Retrieve an existing shipment by its ID."}},"httpPath":"/shipments/{shipment_id}"},{"label":"Update a Shipment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/shipments/updateshipment","routeSlug":"/partners-api/openapi/shipments/updateshipment","metadata":{"seo":{"title":"Update a Shipment","description":"Update an existing shipment belonging to one of your sub-merchants."}},"httpPath":"/shipments/{shipment_id}"},{"label":"Delete a Shipment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/shipments/deleteshipment","routeSlug":"/partners-api/openapi/shipments/deleteshipment","metadata":{"seo":{"title":"Delete a Shipment","description":"Delete a shipment belonging to one of your sub-merchants."}},"httpPath":"/shipments/{shipment_id}"},{"label":"Sync Shipment Tracking","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partners-api/openapi/shipments/syncshipmenttracking","routeSlug":"/partners-api/openapi/shipments/syncshipmenttracking","metadata":{"seo":{"title":"Sync Shipment Tracking","description":"Synchronizes shipment tracking information by fetching real-time data from the courier using the existing tracking number. This endpoint retrieves the latest tracking updates directly from the shipping provider and performs instant verification of the shipment status, ensuring that the shipment data is current and accurate."}},"httpPath":"/shipments/{shipment_id}/sync"}]}],"metadata":{"type":"openapi","title":"Resolve Partners API Reference","version":"partners-v1","description":"API Support: [accounts@resolvepay.com](mailto:accounts@resolvepay.com?subject=API)\n"}}]}