{"items":[{"type":"link","label":"Easypay Payments API","link":"/pt/openapi","routeSlug":"/pt/openapi"},{"type":"group","label":"Single Payment","link":"/pt/openapi/single-payment","routeSlug":"/pt/openapi/single-payment","items":[{"label":"Lists single payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/single-payment/single-get","routeSlug":"/pt/openapi/single-payment/single-get","metadata":{"seo":{"title":"Lists single payments","description":"Full report with all the single payments from your Account"}},"httpPath":"/single"},{"label":"Create single payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/single-payment/single-post","routeSlug":"/pt/openapi/single-payment/single-post","metadata":{"seo":{"title":"Create single payment","description":"Creates a Single Payment"}},"httpPath":"/single"},{"label":"Shows single payment details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/single-payment/single-id-get","routeSlug":"/pt/openapi/single-payment/single-id-get","metadata":{"seo":{"title":"Shows single payment details","description":"Retrieve a single payment details"}},"httpPath":"/single/{id}"},{"label":"Deletes single payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/single-payment/single-delete","routeSlug":"/pt/openapi/single-payment/single-delete","metadata":{"seo":{"title":"Deletes single payment","description":"This endpoint allows for the deletion of a single payment identified by its unique ID. The DELETE operation performs the following actions based on the payment method:"}},"httpPath":"/single/{id}"},{"label":"Update a single Payment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/single-payment/single-update","routeSlug":"/pt/openapi/single-payment/single-update","metadata":{"seo":{"title":"Update a single Payment","description":"Apply partial modifications to a single payment resource."}},"httpPath":"/single/{id}"}]},{"type":"group","label":"Frequent Payment","link":"/pt/openapi/frequent-payment","routeSlug":"/pt/openapi/frequent-payment","items":[{"label":"Lists frequent payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/frequent-get","routeSlug":"/pt/openapi/frequent-payment/frequent-get","metadata":{"seo":{"title":"Lists frequent payments","description":"Full report with all the frequent payments from your Account Id"}},"httpPath":"/frequent"},{"label":"Create frequent payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/post_frequent","routeSlug":"/pt/openapi/frequent-payment/post_frequent","metadata":{"seo":{"title":"Create frequent payment","description":"Frequent payments are repeatable transactions of varying sums without the client having to enter their payment details again."}},"httpPath":"/frequent"},{"label":"Shows frequent payment details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/frequent-id-get","routeSlug":"/pt/openapi/frequent-payment/frequent-id-get","metadata":{"seo":{"title":"Shows frequent payment details","description":"Retrieve a Frequent Payment details"}},"httpPath":"/frequent/{id}"},{"label":"Deletes frequent payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/delete_frequent_id","routeSlug":"/pt/openapi/frequent-payment/delete_frequent_id","metadata":{"seo":{"title":"Deletes frequent payment","description":"3 times a day (10am, 3pm and 10pm) our system will attempt to close your deleted MB payments.<br>All CC and MBW authorisations will be deleted, releasing the funds.<br>All MBW operations waiting for user interaction will be cancelled.<br>Before 6pm all Sepa Direct Debits waiting for file processing will be cancelled."}},"httpPath":"/frequent/{id}"},{"label":"Updates frequent payment details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/patch_frequent_id","routeSlug":"/pt/openapi/frequent-payment/patch_frequent_id","metadata":{"seo":{"title":"Updates frequent payment details","description":"Required scope: <code style=\"background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em\">frequent:update</code>"}},"httpPath":"/frequent/{id}"},{"label":"Request Authorisation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/frequent-authorisation","routeSlug":"/pt/openapi/frequent-payment/frequent-authorisation","metadata":{"seo":{"title":"Request Authorisation","description":"Create a new authorisation on a given Frequent Payment"}},"httpPath":"/frequent/authorisation/{id}"}]},{"type":"group","label":"Subscription Payment","link":"/pt/openapi/subscription-payment","routeSlug":"/pt/openapi/subscription-payment","items":[{"label":"List subscription payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/get_subscription","routeSlug":"/pt/openapi/subscription-payment/get_subscription","metadata":{"seo":{"title":"List subscription payments","description":"Full report with all the subscriptions payments from your Account Id"}},"httpPath":"/subscription"},{"label":"Create subscription payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/post_subscription","routeSlug":"/pt/openapi/subscription-payment/post_subscription","metadata":{"seo":{"title":"Create subscription payment","description":"Creates a Subscription."}},"httpPath":"/subscription"},{"label":"Shows subscription payment details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/get_subscription_id","routeSlug":"/pt/openapi/subscription-payment/get_subscription_id","metadata":{"seo":{"title":"Shows subscription payment details","description":"Retrieves the subscription payment details"}},"httpPath":"/subscription/{id}"},{"label":"Deletes subscription payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/delete_subscription_id","routeSlug":"/pt/openapi/subscription-payment/delete_subscription_id","metadata":{"seo":{"title":"Deletes subscription payment","description":"Deletes the subscription"}},"httpPath":"/subscription/{id}"},{"label":"Updates subscription payment details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/patch_subscription_id","routeSlug":"/pt/openapi/subscription-payment/patch_subscription_id","metadata":{"seo":{"title":"Updates subscription payment details","description":"Updates the subscription payment details"}},"httpPath":"/subscription/{id}"},{"label":"List cycles on a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/get_subscription_id_cycles","routeSlug":"/pt/openapi/subscription-payment/get_subscription_id_cycles","metadata":{"seo":{"title":"List cycles on a subscription","description":"Returns the cycles attached to a subscription, ordered from newest to oldest. Use status[] to narrow the result set — values are case-insensitive. Pagination is cursor-based: pass the previous response's metadata.next_cursor back as cursor. An empty next_cursor means there are no further pages."}},"httpPath":"/subscription/{id}/cycle"},{"label":"Create a one-off cycle on a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/post_subscription_id_cycles","routeSlug":"/pt/openapi/subscription-payment/post_subscription_id_cycles","metadata":{"seo":{"title":"Create a one-off cycle on a subscription","description":"Triggers an extra capture against an active subscription's saved payment method — useful for billing ad-hoc items like setup fees, add-ons, or upgrades without touching the recurring schedule. The regular cycles keep running unchanged."}},"httpPath":"/subscription/{id}/cycle"},{"label":"Retrieve a cycle on a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/get_subscription_id_cycle_id","routeSlug":"/pt/openapi/subscription-payment/get_subscription_id_cycle_id","metadata":{"seo":{"title":"Retrieve a cycle on a subscription","description":"Returns a single cycle that belongs to the given subscription. A cycle that doesn't exist — or that belongs to a different account — returns 404 Not Found."}},"httpPath":"/subscription/{id}/cycle/{cycle_id}"},{"label":"Update a cycle on a subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/patch_subscription_id_cycle_id","routeSlug":"/pt/openapi/subscription-payment/patch_subscription_id_cycle_id","metadata":{"seo":{"title":"Update a cycle on a subscription","description":"Overrides the charge amount for a single cycle without touching the subscription's recurring schedule or default value. Only RENEWABLE cycles in PENDING status can be patched — anything else (one-off charges, already-processed cycles, deleted cycles) returns 409 Conflict."}},"httpPath":"/subscription/{id}/cycle/{cycle_id}"}]},{"type":"group","label":"Captures","link":"/pt/openapi/captures","routeSlug":"/pt/openapi/captures","items":[{"label":"List captures","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/captures/paths/~1capture/get","routeSlug":"/pt/openapi/captures/paths/~1capture/get","metadata":{"seo":{"title":"List captures","description":"Required scope: <code style=\"background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em\">capture:read</code>"}},"httpPath":"/capture"},{"label":"Captures a Single Auth, Frequent and Frequent Auth","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/captures/paths/~1capture~1{id}/post","routeSlug":"/pt/openapi/captures/paths/~1capture~1{id}/post","metadata":{"seo":{"title":"Captures a Single Auth, Frequent and Frequent Auth","description":"Required scope: <code style=\"background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em\">capture:create</code>"}},"httpPath":"/capture/{id}"},{"label":"Shows capture details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/captures/paths/~1capture~1{id}/get","routeSlug":"/pt/openapi/captures/paths/~1capture~1{id}/get","metadata":{"seo":{"title":"Shows capture details","description":"Required scope: <code style=\"background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em\">capture:read</code>"}},"httpPath":"/capture/{id}"},{"label":"Cancels a capture","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/captures/capture-delete","routeSlug":"/pt/openapi/captures/capture-delete","metadata":{"seo":{"title":"Cancels a capture","description":"This endpoint is rolling out shortly. The shape below is stable, but calls against it will not succeed until the feature ships."}},"badges":[{"name":"Soon","color":"orange"}],"httpPath":"/capture/{id}"},{"label":"Updates the split of a capture","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/captures/patch_capture_capture_uuid_splits_capture_split_uuid","routeSlug":"/pt/openapi/captures/patch_capture_capture_uuid_splits_capture_split_uuid","metadata":{"seo":{"title":"Updates the split of a capture","description":"Required scope: <code style=\"background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em\">capture:update</code>"}},"httpPath":"/capture/{capture-uuid}/splits/{capture-split-uuid}"}]},{"type":"group","label":"Authorisations","link":"/pt/openapi/authorisations","routeSlug":"/pt/openapi/authorisations","items":[{"label":"Shows authorisation details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/authorisations/get_authorisation_id","routeSlug":"/pt/openapi/authorisations/get_authorisation_id","metadata":{"seo":{"title":"Shows authorisation details","description":"Retrieves the details of an authorisation"}},"httpPath":"/authorisation/{id}"}]},{"type":"group","label":"Voids","link":"/pt/openapi/voids","routeSlug":"/pt/openapi/voids","items":[{"label":"Get a void","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/voids/get_void_id","routeSlug":"/pt/openapi/voids/get_void_id","metadata":{"seo":{"title":"Get a void","description":"Returns the details and current status of a void, including the authorisation it cancelled. Use this to track a void's outcome after creation, since processing is asynchronous."}},"httpPath":"/void/{id}"},{"label":"Create a void","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/voids/post_void_id","routeSlug":"/pt/openapi/voids/post_void_id","metadata":{"seo":{"title":"Create a void","description":"Cancels a payment authorisation before it is captured, releasing the amount held on the card. Works for single and frequent authorisations."}},"httpPath":"/void/{id}"}]},{"type":"group","label":"Refunds","link":"/pt/openapi/refunds","routeSlug":"/pt/openapi/refunds","items":[{"label":"List Refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/refunds/list-refund","routeSlug":"/pt/openapi/refunds/list-refund","metadata":{"seo":{"title":"List Refunds","description":"Cursor based endpoint to retrieve all account refunds."}},"httpPath":"/refund"},{"label":"Refunds a Single Transaction or Frequent Transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/refunds/paths/~1refund~1{id}/post","routeSlug":"/pt/openapi/refunds/paths/~1refund~1{id}/post","metadata":{"seo":{"title":"Refunds a Single Transaction or Frequent Transaction","description":"Each method has a specific time window during which a refund can be issued. Once this period expires, refunds can no longer be processed via the API for that payment."}},"httpPath":"/refund/{id}"},{"label":"Shows refund details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/refunds/paths/~1refund~1{id}/get","routeSlug":"/pt/openapi/refunds/paths/~1refund~1{id}/get","metadata":{"seo":{"title":"Shows refund details","description":"Required scope: <code style=\"background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em\">refund:read</code>"}},"httpPath":"/refund/{id}"}]},{"type":"group","label":"Chargebacks","link":"/pt/openapi/chargebacks","routeSlug":"/pt/openapi/chargebacks","items":[{"label":"List chargebacks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/chargebacks/list-chargeback","routeSlug":"/pt/openapi/chargebacks/list-chargeback","metadata":{"seo":{"title":"List chargebacks","description":"This endpoint retrieves a list of chargebacks associated with your account. A Chargeback is a mandatory transaction reversal initiated by the consumer's card issuer or bank, usually due to a dispute over a transaction. When a chargeback occurs, the costumer effectively reverses the transaction, resulting in a debit of the disputed amount from the merchant's account. This endpoint allows you to view details of chargebacks, including the reason for the dispute, transaction amount, and status, providing insights into consumer disputes and their impact on your financials."}},"httpPath":"/chargeback"},{"label":"Shows chargeback details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/chargebacks/get-chargeback-details","routeSlug":"/pt/openapi/chargebacks/get-chargeback-details","metadata":{"seo":{"title":"Shows chargeback details","description":"This endpoint retrieves the details of a specific chargeback by its unique identifier. A Chargeback is a mandatory transaction reversal initiated by the consumer's card issuer or bank, usually due to a dispute over a transaction."}},"httpPath":"/chargeback/{id}"}]},{"type":"group","label":"Notifications / Webhooks","link":"/pt/openapi/notifications-webhooks","routeSlug":"/pt/openapi/notifications-webhooks","items":[{"label":"Generic Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/pt/openapi/notifications-webhooks/paths/yourgenericnotificationendpoint/post","routeSlug":"/pt/openapi/notifications-webhooks/paths/yourgenericnotificationendpoint/post","metadata":{"seo":{"title":"Generic Notification","description":"We will send you this json in our notifications"}},"httpPath":"yourGenericNotificationEndpoint"},{"label":"Authorisation Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/pt/openapi/notifications-webhooks/paths/yourauthorisationnotificationendpoint/post","routeSlug":"/pt/openapi/notifications-webhooks/paths/yourauthorisationnotificationendpoint/post","metadata":{"seo":{"title":"Authorisation Notification","description":"We will send you this json in our notification"}},"httpPath":"yourAuthorisationNotificationEndpoint"},{"label":"Transaction Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/pt/openapi/notifications-webhooks/paths/yournotificationendpoint/post","routeSlug":"/pt/openapi/notifications-webhooks/paths/yournotificationendpoint/post","metadata":{"seo":{"title":"Transaction Notification","description":"We will send you this json in our notification"}},"httpPath":"yourNotificationEndpoint"}]},{"type":"group","label":"Reports","link":"/pt/openapi/reports","routeSlug":"/pt/openapi/reports","items":[{"label":"Report Ledger","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/reports/get_report_ledger","routeSlug":"/pt/openapi/reports/get_report_ledger","metadata":{"seo":{"title":"Report Ledger","description":"The /reports/ledger endpoint provides access to detailed reports of ledger entries within the Easypay reconciliation system. This endpoint retrieves comprehensive financial data for each transaction recorded in the ledger, including captures, refunds, fees, and other financial operations, and it was designed to help users generate precise and relevant financial reports, aiding in effective account reconciliation and financial management."}},"httpPath":"/report/ledger"},{"label":"Report Transactions","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/reports/get_report_transactions","routeSlug":"/pt/openapi/reports/get_report_transactions","metadata":{"seo":{"title":"Report Transactions","description":"This endpoint is end of life and will be removed on 2026-07-31. Use /report/ledger instead."}},"badges":[{"name":"End of Life","color":"red"}],"httpPath":"/report/transactions"}]},{"type":"group","label":"Settlements","link":"/pt/openapi/settlements","routeSlug":"/pt/openapi/settlements","items":[{"label":"List settlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/settlements/get-settlement","routeSlug":"/pt/openapi/settlements/get-settlement","metadata":{"seo":{"title":"List settlements","description":"Returns your settlements, newest first. Each settlement groups the transactions paid out together in a single bank transfer."}},"httpPath":"/settlement"},{"label":"Retrieve a settlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/settlements/get-settlement-id","routeSlug":"/pt/openapi/settlements/get-settlement-id","metadata":{"seo":{"title":"Retrieve a settlement","description":"Retrieve a single settlement by its ID."}},"httpPath":"/settlement/{id}"}]},{"type":"group","label":"Out Payment","link":"/pt/openapi/out-payment","routeSlug":"/pt/openapi/out-payment","items":[{"label":"Lists out payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/out-payment/get_out_payment","routeSlug":"/pt/openapi/out-payment/get_out_payment","metadata":{"seo":{"title":"Lists out payments","description":"Full report with all the out payments from your Account Id"}},"httpPath":"/out_payment"},{"label":"Create out payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/out-payment/post_out_payment","routeSlug":"/pt/openapi/out-payment/post_out_payment","metadata":{"seo":{"title":"Create out payment","description":"Get your strong authentication RSA private key from Easypay Backoffice on menu:</br>Web Services->Configuration API 2.0->Keys."}},"httpPath":"/out_payment"},{"label":"Shows out payment details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/out-payment/get_out_payment_id","routeSlug":"/pt/openapi/out-payment/get_out_payment_id","metadata":{"seo":{"title":"Shows out payment details","description":"Required scope: <code style=\"background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em\">out_payment:read</code>"}},"httpPath":"/out_payment/{id}"},{"label":"Deletes out payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/out-payment/delete_out_payment_id","routeSlug":"/pt/openapi/out-payment/delete_out_payment_id","metadata":{"seo":{"title":"Deletes out payment","description":"If the payment is not processed, it will be cancelled. </br> Get your strong authentication RSA private key from Easypay Backoffice on menu: </br> Web Services->Configuration API 2.0->Keys."}},"httpPath":"/out_payment/{id}"}]},{"type":"group","label":"Config","link":"/pt/openapi/config","routeSlug":"/pt/openapi/config","items":[{"label":"Get Account Config","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/config/get_config","routeSlug":"/pt/openapi/config/get_config","metadata":{"seo":{"title":"Get Account Config","description":"Required scope: <code style=\"background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em\">config:read</code>"}},"httpPath":"/config"},{"label":"Patch Account Config","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/config/patch_config","routeSlug":"/pt/openapi/config/patch_config","metadata":{"seo":{"title":"Patch Account Config","description":"This endpoint is useful for setting up the correct URLs for event notifications.For more details, see Notifications-Webhooks."}},"httpPath":"/config"}]},{"type":"group","label":"Checkout","link":"/pt/openapi/checkout","routeSlug":"/pt/openapi/checkout","items":[{"label":"Shows checkout details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/checkout/get_checkout_id","routeSlug":"/pt/openapi/checkout/get_checkout_id","metadata":{"seo":{"title":"Shows checkout details","description":"Required scope: <code style=\"background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em\">checkout:read</code>"}},"httpPath":"/checkout/{id}"},{"label":"Cancels a checkout","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/checkout/delete_checkout_id","routeSlug":"/pt/openapi/checkout/delete_checkout_id","metadata":{"seo":{"title":"Cancels a checkout","description":"This cancels the Checkout and deletes the payment associated with it if possible."}},"httpPath":"/checkout/{id}"},{"label":"Create Checkout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/checkout/checkout-post","routeSlug":"/pt/openapi/checkout/checkout-post","metadata":{"seo":{"title":"Create Checkout","description":"Creates a Checkout Session."}},"httpPath":"/checkout"}]},{"type":"group","label":"Pay By Link","link":"/pt/openapi/pay-by-link","routeSlug":"/pt/openapi/pay-by-link","items":[{"label":"Create a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/pay-by-link/post-link","routeSlug":"/pt/openapi/pay-by-link/post-link","metadata":{"seo":{"title":"Create a payment link","description":"Generates a link that takes customers straight to a secure and ready-to-pay checkout."}},"httpPath":"/link"},{"label":"List all payment links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/pay-by-link/get-link","routeSlug":"/pt/openapi/pay-by-link/get-link","metadata":{"seo":{"title":"List all payment links","description":"List all the payment links."}},"httpPath":"/link"},{"label":"List payment link details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/pay-by-link/get-link-id","routeSlug":"/pt/openapi/pay-by-link/get-link-id","metadata":{"seo":{"title":"List payment link details","description":"Lists a payment link with all the details identified by its unique ID."}},"httpPath":"/link/{id}"},{"label":"Delete Link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/pay-by-link/delete-link-id","routeSlug":"/pt/openapi/pay-by-link/delete-link-id","metadata":{"seo":{"title":"Delete Link","description":"Deletes a payment link identified by its unique ID. Once deleted, the link becomes invalid and can no longer be used. This action is irreversible."}},"httpPath":"/link/{id}"},{"label":"Update Link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/pay-by-link/patch-link","routeSlug":"/pt/openapi/pay-by-link/patch-link","metadata":{"seo":{"title":"Update Link","description":"Updates a payment link identified by its unique ID."}},"httpPath":"/link/{id}"}]},{"type":"group","label":"Customer","link":"/pt/openapi/customer","routeSlug":"/pt/openapi/customer","items":[{"label":"Show customer details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/customer/get_customer_id","routeSlug":"/pt/openapi/customer/get_customer_id","metadata":{"seo":{"title":"Show customer details","description":"Retrieves the customer details, including reward balances."}},"httpPath":"/customer/{id}"},{"label":"List customer reward ledger entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/customer/get_customer_id_rewards","routeSlug":"/pt/openapi/customer/get_customer_id_rewards","metadata":{"seo":{"title":"List customer reward ledger entries","description":"Lists reward ledger entries for a customer. Each entry is a single movement — a reward earned (type: REWARD), a redemption against a reward (type: REDEMPTION), an unused reward swept at its expiry date (type: REWARD_EXPIRATION), a reward taken back after the earning capture was refunded or charged back (type: REWARD_REVERSAL), or a redemption given back as fresh credit after a refund or chargeback (type: REWARD_RESTORATION). Supports filtering by account, type, expiry date, and creation date. Results are sorted by creation date descending (newest first). See the Rewards & Redemptions guide for the full flow."}},"httpPath":"/customer/{id}/rewards"}]},{"type":"group","label":"Terminals","link":"/pt/openapi/terminals","routeSlug":"/pt/openapi/terminals","items":[{"label":"List terminals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/terminals/get_terminal","routeSlug":"/pt/openapi/terminals/get_terminal","metadata":{"seo":{"title":"List terminals","description":"List all terminals (POS devices) from your account."}},"httpPath":"/terminal"},{"label":"Create terminal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/terminals/post_terminal","routeSlug":"/pt/openapi/terminals/post_terminal","metadata":{"seo":{"title":"Create terminal","description":"Creates a new terminal (POS device)."}},"httpPath":"/terminal"},{"label":"Show terminal details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/terminals/get_terminal_id","routeSlug":"/pt/openapi/terminals/get_terminal_id","metadata":{"seo":{"title":"Show terminal details","description":"Retrieves the terminal details."}},"httpPath":"/terminal/{id}"},{"label":"Delete terminal","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/terminals/delete_terminal_id","routeSlug":"/pt/openapi/terminals/delete_terminal_id","metadata":{"seo":{"title":"Delete terminal","description":"Deletes the terminal."}},"httpPath":"/terminal/{id}"},{"label":"Update terminal","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/terminals/patch_terminal_id","routeSlug":"/pt/openapi/terminals/patch_terminal_id","metadata":{"seo":{"title":"Update terminal","description":"Updates the terminal details."}},"httpPath":"/terminal/{id}"}]},{"type":"group","label":"System","link":"/pt/openapi/system","routeSlug":"/pt/openapi/system","items":[{"label":"Check connectivity and authentication","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/system/ping","routeSlug":"/pt/openapi/system/ping","metadata":{"seo":{"title":"Check connectivity and authentication","description":"This endpoint allows you to verify connectivity to the API and validate your authentication credentials.A successful response indicates that the API is reachable and your credentials are valid."}},"httpPath":"/system/ping"}]}]}