Plexy
Pay APIGate APIDashboard
Pay APIGate APIDashboard
  1. Direct Payments
  • Overview
  • Authorization
  • Webhooks
  • API Errors
  • Test Scenarios
  • Ecommerce Plugins
  • API
    • Payments
      • Overview
      • Payment Links
        • Create Payment Link
        • List Payment Links
        • Retrieve Payment Link by Order Reference
        • Cancel Payment Link
        • Retrieve Payment Link
        • Update Payment Link Expiration
        • Retrieve Payment Links Statistics
      • Reccurent Payments
        • Create Merchant-Initiated Payment
      • Direct Payments
        • Get Keys
          GET
        • Create Host-to-Host Payment
          POST
      • Transaction Management
        • Find Transaction's History by ID
        • Find Transaction by Payment Link ID
        • Find Transaction by ID
        • Find Transaction by Order reference
      • Payment Management
        • Cancel Payment
        • Capture Payment
        • Process Refund
      • Split Requests
        • Create
        • List
        • Update
        • Get By Id
        • Delete
      • Settlement Payment Order
        • Create
        • Get by id
        • List
    • Payouts
      • Retrieve Payout Transactions
      • Process Payout
      • Save Card for Payouts
    • Customers
      • Get Customer's Card Tokens
      • List Customers
      • Create Customer
      • Get Customer by ID
      • Get Customer's Transactions
    • Merchants
      • Payment Beneficiary
        • Create
        • Update
        • Gey By Id
        • List
        • Transfer from beneficiary balance to merchant balance
        • Create manual settlement for beneficiary
      • Retrieve Merchant's Details
  • Client SDK
    • Server flow
      • Advanced server flow
      • Session server flow
    • Web
      • Web Drop-in
      • Web Components
    • Flutter
      • Flutter Drop-in
      • Flutter Components
  • Schemas
    • Schemas
      • response.TransactionList
      • entity.SplitRequest
      • entity.PaymentBeneficiary
      • request.CreatePaymentBeneficiary
      • entity.SettlementPaymentOrder
      • entity.PayoutRequest
      • entity.PayoutRequestRowData
      • command.HandleThreeDResult
      • domain.Report
      • entity.CardSaveSessionCustomer
      • entity.Permission
      • entity.UserProfile
      • entity.UserRole
      • errors.Message
      • errors.Source
      • errors.Type
      • git_plexypay_com_ecom_back_api_internal_domain_view.Page-domain_Report
      • git_plexypay_com_ecom_back_api_internal_domain_view.Page-entity_UserProfile
      • git_plexypay_com_ecom_back_api_internal_platform_errors.Code
      • models.CSVApiRequest
      • models.CreateBussinessDetails
      • models.KeyResponse
      • models.OnboardingRequest
      • models.Transaction
      • paymentcore.Address
      • paymentcore.CustomerDetails
      • request.AuthorizePayment
      • request.BrowserDetails
      • request.CardData
      • request.ChangeUserRole
      • request.ContinueThreeDS
      • request.CreateCardSaveSession
      • request.CreateInviteSession
      • request.CreatePaymentLink
      • request.CreatePaymentLinkMetadata
      • request.HandlePayout
      • request.MerchantInitiatedPayment
      • request.PasswordRequest
      • request.Recurring
      • request.RefundPayment
      • request.SaveCard
      • request.SaveOneCustomer
      • request.TwoStepAuthorizePayment
      • request.UpdateMerchantSettingsRequest
      • request.UpdatePaymentLink
      • response.AcquirerResponseThreeDSecure
      • response.AuthorizeAndCapturePayment
      • response.AuthorizePayment
      • response.CancelPaymentResponse
      • response.CapturePaymentResponse
      • response.ContinueThreeDS
      • response.Currency
      • response.Customer
      • response.CustomerTransaction
      • response.CustomerTransactions
      • response.Customers
      • response.Error
      • response.Merchant
      • response.MerchantInitiatedPayment
      • response.MerchantSettings
      • response.PaymentLink
      • response.PaymentLinkInfo
      • response.PaymentLinkMetadata
      • response.PaymentLinksInfo
      • response.PaymentLinksStatistics
      • response.PaymentLinksStatisticsItem
      • response.Payout
      • response.Permission
      • response.RefundPaymentResponse
      • response.Report
      • response.SavedCard
      • response.Session
      • response.Settlement
      • response.SettlementTransaction
      • response.Store
      • response.Stores
      • response.Transaction
      • response.TransactionDetails
      • response.TransactionEvents
      • response.TransactionHistoryEvent
      • response.TransactionHistoryEventData
      • response.TransactionResponse
      • response.TransactionWebhookDetails
      • response.Transactions
      • response.UpdateMerchantSettingsResponse
      • response.UserProfile
      • value.PaymentMethod
    • receipt
    • Error
    • DecimalAmount
    • ProductType
    • ProductCategory
    • Product
    • Order
    • AgentBalance
    • AgentDeposit
    • TopupRequest
    • CreateOrderRequest
