Sandbox Gateway Domain URL: https://mapi.yuansferdev.com
Production Gateway Domain URL: https://mapi.yuansfer.com
Online Payments API Reference Overview
Read the In-Store Guides and Tutorials
- tutorial
- guide
- digital wallets
SecurePay API
- Use Case: Pockyt Hosted Payments and Pockyt Integrated Payments
- Method: POST
- Endpoint: https://mapi.yuansfer.com/online/v3/secure-pay
Description: SecurePay API serves as the cornerstone endpoint within Pockyt's Online Payment Processing product, catering to all scenarios, encompassing Pockyt Checkout and Server-to-Server Integrated Payments (YIP). Request and response structures can vary according to distinct use cases and implementations, necessitating reference to dedicated tutorials tailored to your desired checkout and payment flows.
Process API
- Use Case: Pockyt Integrated Payments
- Method: POST
- Endpoint: https://mapi.yuansfer.com/online/v3/secure-pay
Description: SecurePay API caters to all online payment scenarios, encompassing Pockyt Checkout and Server-to-Server Integrated Payments (YIP). Request and response structures can vary according to distinct use cases and implementations, necessitating reference to dedicated tutorials tailored to your desired checkout and payment flows.
PrePay API
- Use Case: In-App, Mobile WeChat Payments
- Method: POST
- Endpoint: https://mapi.yuansfer.com/micropay/v3/prepay
Description: The PrePay API is a core element for merchants aiming to enable in-app payments through WeChatPay and AliPay. It supplies values like paymentNonce, paySign, and package parameters, which are necessary tools for seamless implementation within their mobile and native applications.
Register a Customer
- Use Case: Recurring Payments, Loyalty Programs
- Method: POST
- Endpoint: https://mapi.yuansfer.com/v1/customers/create
Description: The Register Customer API enables the generation of new customer profiles and provides a unique Customer Number, which is essential for future interactions with the SecurePay API, particularly in recurring payment workflows.
Retrieve Customer Info
- Use Case: Recurring Payments, Loyalty Programs
- Method: POST
- Endpoint: https://mapi.yuansfer.com/v1/customers/retrieve
Description: The Register Customer API enables the generation of new customer profiles and provides a unique Customer Number, which is essential for future interactions with the SecurePay API, particularly in recurring payment workflows.
Update Customer Info
- Use Case: Recurring Payments, Loyalty Programs
- Method: POST
- Endpoint: https://mapi.yuansfer.com/v1/customers/update
Description: Update Customer Info API is exclusively designed for modifying customer contact information. It serves as a dedicated endpoint for updating customer details such as their contact information. It's important to note that this API is not intended for altering payment credentials, as this functionality should be handled separately through the Update Token API.
PrePay WeChat Mini Payments API
- Use Case: In-App WeChat Mini Payments
- Method: POST
- Endpoint: <https://mapi.yuansfer.com/v1/customers/update>
Description: The PrePay API enables mobile payments specifically tailored for WeChat Mini Programs and In-App solutions. This API handles payment processing seamlessly within the WeChat Mini Program environment, offering a convenient and efficient payment experience for users.