This table emphasizes the notable variations in API URLs for different solutions and payment scenarios.
This table has been included in the documentation to draw attention to an important aspect of the API endpoint URL conventions used in Pockyt's platform. While all the endpoints share the same base URLs, there are noticeable variations in the URL paths that may not immediately seem intuitive. To assist developers in navigating these inconsistencies more efficiently, we have highlighted in bold those API endpoints with URL paths that deviate from the expected conventions. This highlighting aims to ensure developers are aware of these variations and can account for them in their integration process, thereby reducing potential confusion or errors when working with different endpoints. It's essential to carefully review these paths to ensure accurate and effective API calls.
| API Action | Solution | Payment Scenario | URL Path |
|---|---|---|---|
| Create QR Code | Pay-Ins | In-Store Merchant Presented | /app-instore/v3/create-trans-qrcode |
| Create New Transaction | Pay-Ins | In-Store Customer Presented | /app-instore/v3/add |
| Process Payment | Pay-Ins | In-Store Customer Presented | /app-instore/v3/prepay |
| Cancel Payment | Pay-Ins | In-Store Customer Presented, In-Store Merchant Presented, Online, In-App | /app-data-search/v3/cancel |
| Refund Payment | Pay-Ins | In-Store Customer Presented, In-Store Merchant Presented, Online, In-App | /app-data-search/v3/refund |
| Search Individual Transaction | Pay-Ins | In-Store Customer Presented, In-Store Merchant Presented, Online, In-App | /app-data-search/v3/tran-query |
| Search Bulk Transactions | Pay-Ins | In-Store Customer Presented, In-Store Merchant Presented, Online, In-App | /app-data-search/v3/transaction-list |
| Search Settlement Status | Pay-Ins | In-Store Customer Presented, In-Store Merchant Presented, Online, In-App | /app-data-search/v3/withdrawal-list |
| Initiate Online Payment | Pay-Ins | Online, In-App | /online/v3/secure-pay |
| Finalize Online Payment | Pay-Ins | Online, In-App | /creditpay/v3/process |
| Finalize In-App Payment | Pay-Ins | Online, Recurring Payments | /micropay/v3/prepay |
| Register Online Customer | Pay-Ins | Online, Recurring Payments | /v1/customers/create |
| Retrieve Online Customer | Pay-Ins | Online, Recurring Payments | /v1/customers/retrieve |
| Update Online Customer | Pay-Ins | Online, Recurring Payments | /v1/customers/update |
| Register Payee | Pay-Outs | Integrated Payotus | /v3/payee/register |
| Retrieve Payee | Pay-Outs | Integrated Pay-Outs | /v3/payee/retrieve |
| Retrieve Payout Account Balance | Pay-Outs | Integrated Pay-Outs | /v3/payouts/balance |
| Retrieve Payee Account | Pay-Outs | Integrated Pay-Outs | /v3/payee/payout-accounts |
| Delete Payee Account | Pay-Outs | Integrated Pay-Outs | /v3/payee/account/delete |
| Update Payee Record | Pay-Outs | Integrated Pay-Outs | /v3/payee/update |
| Add Payout Method | Pay-Outs | Integrated Pay-Outs | /v3/payee/account/create/bank-account |
| Execute Payout Transfer | Pay-Outs | Integrated Pay-Outs | /v3/payouts/pay |
| Retrieve FX Rate | Pay-Outs | Integrated Pay-Outs | /v3/payouts/fxrate |
| Submit Merchant Application | Partners | /api/merchant-onboarding/submit | |
| Query Merchant Application | Partners | /api/merchant-onboarding/query |