Pay APIGate APIDashboard
Pay APIGate APIDashboard
  1. Direct Payments

Create Host-to-Host Payment

POST
https://api.plexypay.comv1/payments/direct

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Payment session created successfully
Body

🟠400Bad Request
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.plexypay.comv1/payments/direct' \
--header 'Idempotency-Key;' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 95590295,
    "currency": "KZT",
    "paymentMethod": {
        "cardData": {
            "encryptedCardNumber": "D1w9yNN5EQYXHDE/bBmvjuoqkZMphxCpKVmJf2zsvFxGYssXp8posm8ciQqDJDZ0bcp9+wbOwwpn4nag2GQ0RmxLLGAplR42d4Xdd+jvoOJqKQTUPi0jnA7mN5T9VYFFuKFrpsffssfsffs0AoZC3ng8jbGFWhEaJj6rONKr3DHby2JzTPPXvKs1U2cgtewQp/Y/NnJDNuiMJP3kHWelfSALqx5plCOT8w5/D0Qhmu5dOtdk2c+kMw6yVZ4AoF6sZedgZxrKKXKpTFvsU7M971DjTcpap76wbcv6t+iMYpBYbSzDfskjKOXskyTA/+Gma7sDuNrEcYM+hs3GvT5CLviosJE7ktXw==",
            "encryptedExpiryMonth": "rFyG3eKdEpnYsfsffs3QQZnSGIQRrSs9xlnUWUNhh9HLpMbbuFXT81XmChDvFZw65MtY+tfx/ru8W0qx1qsxnzqgJZY3GGstLtt/uez9MiQ2E8ANMGh1LlkloGhbXp/lazjwEamMSALFd79aaSCaPR3d3lytF0QulTaMiFxHwCI0g0MVEJkpCkKz4eg2TYLqZoRbobzeyvkcml4sYoHMMbyU/QRntXrisvEKplMQLpVaS/exYJCoKXQY53UsP6Qsm2db4NPTL7gEquSEPdy+tf/SS7gJd7HeFsse6KQviGpDc2D4Se9hy9C75Jt0zC70bFQUnuTj4DOI0feYjYOCWLeO8z+g==",
            "encryptedExpiryYear": "DemVND09zTfs0akZPnrIone6QDye8RTdBJe8yFUcAlw2WJ+Hve9CDmNVGo174tpODX3tgvlM3/LaJOca/SDFza3XD/iK8waGs7rGpRGtHWur3o19TizQjv66ydGG3n1vLhJDc2sw8xlnE0x7+2OartJU4dxnsibvX6mXjzSUsfsffs4/QSCef2xVmkyZdAEpsGKK1BX+JN1FScNS/38gGUA4a3yI7r14eRpzXmIDZ+ncSoXD3L8RaA/37A+6EjSanKyzZ1xRL6ZFg+QkelA7oMrkKSsRA2NZDXYQnbrzZbbG6H6VozwvWV85yWv5KF3UowjyL4nSxj3bn8+0TEY4qDiqhljQ==",
            "encryptedCardholderName": "KDVYbW7KAhKjYU+7nKbu5+OTDGefMg9lAuu9AzuWguAYD9sdFDhQ9Xws7yyaKLm7xA7q0+Ve+90zRmeny1XOpxWI310s3Q0L9GnTgzFIZ41iHe0WOhBl0SQLxev4+7Bv4KyFQdm8gLG134PfByxDeb5wuwSb1fkSwtJDP88+iLqDUVoRPMGlGUwKCZkiR9WSnzz7REXJPnMDmfI+GurR9JPVZx4kS4XjemM9T0zXw/xCXfGiUAvo+O6kW/YxtCGQXU3LUAtISNBk1Ou3MgWd4E0uWRkU16eKmvUBmScxivaskdtJEnGFOyTCS7qkQxSFUiN8XVjSREz+N8qUCooEPg==",
            "encryptedCvv": "mZvoLAGe0usR/ZKsZRRlK4eHy9hdUtd/Ow+E5YqunrgN2p510jvszzlwWxe5QHzaeji3PgEfDMw9uSp9RubvpnrOHDhjuBZq9LA9ImATLyBOyib78QtZ9ur/T/YptQRzJj7VNCnecWyhkg3V+M8xuiEzIGKK4BvV7nwZndqauzF9L8Gdl+Am/DrSenM6Rp9E1F3zlPI54NjKml1mRBVLoTs1zslAbwWFy0qO3o1al1AagklE+0L/TzxybHpiJb6wLi7RRr1nj+fEs+JCocuOZ5rRh9BDWiTwonmvV9cTDEsEL3qwdkSaRHvtEXsArFcoRK7t+rEpcD71Xjrc0XD1Gg=="
        }
    },
    "orderDetails": {
        "orderReference": "pariatur occaecat reprehenderit do",
        "cartReference": "Hatchback",
        "description": "Crapula modi aestivus somnus animi caste carmen aufero. Inflammatio congregatio cruentus uredo adsidue sufficio terra tener artificiose. Tactus tunc umquam cruentus alter nam arcus creo utrum."
    },
    "browserDetails": {
        "acceptHeader": "mollit reprehenderit dolor ea",
        "language": "proident",
        "colorDepth": "consequat consectetur quis pariatur",
        "screenHeight": "mollit ullamco",
        "screenWidth": "non eu aliquip",
        "timeZone": "Asia/Novosibirsk",
        "userAgent": "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.3; Trident/6.1)"
    },
    "clientData": {
        "customerId": "10"
    },
    "saveCard": true,
    "redirectUrls": {
        "cancel": "https://example.com/cancel",
        "success": "https://example.com/success",
        "failure": "https://example.com/faliure"
    }
}'
Response Response Example
200 - Example 1
{
    "id": "019a7d6f-c557-759a-995b-8280d0b48426",
    "responseCode": "",
    "orderReference": "flutter-test_1762854618501",
    "amount": 100,
    "paymentMethod": "card",
    "success": false,
    "message": "transaction in 3DS",
    "cardTokenId": "4405633452611651",
    "cardMask": "",
    "cardExpiryDate": "10/2026",
    "cardHolderName": "JOHN DOE",
    "cardScheme": "",
    "currency": "KZT",
    "status": "3D secure",
    "retrievalReferenceNumber": "",
    "successUrl": "https://www.google.com",
    "failureUrl": "https://www.google.com",
    "threeDS": {
        "creq": "eyJtZXNzYWdlVHlwZSI6IkNSZXEiLCJtZXNzYWdlVmVyc2lvbiI6IjIuMi4wIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiJjOGNkOWUwMy00NTU2LTQxNzEtOTRhNi1lNGI1NTlhNzk5NDMiLCJhY3NUcmFuc0lEIjoiZDRkMjVhZjYtMjFkZi00NWFmLWJhNDQtMmNkNWI1YWU2NmIxIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1In0",
        "threeDSSessionData": "YzhjZDllMDMtNDU1Ni00MTcxLTk0YTYtZTRiNTU5YTc5OTQz",
        "action": "https://3dsecure2.halykbank.kz/way4acs/brw/challenge?id=c8cd9e03-4556-4171-94a6-e4b559a79943",
        "threeDSMethodUrl": null,
        "threeDSServerTransId": null,
        "threeDSMethodURLServer": null,
        "termUrl": "https://3dsecure.bcc.kz:5443/cgi-bin/cgi_link",
        "threeDForm": "https://3dsecure2.halykbank.kz/way4acs/brw/challenge?id=c8cd9e03-4556-4171-94a6-e4b559a79943"
    },
    "threeDsRedirectUrl": "https://checkout.plexypay.com/3d?creq=eyJtZXNzYWdlVHlwZSI6IkNSZXEiLCJtZXNzYWdlVmVyc2lvbiI6IjIuMi4wIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiJjOGNkOWUwMy00NTU2LTQxNzEtOTRhNi1lNGI1NTlhNzk5NDMiLCJhY3NUcmFuc0lEIjoiZDRkMjVhZjYtMjFkZi00NWFmLWJhNDQtMmNkNWI1YWU2NmIxIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1In0&threeDSSessionData=YzhjZDllMDMtNDU1Ni00MTcxLTk0YTYtZTRiNTU5YTc5OTQz&action=https://3dsecure2.halykbank.kz/way4acs/brw/challenge?id=c8cd9e03-4556-4171-94a6-e4b559a79943"
}
Modified at 2025-12-15 13:54:15
Previous
Get Keys
Next
Transaction Management
Built with