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
• * emv_code - provide emv 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
• * limit - control the records show on each page (if not set, default load 40 records)
• * page - control load the number of the page

Operators

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

Example:

• * note - replace special characters to encoded characters:
  • change spaces using "%20"
  • change ">" using "%3E"
  • change "<" using "%3C"

End Point

Variable

Request Header

Body

Response

Success Response - data

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "xXxXxXxXxXXxXx",
                        "user_id": "xXxXxXxXxXXxXx",
                        "company_id": "xXxXxXxXxXXxXx",
                        "store_id": "xXxXxXxXxXXxXx",
                        "gateway_id": 1,
                        "gateway_sub_id": 1,
                        "gateway_sub_name": "Alipay",
                        "gateway_code": "1_1",
                        "barcode_id": "xXxXxXxXxXXxXx",
                        "status": "paid",
                        "amount": "10.00",
                        "currency": "HKD",
                        "charge": 1.20,
                        "refunded": "0.00",
                        "refund_charge": "0.00",
                        "net": "9.75",
                        "tips": "0.00",
                        "forex": 1,
                        "paid_at": "2018-11-20 14:06:45",
                        "can_settle_after": "2018-11-21 00:00:00",
                        "is_balance_settled": true,
                        "settled_at": "",
                        "transaction_id": "xXxXxXxXxXXxXx",
                        "reference_id": "xXxXxXxXxXXxXx",
                        "payer": "",
                        "buyer_id": "",
                        "wallet_type": "",
                        "extra_parameters": "{\"extra_1\": \"value_1\", \"extra_2\": \"value_2\", \"extra_3\": \"value_3\", \"extra_4\": \"value_4\"}",
                        "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/xxxxxxxx"
                            },
                            {
                                "rel": "qrcode",
                                "href": "https://api-h2h-staging.yedpay.com/v1/q/alipay/xxxxxxx"
                            }
                        ]
                    },
                ],
                "meta": {
                    "pagination": {
                        "total": 1,
                        "count": 1,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": {
                            "next": "xxxxxx"
                        }
                    }
                }
            }
        

Example Error Response

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