# Plexy ## Docs - [Overview](https://developer.plexy.money/overview-1614763m0.md): - [Authorization](https://developer.plexy.money/authorization-1614875m0.md): - [Webhooks](https://developer.plexy.money/webhooks-1614772m0.md): - [API Errors](https://developer.plexy.money/api-errors-1614748m0.md): - [Test Scenarios](https://developer.plexy.money/test-scenarios-1614792m0.md): - [Ecommerce Plugins](https://developer.plexy.money/ecommerce-plugins-1614793m0.md): - API > Payments [Overview](https://developer.plexy.money/overview-1644895m0.md): - API > Payments [Payment Links](https://developer.plexy.money/payment-links-4976244f0.md): - API > Payments [Reccurent Payments](https://developer.plexy.money/reccurent-payments-4977059f0.md): - API > Payments [Direct Payments](https://developer.plexy.money/direct-payments-4978232f0.md): - API > Payments [Transaction Management](https://developer.plexy.money/transaction-management-4976246f0.md): - API > Payments [Payment Management](https://developer.plexy.money/payment-management-5090094f0.md): - API > Payments [Settlement Payment Order](https://developer.plexy.money/settlement-payment-order-5318170f0.md): - API [Payouts](https://developer.plexy.money/payouts-4976245f0.md): - [Client SDK](https://developer.plexy.money/client-sdk-5167049f0.md): - Client SDK > Server flow [Advanced server flow](https://developer.plexy.money/advanced-server-flow-1679297m0.md): - Client SDK > Server flow [Session server flow](https://developer.plexy.money/session-server-flow-1677955m0.md): - Client SDK > Web [Web Drop-in](https://developer.plexy.money/web-drop-in-1679367m0.md): - Client SDK > Web [Web Components](https://developer.plexy.money/web-components-1679369m0.md): - Client SDK [Flutter](https://developer.plexy.money/flutter-5167128f0.md): - Client SDK > Flutter [Flutter Drop-in](https://developer.plexy.money/flutter-drop-in-1677814m0.md): - Client SDK > Flutter [Flutter Components](https://developer.plexy.money/flutter-components-1679298m0.md): - [Overview](https://developer.plexy.money/overview-1860564m0.md): ## API Docs - API > Payments > Payment Links [Create Payment Link](https://developer.plexy.money/create-payment-link-21794564e0.md): This endpoint allows merchants to create a payment link that can be shared with customers for making payments. The payment link contains details such as the amount, currency, description, and optional metadata. It can also be customized with URLs for success, failure, and cancellation scenarios. The payment link is valid until the specified expiration date and can be used for one-time or recurring payments depending on the provided settings. - API > Payments > Payment Links [List Payment Links](https://developer.plexy.money/list-payment-links-21794563e0.md): This endpoint retrieves a list of payment links for a merchant, based on various query parameters such as status, page, and date range. The response includes pagination information along with the payment links data. - API > Payments > Payment Links [Retrieve Payment Link by Order Reference](https://developer.plexy.money/retrieve-payment-link-by-order-reference-21794565e0.md): This endpoint retrieves a payment link based on the provided order reference. It returns the details of the payment link if found. - API > Payments > Payment Links [Cancel Payment Link](https://developer.plexy.money/cancel-payment-link-21794566e0.md): This endpoint cancels a payment link for a merchant. It checks if the payment link exists and can be canceled, and updates its status to "Cancelled" if possible. If the payment link cannot be canceled, an appropriate error is returned. - API > Payments > Payment Links [Retrieve Payment Link](https://developer.plexy.money/retrieve-payment-link-21794567e0.md): This endpoint retrieves a payment link based on the provided external ID, the merchant's ID, and store ID. It returns the details of the payment link if found. - API > Payments > Payment Links [Update Payment Link Expiration](https://developer.plexy.money/update-payment-link-expiration-21794568e0.md): This endpoint updates the expiration time of a payment link, identified by its external ID. If the link is not found or cannot be updated, appropriate error responses are returned. - API > Payments > Payment Links [Retrieve Payment Links Statistics](https://developer.plexy.money/retrieve-payment-links-statistics-21794569e0.md): This endpoint retrieves statistics for payment links based on the merchant and optional query parameters like date range and currency. - API > Payments > Reccurent Payments [Create Merchant-Initiated Payment](https://developer.plexy.money/create-merchant-initiated-payment-21794553e0.md): Process a payment initiated by the merchant using stored credentials. - API > Payments > Direct Payments [Get Keys](https://developer.plexy.money/get-keys-25187447e0.md): ## `/keys` — Card encryption key for H2H payments - API > Payments > Direct Payments [Create Host-to-Host Payment](https://developer.plexy.money/create-host-to-host-payment-21794552e0.md): - API > Payments > Transaction Management [Find Transaction's History by ID](https://developer.plexy.money/find-transactions-history-by-id-21794574e0.md): Retrieves the history of events for a specific transaction, based on the provided transaction ID. - API > Payments > Transaction Management [Find Transaction by Payment Link ID](https://developer.plexy.money/find-transaction-by-payment-link-id-21794571e0.md): Retrieves details for a specific transaction based on the provided payment link ID. - API > Payments > Transaction Management [Find Transaction by ID](https://developer.plexy.money/find-transaction-by-id-21794573e0.md): Retrieves details for a specific transaction based on the provided transaction ID, including pay-in balance information (PayInBalanceBefore and PayInBalanceAfter fields). - API > Payments > Transaction Management [Find Transaction by Order reference](https://developer.plexy.money/find-transaction-by-order-reference-24694801e0.md): Retrieves details for a specific transaction based on the provided transaction ID, including pay-in balance information (PayInBalanceBefore and PayInBalanceAfter fields). - API > Payments > Payment Management [Cancel Payment](https://developer.plexy.money/cancel-payment-21794554e0.md): This endpoint allows the merchant to cancel a previously authorized payment transaction before it is captured. The authorization will be voided, and no further charges will occur. - API > Payments > Payment Management [Capture Payment](https://developer.plexy.money/capture-payment-21794555e0.md): This endpoint allows the merchant to capture an authorized payment transaction. The transaction must have been previously authorized and is now ready to be finalized. The payment capture is for the specified amount, and if the full amount is captured, the authorization will be marked as complete. - API > Payments > Payment Management [Process Refund](https://developer.plexy.money/process-refund-21794556e0.md): This endpoint allows a merchant to refund a previously captured payment. The refund amount can be partial or full, and the refund will be processed according to the transaction's original payment method. - API > Payments > Split Requests [Create](https://developer.plexy.money/create-22427033e0.md): - API > Payments > Split Requests [List](https://developer.plexy.money/list-22429572e0.md): - API > Payments > Split Requests [Update](https://developer.plexy.money/update-22430355e0.md): - API > Payments > Split Requests [Get By Id](https://developer.plexy.money/get-by-id-22430419e0.md): - API > Payments > Split Requests [Delete](https://developer.plexy.money/delete-22430421e0.md): - API > Payments > Settlement Payment Order [Create](https://developer.plexy.money/create-23167091e0.md): This endpoint allows merchants to create a settlement payment order request . The settlement payment request contains details such as the totalAmount, beneficiayId. After making request system will start making payment for beneficiary and merchant wil get information about status of request by using webhooks. Webhooks can be managed in merchant settings. - API > Payments > Settlement Payment Order [Get by id](https://developer.plexy.money/get-by-id-23167211e0.md): This endpoint allows merchants to get detailed information about settlement payment request - API > Payments > Settlement Payment Order [List](https://developer.plexy.money/list-23167601e0.md): This endpoint allows merchants to get information about all settlement payment orders which was created. - API > Payouts [Retrieve Payout Transactions](https://developer.plexy.money/retrieve-payout-transactions-22150616e0.md): - API > Payouts [Process Payout](https://developer.plexy.money/process-payout-21794570e0.md): Process a payout using stored card credentials. - API > Payouts [Save Card for Payouts](https://developer.plexy.money/save-card-for-payouts-21794557e0.md): Initializes a session for saving a customer’s card and redirects to a hosted checkout. This method does not validate the card via bank transaction. - API > Customers [Get Customer's Card Tokens](https://developer.plexy.money/get-customers-card-tokens-22751890e0.md): - API > Customers [List Customers](https://developer.plexy.money/list-customers-21794558e0.md): List all customers based on merchantID and storeID with pagination. - API > Customers [Create Customer](https://developer.plexy.money/create-customer-21794559e0.md): Create a new customer with full name, email, phone number, and external ID. - API > Customers [Get Customer by ID](https://developer.plexy.money/get-customer-by-id-21794560e0.md): Get customer’s details based on the provided merchantID, storeID, and customerID. - API > Customers [Get Customer's Transactions](https://developer.plexy.money/get-customers-transactions-21794561e0.md): Get the list of transactions for a specific customer based on merchantID, storeID, and customerID with pagination. - API > Merchants > Payment Beneficiary [Create](https://developer.plexy.money/create-22430496e0.md): - API > Merchants > Payment Beneficiary [Update](https://developer.plexy.money/update-22430843e0.md): - API > Merchants > Payment Beneficiary [Gey By Id](https://developer.plexy.money/gey-by-id-22430890e0.md): - API > Merchants > Payment Beneficiary [List](https://developer.plexy.money/list-22430894e0.md): - API > Merchants > Payment Beneficiary [Transfer from beneficiary balance to merchant balance](https://developer.plexy.money/transfer-from-beneficiary-balance-to-merchant-balance-22786472e0.md): - API > Merchants > Payment Beneficiary [Create manual settlement for beneficiary](https://developer.plexy.money/create-manual-settlement-for-beneficiary-22786990e0.md): - API > Merchants [Retrieve Merchant's Details](https://developer.plexy.money/retrieve-merchants-details-21794562e0.md): - Products [List product types](https://developer.plexy.money/list-product-types-25538206e0.md): Returns the canonical product types. Use to map UI behavior (e.g., top-up flow). - Products [List product categories](https://developer.plexy.money/list-product-categories-25538207e0.md): Returns all categories with pagination. Combine with `/products` to filter by category. - Products [List products](https://developer.plexy.money/list-products-25538208e0.md): Returns paginated products with filters. - Products [Get product](https://developer.plexy.money/get-product-25538209e0.md): Retrieves details of a product by ID. - Orders [List orders](https://developer.plexy.money/list-orders-25538210e0.md): Returns a paginated list of orders for this agent with filters. - Orders [Create order](https://developer.plexy.money/create-order-25538211e0.md): Creates an order for this agent, computes **plexy_margin** and **agent_charge**, and reserves agent balance. For `direct_top_up` products, include a `topup_request` payload with customer account details and the requested amount. - Orders [Get order by ID](https://developer.plexy.money/get-order-by-id-25538212e0.md): Retrieves order details. - Balances [Get balance](https://developer.plexy.money/get-balance-25538213e0.md): Returns current balance per currency for this agent. - Deposits [List deposit history](https://developer.plexy.money/list-deposit-history-25538214e0.md): Returns subagent deposit records. - System [API health](https://developer.plexy.money/api-health-25538215e0.md): Health check. No auth required. ## Schemas - Schemas [response.TransactionList](https://developer.plexy.money/response-transactionlist-9857148d0.md): - Schemas [entity.SplitRequest](https://developer.plexy.money/entity-splitrequest-10010096d0.md): - Schemas [entity.PaymentBeneficiary](https://developer.plexy.money/entity-paymentbeneficiary-10010155d0.md): - Schemas [request.CreatePaymentBeneficiary](https://developer.plexy.money/request-createpaymentbeneficiary-10010158d0.md): - Schemas [entity.SettlementPaymentOrder](https://developer.plexy.money/entity-settlementpaymentorder-10341335d0.md): - Schemas [entity.PayoutRequest](https://developer.plexy.money/entity-payoutrequest-11253097d0.md): - Schemas [entity.PayoutRequestRowData](https://developer.plexy.money/entity-payoutrequestrowdata-11253114d0.md): - Schemas [command.HandleThreeDResult](https://developer.plexy.money/command-handlethreedresult-9656155d0.md): - Schemas [domain.Report](https://developer.plexy.money/domain-report-9656156d0.md): - Schemas [entity.CardSaveSessionCustomer](https://developer.plexy.money/entity-cardsavesessioncustomer-9656157d0.md): - Schemas [entity.Permission](https://developer.plexy.money/entity-permission-9656158d0.md): - Schemas [entity.UserProfile](https://developer.plexy.money/entity-userprofile-9656159d0.md): - Schemas [entity.UserRole](https://developer.plexy.money/entity-userrole-9656160d0.md): - Schemas [errors.Message](https://developer.plexy.money/errors-message-9656161d0.md): - Schemas [errors.Source](https://developer.plexy.money/errors-source-9656162d0.md): - Schemas [errors.Type](https://developer.plexy.money/errors-type-9656163d0.md): - Schemas [git_plexypay_com_ecom_back_api_internal_domain_view.Page-domain_Report](https://developer.plexy.money/git-plexypay-com-ecom-back-api-internal-domain-view-page-domain-report-9656164d0.md): - Schemas [git_plexypay_com_ecom_back_api_internal_domain_view.Page-entity_UserProfile](https://developer.plexy.money/git-plexypay-com-ecom-back-api-internal-domain-view-page-entity-userprofile-9656165d0.md): - Schemas [git_plexypay_com_ecom_back_api_internal_platform_errors.Code](https://developer.plexy.money/git-plexypay-com-ecom-back-api-internal-platform-errors-code-9656166d0.md): - Schemas [models.CSVApiRequest](https://developer.plexy.money/models-csvapirequest-9656167d0.md): - Schemas [models.CreateBussinessDetails](https://developer.plexy.money/models-createbussinessdetails-9656168d0.md): - Schemas [models.KeyResponse](https://developer.plexy.money/models-keyresponse-9656169d0.md): - Schemas [models.OnboardingRequest](https://developer.plexy.money/models-onboardingrequest-9656170d0.md): - Schemas [models.Transaction](https://developer.plexy.money/models-transaction-9656171d0.md): - Schemas [paymentcore.Address](https://developer.plexy.money/paymentcore-address-9656172d0.md): - Schemas [paymentcore.CustomerDetails](https://developer.plexy.money/paymentcore-customerdetails-9656173d0.md): - Schemas [request.AuthorizePayment](https://developer.plexy.money/request-authorizepayment-9656174d0.md): - Schemas [request.BrowserDetails](https://developer.plexy.money/request-browserdetails-9656175d0.md): - Schemas [request.CardData](https://developer.plexy.money/request-carddata-9656176d0.md): - Schemas [request.ChangeUserRole](https://developer.plexy.money/request-changeuserrole-9656177d0.md): - Schemas [request.ContinueThreeDS](https://developer.plexy.money/request-continuethreeds-9656178d0.md): - Schemas [request.CreateCardSaveSession](https://developer.plexy.money/request-createcardsavesession-9656179d0.md): - Schemas [request.CreateInviteSession](https://developer.plexy.money/request-createinvitesession-9656180d0.md): - Schemas [request.CreatePaymentLink](https://developer.plexy.money/request-createpaymentlink-9656181d0.md): - Schemas [request.CreatePaymentLinkMetadata](https://developer.plexy.money/request-createpaymentlinkmetadata-9656182d0.md): - Schemas [request.HandlePayout](https://developer.plexy.money/request-handlepayout-9656183d0.md): - Schemas [request.MerchantInitiatedPayment](https://developer.plexy.money/request-merchantinitiatedpayment-9656184d0.md): - Schemas [request.PasswordRequest](https://developer.plexy.money/request-passwordrequest-9656185d0.md): - Schemas [request.Recurring](https://developer.plexy.money/request-recurring-9656186d0.md): - Schemas [request.RefundPayment](https://developer.plexy.money/request-refundpayment-9656187d0.md): - Schemas [request.SaveCard](https://developer.plexy.money/request-savecard-9656188d0.md): - Schemas [request.SaveOneCustomer](https://developer.plexy.money/request-saveonecustomer-9656189d0.md): - Schemas [request.TwoStepAuthorizePayment](https://developer.plexy.money/request-twostepauthorizepayment-9656190d0.md): - Schemas [request.UpdateMerchantSettingsRequest](https://developer.plexy.money/request-updatemerchantsettingsrequest-9656191d0.md): - Schemas [request.UpdatePaymentLink](https://developer.plexy.money/request-updatepaymentlink-9656192d0.md): - Schemas [response.AcquirerResponseThreeDSecure](https://developer.plexy.money/response-acquirerresponsethreedsecure-9656193d0.md): - Schemas [response.AuthorizeAndCapturePayment](https://developer.plexy.money/response-authorizeandcapturepayment-9656194d0.md): - Schemas [response.AuthorizePayment](https://developer.plexy.money/response-authorizepayment-9656195d0.md): - Schemas [response.CancelPaymentResponse](https://developer.plexy.money/response-cancelpaymentresponse-9656196d0.md): - Schemas [response.CapturePaymentResponse](https://developer.plexy.money/response-capturepaymentresponse-9656197d0.md): - Schemas [response.ContinueThreeDS](https://developer.plexy.money/response-continuethreeds-9656198d0.md): - Schemas [response.Currency](https://developer.plexy.money/response-currency-9656199d0.md): - Schemas [response.Customer](https://developer.plexy.money/response-customer-9656200d0.md): - Schemas [response.CustomerTransaction](https://developer.plexy.money/response-customertransaction-9656201d0.md): - Schemas [response.CustomerTransactions](https://developer.plexy.money/response-customertransactions-9656202d0.md): - Schemas [response.Customers](https://developer.plexy.money/response-customers-9656203d0.md): - Schemas [response.Error](https://developer.plexy.money/response-error-9656204d0.md): - Schemas [response.Merchant](https://developer.plexy.money/response-merchant-9656205d0.md): - Schemas [response.MerchantInitiatedPayment](https://developer.plexy.money/response-merchantinitiatedpayment-9656206d0.md): - Schemas [response.MerchantSettings](https://developer.plexy.money/response-merchantsettings-9656207d0.md): - Schemas [response.PaymentLink](https://developer.plexy.money/response-paymentlink-9656208d0.md): - Schemas [response.PaymentLinkInfo](https://developer.plexy.money/response-paymentlinkinfo-9656209d0.md): - Schemas [response.PaymentLinkMetadata](https://developer.plexy.money/response-paymentlinkmetadata-9656210d0.md): - Schemas [response.PaymentLinksInfo](https://developer.plexy.money/response-paymentlinksinfo-9656211d0.md): - Schemas [response.PaymentLinksStatistics](https://developer.plexy.money/response-paymentlinksstatistics-9656212d0.md): - Schemas [response.PaymentLinksStatisticsItem](https://developer.plexy.money/response-paymentlinksstatisticsitem-9656213d0.md): - Schemas [response.Payout](https://developer.plexy.money/response-payout-9656214d0.md): - Schemas [response.Permission](https://developer.plexy.money/response-permission-9656215d0.md): - Schemas [response.RefundPaymentResponse](https://developer.plexy.money/response-refundpaymentresponse-9656216d0.md): - Schemas [response.Report](https://developer.plexy.money/response-report-9656217d0.md): - Schemas [response.SavedCard](https://developer.plexy.money/response-savedcard-9656218d0.md): - Schemas [response.Session](https://developer.plexy.money/response-session-9656219d0.md): - Schemas [response.Settlement](https://developer.plexy.money/response-settlement-9656220d0.md): - Schemas [response.SettlementTransaction](https://developer.plexy.money/response-settlementtransaction-9656221d0.md): - Schemas [response.Store](https://developer.plexy.money/response-store-9656222d0.md): - Schemas [response.Stores](https://developer.plexy.money/response-stores-9656223d0.md): - Schemas [response.Transaction](https://developer.plexy.money/response-transaction-9656224d0.md): - Schemas [response.TransactionDetails](https://developer.plexy.money/response-transactiondetails-9656225d0.md): - Schemas [response.TransactionEvents](https://developer.plexy.money/response-transactionevents-9656226d0.md): - Schemas [response.TransactionHistoryEvent](https://developer.plexy.money/response-transactionhistoryevent-9656227d0.md): - Schemas [response.TransactionHistoryEventData](https://developer.plexy.money/response-transactionhistoryeventdata-9656228d0.md): - Schemas [response.TransactionResponse](https://developer.plexy.money/response-transactionresponse-9656229d0.md): - Schemas [response.TransactionWebhookDetails](https://developer.plexy.money/response-transactionwebhookdetails-9656230d0.md): - Schemas [response.Transactions](https://developer.plexy.money/response-transactions-9656231d0.md): - Schemas [response.UpdateMerchantSettingsResponse](https://developer.plexy.money/response-updatemerchantsettingsresponse-9656232d0.md): - Schemas [response.UserProfile](https://developer.plexy.money/response-userprofile-9656233d0.md): - Schemas [value.PaymentMethod](https://developer.plexy.money/value-paymentmethod-9656234d0.md): - [receipt](https://developer.plexy.money/receipt-11212197d0.md): - [Error](https://developer.plexy.money/error-11606532d0.md): - [DecimalAmount](https://developer.plexy.money/decimalamount-11606533d0.md): - [ProductType](https://developer.plexy.money/producttype-11606534d0.md): - [ProductCategory](https://developer.plexy.money/productcategory-11606535d0.md): - [Product](https://developer.plexy.money/product-11606536d0.md): - [Order](https://developer.plexy.money/order-11606537d0.md): - [AgentBalance](https://developer.plexy.money/agentbalance-11606538d0.md): - [AgentDeposit](https://developer.plexy.money/agentdeposit-11606539d0.md): - [TopupRequest](https://developer.plexy.money/topuprequest-11606540d0.md): - [CreateOrderRequest](https://developer.plexy.money/createorderrequest-11606541d0.md):