About the API Documentation
API Documentation Overview: Implementing Pockyt's Payment Processing APIs
This guide serves as a comprehensive guide for developers looking to integrate Pockyt's payment processing APIs into their development projects. It provides detailed instructions, API references, and recommended best practices. The documentation focuses on three key products: in-store payment processing APIs, eCommerce payment processing APIs, and payouts APIs.
Learn how to implement various payment scenarios, including customer-presented and merchant-presented QR code payments. Create sandbox test environments to facilitate the development and testing of in-store QR code payment processing. Ensure secure API calls using VeriSign encryption tools. The guide also covers best practices for features such as split payments, partial refunds, mid-transaction cancellations, and reporting workflows.
This section is designed for developers integrating Pockyt's online digital wallet payment processing APIs. It provides step-by-step tutorials and technical concepts to help seamlessly incorporate Pockyt into online payment systems. Pockyt offers a secure and user-friendly payment experience, supporting digital wallets and card payments. The documentation explains how to set up an account, create a sandbox test environment, integrate APIs into custom applications, and leverage Pockyt's APIs for various online payment workflows.
Discover Pockyt's payout services, enabling businesses to make payouts in multiple currencies to a wide range of endpoints and payment methods. This section guides developers in implementing Pockyt's B2C payouts service APIs, allowing convenient payments to influencers, sellers, and contractors across 180+ countries. The documentation covers registration of payees, sending payout instructions, and utilizing various payment methods such as PayPal, Venmo, consumer bank accounts in USD, and future support for AliPay+ network.
Throughout the document, you will find references to Pockyt's base sandbox URLs for testing and development purposes.
This developer's guide provides you with the knowledge and tools to successfully integrate Pockyt's payment processing APIs into your projects, ensuring a seamless payment experience for your users.
Pockyt APIs use the Azure Front Door Service, which requires all calls to the API to include RFC compliant formats. This means that your requests must include the following headers:
Content-LengthTransfer-Encoding
If your headers are not configured in the RFC-compliant format, you may receive a 411 Error. This error indicates that your HTTP request is not fully RFC-compliant.
Example Call to the Add API
The following curl statement shows an example call to the Add API that includes the proper RFC compliant headers:
curl -X POST -d '{
"merchantNo": "200043",
"storeNo": "300014",
"verifySign": "c29c8240bf99510d4d53a0ca36f9c135", "amount": "13",
"currency": "USD",
"settleCurrency": "USD",
"reference": "test202001011206"
}' 'https://mapi.yuansfer.com/app-instore/v3/add'
The
-d flag tells curl to use the specified JSON data as the request body. The -X POST flag tells curl to perform a POST request. The Content-Length header specifies the length of the request body in bytes. The Transfer-Encoding header specifies that the request body is encoded using chunked encoding.Troubleshooting Steps
If you receive a 411 Error, you can troubleshoot the issue by following these steps:
- 1.Verify that your requests are in compliance with the requirements set out in the necessary RFCs.
- 2.Take note of any HTML message body that's returned in response to your request. A message body often explains exactly how your request is noncompliant.
For more information on RFC compliant headers, please see the following resources:
Last modified 2mo ago