# Paybyrd - [Welcome to Paybyrd!](https://docs.paybyrd.com/introduction.md): Accept card, digital wallet, bank transfer, and in-store payments through a single REST API. PCI-compliant and built for both e-commerce and POS transactions. - [Start building](https://docs.paybyrd.com/get-started/start-building.md): Learn how to access the merchant dashboard and start using the tools Paybyrd provides to build your product. - [Test your integration](https://docs.paybyrd.com/get-started/test-your-integration.md) - [Tokenization](https://docs.paybyrd.com/advanced/tokenization.md) - [3DS authentication](https://docs.paybyrd.com/advanced/3ds-authentication/overview.md) - [SDK setup](https://docs.paybyrd.com/advanced/3ds-authentication/sdk-setup.md) - [Simplified setup](https://docs.paybyrd.com/advanced/3ds-authentication/simplified-setup.md) - [Tracking requests](https://docs.paybyrd.com/advanced/tracking-requests.md) - [Create Payment](https://docs.paybyrd.com/accept-payments/how-it-works.md) - [Card](https://docs.paybyrd.com/accept-payments/card/card-payments.md) - [iDEAL | Wero](https://docs.paybyrd.com/accept-payments/bank-transfers/ideal-wero.md) - [Multibanco](https://docs.paybyrd.com/accept-payments/bank-transfers/multibanco.md) - [Multicaixa Express](https://docs.paybyrd.com/accept-payments/bank-transfers/multicaixa-express.md) - [SEPA](https://docs.paybyrd.com/accept-payments/bank-transfers/sepa.md) - [Floa](https://docs.paybyrd.com/accept-payments/buy-now-pay-later/floa.md) - [Klarna](https://docs.paybyrd.com/accept-payments/buy-now-pay-later/klarna.md) - [Apple Pay](https://docs.paybyrd.com/accept-payments/digital-wallets/apple-pay.md) - [MB WAY](https://docs.paybyrd.com/accept-payments/digital-wallets/mb-way.md) - [NuPay](https://docs.paybyrd.com/accept-payments/digital-wallets/nupay.md) - [PayPal](https://docs.paybyrd.com/accept-payments/digital-wallets/paypal.md) - [Revolut Pay](https://docs.paybyrd.com/accept-payments/digital-wallets/revolut-pay.md) - [Adjust](https://docs.paybyrd.com/manage-payments/payment-lifecycle/adjust.md) - [Capture](https://docs.paybyrd.com/manage-payments/payment-lifecycle/capture.md) - [Query Transactions](https://docs.paybyrd.com/manage-payments/payment-lifecycle/query-transactions.md) - [Refund](https://docs.paybyrd.com/manage-payments/payment-lifecycle/refund.md) - [Release](https://docs.paybyrd.com/manage-payments/payment-lifecycle/release.md) - [Settlement files](https://docs.paybyrd.com/manage-payments/settlements/settlement-files.md) - [Settlement files (legacy)](https://docs.paybyrd.com/manage-payments/settlements/legacy-settlement-files.md) - [Refunds before clearing files](https://docs.paybyrd.com/manage-payments/settlements/refunds-before-clearing.md) - [Checkout](https://docs.paybyrd.com/embed/checkout.md) - [Migration guide](https://docs.paybyrd.com/embed/checkout-migration-guide.md) - [Checkout parameter reference](https://docs.paybyrd.com/embed/checkout-parameter-reference.md) - [Card Collect](https://docs.paybyrd.com/embed/card-collect.md) - [Pay by Link](https://docs.paybyrd.com/embed/pay-by-link.md) - [WooCommerce](https://docs.paybyrd.com/integrations/ecommerce-plugins/woocommerce.md) - [Adobe Commerce (Magento)](https://docs.paybyrd.com/integrations/ecommerce-plugins/adobe-commerce-magento.md) - [nopCommerce](https://docs.paybyrd.com/integrations/ecommerce-plugins/nopcommerce.md) - [Payment Terminals](https://docs.paybyrd.com/integrations/point-of-sale/payment-terminals.md) - [Payment SDK (Android)](https://docs.paybyrd.com/integrations/point-of-sale/payment-sdk-android.md) - [Remote transaction](https://docs.paybyrd.com/integrations/point-of-sale/remote-transaction.md) - [POS Application Manual](https://docs.paybyrd.com/integrations/point-of-sale/pos-application-manual.md) - [PAX peripherals Kit](https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit.md) - [API intro](https://docs.paybyrd.com/api-reference/api-intro.md) - [Response code reference](https://docs.paybyrd.com/api-reference/api-code-reference.md) - [Webhook API](https://docs.paybyrd.com/api-reference/webhooks.md) - [Create Payment](https://docs.paybyrd.com/api-reference/payments/create-payment.md) - [Finish two-step card payment](https://docs.paybyrd.com/api-reference/payments/finish-two-step-card-payment.md) - [Refund](https://docs.paybyrd.com/api-reference/transactions/refund.md): When you want to refund values from a transaction, you need to send from your cash register to our API a request to do a refund value from the transaction. - [Release](https://docs.paybyrd.com/api-reference/transactions/release.md): In order to release a reserved amount through a pre-authorization is necessary to send a request from your cash register to our API. - [Capture](https://docs.paybyrd.com/api-reference/transactions/capture.md): For the charge to be carried out from a pre-authorization, it's necessary to send from your cash register to our API a request to capture the value of the payment-related transaction. - [Cancel](https://docs.paybyrd.com/api-reference/transactions/cancel.md) - [Adjust](https://docs.paybyrd.com/api-reference/transactions/adjust.md): Changes the reserved amount before the capture occurs. - [Query](https://docs.paybyrd.com/api-reference/transactions/query.md) - [Receipt](https://docs.paybyrd.com/api-reference/transactions/receipt.md): Retrieve receipt data for POS transactions - [Query by acquirer custom identifier](https://docs.paybyrd.com/api-reference/transactions/query-by-acquirer-custom-identifier.md) - [Setup URL](https://docs.paybyrd.com/api-reference/webhooks/setup-url.md): When your server is ready to handle the notifications, you need to set up your URL into your merchant account. To achieve this you need to call the following endpoint - [Gets a webhook settings by its Id](https://docs.paybyrd.com/api-reference/webhooks/gets-a-webhook-settings-by-its-id.md): This endpoint allows you to recover a specific webhook settings by its Id. - [Gets all webhook settings](https://docs.paybyrd.com/api-reference/webhooks/gets-all-webhook-settings.md): This endpoint allows you to recover all webhook settings. - [Creates a new webhook setting](https://docs.paybyrd.com/api-reference/webhooks/creates-a-new-webhook-setting.md): This endpoint allows you to configure more than one address for webhooks notifications. - [Updates a webhook setting url](https://docs.paybyrd.com/api-reference/webhooks/updates-a-webhook-setting-url.md) - [Enables a webhook setting](https://docs.paybyrd.com/api-reference/webhooks/enables-a-webhook-setting.md) - [Disables a webhook setting](https://docs.paybyrd.com/api-reference/webhooks/disables-a-webhook-setting.md) - [Updates a webhook setting url](https://docs.paybyrd.com/api-reference/webhooks/updates-a-webhook-setting-url-1.md) - [resend](https://docs.paybyrd.com/api-reference/paybylink/resend.md) - [Create](https://docs.paybyrd.com/api-reference/subscription/create.md) - [Create Order](https://docs.paybyrd.com/api-reference/orders/create-order.md): This endpoint allows you to create a new order. Orders are used in Paybyrd Checkout or the Pay By Link feature. - [Query Order](https://docs.paybyrd.com/api-reference/orders/query-order.md): Query order data by order id - [Cancel Order](https://docs.paybyrd.com/api-reference/orders/cancel-order.md): Cancel an order by id - [Get Token by reference](https://docs.paybyrd.com/api-reference/tokenization/get-token-by-reference.md): Get created tokens by aggregated reference - [Create Token](https://docs.paybyrd.com/api-reference/tokenization/create-token.md): Create a Token for future transactions - [Get Token By Id](https://docs.paybyrd.com/api-reference/tokenization/get-token-by-id.md): Get a created token By Id - [List settlement files](https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files.md): Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information. - [Changelog](https://docs.paybyrd.com/changelog.md): Product updates and improvements to the Paybyrd API and documentation. ## OpenAPI Specs - [openapi](/openapi.yml) - [settlements-api](/settlements-api.yml) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.