Yedpay

Description (User's Transaction List)

Show the list of Transactions related with the user. (GET)

Can include the parameter "include" in the url to get more information:

  • * store - provide store related with the transaction
  • * fixed_code - provide fixed code related with the transaction

Queries

In order to search Transactions you can add in the url the follow parameters.

  • * id - id of the transaction
  • * user_id - User Id who create the transaction
  • * company_id - Company id where the transaction was created
  • * store_id - Store id where the transaction was created
  • * gateway_id - gateway Id used to create the transaction
  • * barcode_id - Id of the barcode (if exists)
  • * fixed_id - Id of the fixed code (if exists)
  • * status - Status of the transaction
  • * amount - Amount of the transaction
  • * currency - Currency of the transaction
  • * charge - Charge of the transaction
  • * paid_at - date when the transaction was paid
  • * settled_at - date when the transaction was settled
  • * transaction_id - external id generated by the gateway
  • * custom_id - Custom Identifier sent by user
  • * refunded_at - date when the transaction was refunded
  • * created_at - date when the transaction was created
  • * updated_at - date when the transaction was updated

Operators

  • * "=" - the result is equal to
  • * ">" - the result is bigger than
  • * "<" - the result is less than

Example:

https://api.yedpay.com/v1/users/{{user_id}}/transactions?include=store&created_at>2017-09-12%2016:00:00
  • * note - change spaces using "%20"

End Point

https://api.yedpay.com/v1/users/{{user_id}}/transactions

Variable

# Name Type Description
1 user_id String User's ID

Request Header

# Key Value Description
1 Authorization Bearer {{access_token}} Login Token

Body

# Name Type Description

Response

# Name Type Description
1 success Boolean Request Transaction List Success or Fail
2 data Array Include all Transaction's Information (transaction_id, amount, rate etc..)

Success Response - data

# Name Type Description
1 id String Id of the Transaction
2 user_id String Id of the User
3 company_id String Id of the Company
4 store_id String Id of the Store
5 gateway_id Integer Id of the Gateway (1 - Alipay, 2 - UnionPay, 4 - Alipay Online, 7 - Cybersource, 8 - WeChat Pay)
6 barcode_id String Id of the Barcode
7 status String Status of the Transaction
8 amount String Amount of the Transaction
9 net String Net Amount of the Transaction
10 currency String Currency of the Transaction
11 charge Float Charge of the Transaction
12 forex Integer Forex of the Transaction
13 paid_at String Date of the Payment
14 settled_at String Date of the Settlement
15 transaction_id String Unique transaction identifier of Yedpay
16 payer String Payer of the Transaction
17 refunded_at String Refunded Date
18 created_at String Created Date
19 updated_at String Updated Date
20 extra_parameters String (optional) Custom information send by customer
21 custom_id String (optional) Custom Id Send By Customer
22 fixed_id String (optional) Id of the Fixed Code
23 _links String Include Links for:
- transaction
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": "wDpWkapx",
                        "user_id": "98p5OrMJ",
                        "company_id": "qQvy0rl3",
                        "store_id": "qnvwOv0g",
                        "gateway_id": 1,
                        "gateway_sub_id": 1,
                        "gateway_sub_name": "Alipay",
                        "gateway_code": "1_1",
                        "barcode_id": "",
                        "status": "paid",
                        "amount": "10.00",
                        "currency": "HKD",
                        "charge": 0.25,
                        "net": "9.75",
                        "forex": 1,
                        "paid_at": "2017-10-24 17:14:48",
                        "settled_at": "",
                        "transaction_id": "150883628910005",
                        "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": "",
                        "payer": "",
                        "refunded_at": "",
                        "created_at": "2017-10-24 17:11:29",
                        "updated_at": "2017-10-24 17:12:05",
                        "_links": [
                            {
                                "rel": "checkout",
                                "href": "http://192.168.10.11/p/wDpWkapx"
                            },
                            {
                                "rel": "qrcode",
                                "href": "http://192.168.10.11/q/alipay/wDpWkapx"
                            }
                        ]
                    },
                    {
                        "id": "38DF7DF",
                        "user_id": "6ER9JDOP",
                        "company_id": "DSMF74PJO",
                        "store_id": "DKFJP8XC7",
                        "gateway_id": 1,
                        "gateway_sub_id": 1,
                        "gateway_sub_name": "Alipay",
                        "gateway_code": "1_1",
                        "barcode_id": "",
                        "status": "cancelled",
                        "amount": "1.00",
                        "currency": "HKD",
                        "charge": "0.10",
                        "net": "0.90",
                        "forex": 1,
                        "paid_at": "",
                        "settled_at": "",
                        "transaction_id": "152539227370126",
                        "reference_id": "",
                        "payer": "",
                        "buyer_id": "",
                        "wallet_type": "",
                        "extra_parameters": "",
                        "custom_id": "",
                        "fixed_id": "",
                        "refunded_at": "",
                        "created_at": "2018-08-30 09:57:52",
                        "updated_at": "2018-08-30 10:05:33",
                        "_links": [
                            {
                                "rel": "checkout",
                                "href": "http://192.168.10.11/p/38DF7DF"
                            },
                            {
                                "rel": "qrcode",
                                "href": "http://192.168.10.11/q/alipay/38DF7DF"
                            }
                        ],
                        "cancellation_details": {
                            "request_user_id": "",
                            "first_name": "",
                            "last_name": "",
                            "remark": "Close Pending Transaction after 24 hours"
                        }
                    },
                    {
                        "id": "8DF874PD",
                        "user_id": "6ER9JDOP",
                        "company_id": "DSMF74PJO",
                        "store_id": "DKFJP8XC7",
                        "gateway_id": 1,
                        "gateway_sub_id": 1,
                        "gateway_sub_name": "Alipay",
                        "gateway_code": "1_1",
                        "barcode_id": "",
                        "status": "refunded",
                        "amount": "1.00",
                        "currency": "HKD",
                        "charge": "0.10",
                        "net": "0.90",
                        "forex": 1,
                        "paid_at": "2018-08-29 18:55:29",
                        "settled_at": "",
                        "transaction_id": "154564657783914",
                        "reference_id": "75827463",
                        "payer": "",
                        "buyer_id": "",
                        "wallet_type": "",
                        "extra_parameters": "",
                        "custom_id": "",
                        "fixed_id": "",
                        "refunded_at": "2018-08-29 19:04:21",
                        "created_at": "2018-08-29 19:02:47",
                        "updated_at": "2018-08-29 19:04:21",
                        "_links": [
                            {
                                "rel": "checkout",
                                "href": "http://192.168.10.11/p/8DF874PD"
                            },
                            {
                                "rel": "qrcode",
                                "href": "http://192.168.10.11/q/alipay/8DF874PD"
                            }
                        ],
                        "refund_details": {
                            "request_user_id": "6ER9JDOP",
                            "first_name": "xxxxxxxxxxxxxx",
                            "last_name": "xxxxxxxxxxxxxx",
                            "remark": "damaged product"
                        }
                    },
                ],
                "meta": {
                    "pagination": {
                        "total": 3,
                        "count": 3,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": {
                            "next": "http://192.168.10.11/api/companies/qQvy0rl3/transactions?page=2&"
                        }
                    }
                }
            }
        

Example Error Response

            {
                "success": false,
                "message": "Unauthenticated.",
                "status": 500
            }
        

v1.30.0-20191113 © The Payment Cards Group Limited. All rights reserved.