Use Yuansfer APIs to manage and run business including payment, refund, customer
Project description
Yuansfer C# SDK
Requirements
The SDK supports the following versions of Python:
- Python 3 versions 3.4 and later
Installation
Install the latest SDK using pip:
pip install yuansfer
Alternatively in Python 3, you can download or clone the sdk from Python SDK and then install the SDK by running Setuptools in the SDK installation directory:
python setup.py install --user
Usage
First time with Yuansfer? Here’s how to get started:
- Create a Yuansfer Sandbox account. If you don’t have one already, sign up for a sandbox account.
Now let’s call your first Yuansfer API. Create a python new file, and copy the following code into that file:
from yuansfer.client import Client
# Create an instance of the API Client
# and initialize it with the sandbox credentials
client = Client(
environment='sandbox',
merchantNo='{{REPLACE_MERCHANT_NUMBER}}',
storeNo='{{REPLACE_STORE_NUMBER}}',
token='{{REPLACE_TOKEN}}'
)
### 1. Online API
# Get an instance of the Yuansfer Online API you want call
api_online = client.online
# Set request payload
params = {
'amount':'0.01',
'currency':'USD',
'settleCurrency':'USD',
'vendor':'alipay',
'terminal':'ONLINE',
'reference': datetime.now,
'ipnUrl':"http://zk-tys.yunkeguan.com/ttest/test",
'callbackUrl':"http://zk-tys.yunkeguan.com/ttest/test",
'description':'descrip',
'note':'note'
}
# Make a Yuansfer Secure Pay request
result = api_online.secure_pay(params)
# Call the success method to see if the call succeeded
if result.is_success():
# Check if the request is successful
if response.body['ret_code'] == '000100':
# The body property is the resposne from Yuansfer
yuansferResponse = result.body['result']
print(yuansferResponse)
else
print(response.body['ret_msg'])
# Call the error method to see if the call failed
elif result.is_error():
print('Error calling OnlineApi.SecurePay')
errors = result.errors
# An error is returned as a list of errors
for error in errors:
# Each error is represented as a dictionary
for key, value in error.items():
print(f"{key} : {value}")
print("\n")
### 2. Offline API
# Get an instance of the Yuansfer Offline API you want call
api_offline = client.offline
# Set request payload
params = {
'amount':'0.01',
'currency':'USD',
'settleCurrency':'USD',
'reference': datetime.now
}
# Make a Yuansfer Instore Create Transaction QR Code request
result = offline.instore_create_tran_qrcode(params)
# Call the success method to see if the call succeeded
if result.is_success():
# Check if the request is successful
if response.body['ret_code'] == '000100':
# The body property is the resposne from Yuansfer
yuansferResponse = result.body['result']
print(yuansferResponse)
else
print(response.body['ret_msg'])
# Call the error method to see if the call failed
elif result.is_error():
print('Error calling OfflineApi.InstoreCreateTranQrcode')
errors = result.errors
# An error is returned as a list of errors
for error in errors:
# Each error is represented as a dictionary
for key, value in error.items():
print(f"{key} : {value}")
print("\n")
### 3. Mobile API
# Get an instance of the Yuansfer Mobile API you want call
api_mobile = client.mobile
# Set request payload
params = {
'amount':'0.01',
'currency':'USD',
'settleCurrency':'USD',
'reference': datetime.now,
'vendor':'alipay',
'terminal':'APP'
}
# Make a Yuansfer Mobile Prepay request
result = api_mobile.mobile_prepay(params)
# Call the success method to see if the call succeeded
if result.is_success():
# Check if the request is successful
if response.body['ret_code'] == '000100':
# The body property is the resposne from Yuansfer
yuansferResponse = result.body['result']
print(yuansferResponse)
else
print(response.body['ret_msg'])
# Call the error method to see if the call failed
elif result.is_error():
print('Error calling MobileApi.MobilePrepay')
errors = result.errors
# An error is returned as a list of errors
for error in errors:
# Each error is represented as a dictionary
for key, value in error.items():
print(f"{key} : {value}")
print("\n")
### 4. Data Search API
# Get an instance of the Yuansfer Data Search API you want call
api_data_search = client.data_search
# Set request payload
params = {
"transactionNo": "297553638301777927"
}
# Make a Yuansfer Transaction Query request
result = api_data_search.tran_query(params)
# Call the success method to see if the call succeeded
if result.is_success():
# Check if the request is successful
if response.body['ret_code'] == '000100':
# The body property is the resposne from Yuansfer
yuansferResponse = result.body['result']
print(yuansferResponse)
else
print(response.body['ret_msg'])
# Call the error method to see if the call failed
elif result.is_error():
print('Error calling DataSearchApi.TranQuery')
errors = result.errors
# An error is returned as a list of errors
for error in errors:
# Each error is represented as a dictionary
for key, value in error.items():
print(f"{key} : {value}")
print("\n")
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
yuansfer-3.0.0.tar.gz
(18.3 kB
view hashes)
Built Distribution
yuansfer-3.0.0-py3-none-any.whl
(32.3 kB
view hashes)