Yedpay

Description (Query Transaction of Online Payment)

Action to query transaction of Online Payment. (GET)

End Point

https://api.yedpay.com/v1/online-payment/query

Request Header

# Key Value Description
1 Authorization API-KEY {{api_key}} API Key
2 Content-Type application/x-www-form-urlencoded x-www-form-urlencoded

Query Params

# Name Type Description
1 custom_id String(30) (optional) (require without payment_token) Unique ID Send By Customer, only letters and numbers are accepted. Maximum length: 30
2 payment_token String (optional) (require without custom_id) Token of the online payment

Response

# Name Type Description
1 success Boolean Query Transaction Success or Fail
2 data Array Include transaction's information (status etc..)

Success Response - data

# Name Type Description
1 id String Id of the transaction
2 user_id String Id of the user who create the transaction
3 company_id String Id of the Company
4 store_id String Id of the Store
5 gateway_id Integer Id of the Gateway used to Generate the transaction
6 barcode_id String Id of the Barcode uset to generate the transaction (only apply for alipay Global)
7 status String Status of the transaction
8 amount Float Amount of the transaction
9 currency String Currency of the transaction
10 charge String Total of charge fee for the transaction
11 forex String Forex
12 paid_at String Date when the transaction was paid "YYYY-mm-dd h:i:s"
13 settled_at String Date when the transaction was settled "YYYY-mm-dd h:i:s"
14 transaction_id String Id of the transaction (Gateway)
15 payer String Email of the payer (Alipay Global)
16 extra_parameters String (optional) Custom information send by customer
17 custom_id String (optional) Custom Id Send By Customer
18 fixed_id String (optional) Id of the Fixed Code
19 refunded_at String Date when the transaction was Refunded "YYYY-mm-dd h:i:s"
20 created_at String Date when the transaction was created "YYYY-mm-dd h:i:s"
21 updated_at String Date when the was Updated "YYYY-mm-dd h:i:s"
22 expired_at String (optional) Date when the transaction Expire "YYYY-mm-dd h:i:s"
23 _links Array Include Checkout and QRCode Links:
- checkout
- qrcode
- (alipay online) checkout_wap
- (alipay online) qrcode_wap
24 cancellation_details Array Information of cancellation (request_user_id: The User who sent request,
first_name: First name of the user,
last_name: Last name of the user
remark: reason of the sending request)
25 refund_details Array Information of refund (request_user_id: The User who sent request,
first_name: First name of the user,
last_name: Last name of the user
remark: reason of the sending request)

Example Success Response

            {
                "success": true,
                "data": {
                    "id": "xXxXxXxXxXXxXx",
                    "user_id": "xXxXxXxXxXXxXx",
                    "company_id": "xXxXxXxXxXXxXx",
                    "store_id": "xXxXxXxXxXXxXx",
                    "gateway_id": 1,
                    "barcode_id": "xXxXxXxXxXXxXx",
                    "status": "pending",
                    "amount": "10.00",
                    "currency": "HKD",
                    "charge": 1.20,
                    "forex": 1,
                    "paid_at": "",
                    "settled_at": "",
                    "transaction_id": "251415799855257",
                    "payer": "",
                    "extra_parameters": "{\"old_macdonald\": \"had a farm\", \"chorus_1\": \"E I E I O\",  \"and_on_his_farm\": \"he had a cow\", \"chorus_2\": \"E I E I O\"}",
                    "custom_id": "XxXxXxXxXxXxXxXxXx",
                    "fixed_id": "",
                    "refunded_at": "",
                    "created_at": "2018-11-20 14:06:45",
                    "updated_at": "2018-11-20 14:06:45",
                    "expired_at": "2018-11-21 14:06:45",
                    "_links": [
                        {
                            "rel": "checkout",
                            "href": "https://qr.alipay.com/0ax03657vsedczja7yru8025"
                        },
                        {
                            "rel": "qrcode",
                            "href": "https://api.yedpay.com/v1/q/alipay/aHR0cHM6Ly9xci5hbGlwYXkuY29tL2JheDAzNjI3b3NlZHN6amE3eXJ1ODAyNA__"
                        }
                    ]
                }
            }
        

Error Response - data

# Name Type Description
1 success Boolean False
2 message String Message of the Error
3 status Integer Code Status

Possible Error Message

# Message Follow-up action
1 Online payment not found Payment Token is invaild / No online payment created by the custom id. Provide vaild payment token / custom id
2 Online payment Expired Create new online payment
3 Transaction awaits user payment Wait buyer pay and query again later

Example Error Response

            {
                "success": false,
                "message": "Internal Error",
                "status": 500
            }
        

v1.29.1-20191003 © The Payment Cards Group Limited. All rights reserved.