Response

5.3 Response

Sample Response

Below is a sample response of a get request, limit=2. Notice has_next_page is true, meaning there are still existing results that need to be requested. You should query again with the after param to fetch the next page using after=WyIyMDIyLTAyLTI0VDE2OjAwOjI3Ljg1OCswODowMCIsInRyYW5zYWN0aW9uXzFkYWFlZWVkLTAyNTAtNDljOS1iZDNiLWE1ODc5NzhlZGE2OCJd. And repeat until has_next_page is false.

Note that for bank_statement_id, it is a random string of characters. Please do not try to validate the format of characters for bank_statement_id.

There might be multiple items that have the bank_statement_id, but the total amount reflected in the bank account should be the sum of all the values with the same bank_statement_id

{
  "data": [
            {
               "object": "transaction",
               "id": "transaction_d12fb0b1-7879-456b-bd9b-3c3238a95935",
               "campaign_id": "campaign_064ef9cc-5c46-4dc7-97d6-fb4564f65fde",
               "transaction_type": "redeem",
               "value": 50,
               "metadata": null,
               "merchant_id": "merchant_e80a15a6-b921-4361-9ede-41d93853e6c2",
               "merchant_name": "Chocolate Shop 1",
               "created_at": "2022-02-24T01:01:03.192+08:00",
               "updated_at": "2022-02-24T01:02:42.059+08:00",
               "verifier_id": "user_56c24900-52e2-4474-a17b-90b8086ef4db",
               "verifier_name": "Ivan",
               "bank_statement_id": "payout_IdtYK5xraxgmxQ4lkbaDw"
            },
            {
               "object": "transaction",
               "id": "transaction_1daaeeed-0250-49c9-bd3b-a587978eda68",
               "campaign_id": "campaign_064ef9cc-5c46-4dc7-97d6-fb4564f65fde",
               "transaction_type": "redeem",
               "value": 20,
               "metadata": null,
               "merchant_id": "merchant_e80a15a6-b921-4361-9ede-41d93853e6c2",
               "merchant_name": "Chocolate Shop 1",
               "created_at": "2022-02-24T16:00:27.858+08:00",
               "updated_at": "2022-02-25T00:02:45.940+08:00",
               "verifier_id": "user_56c24900-52e2-4474-a17b-90b8086ef4db",
               "verifier_name": "Ivan",
               "bank_statement_id": "ABCDEFxraxgmxQ4lkbaDw"
           },
           {
               "object": "transaction",
               "id": "transaction_2daaeeed-0250-49c9-bd3b-a587978eda68",
               "campaign_id": "campaign_064ef9cc-5c46-4dc7-97d6-fb4564f65fde",
               "transaction_type": "redeem",
               "value": 40,
               "metadata": null,
               "merchant_id": "merchant_e80a15a6-b921-4361-9ede-41d93853e6c2",
               "merchant_name": "Chocolate Shop 1",
               "created_at": "2022-02-24T16:00:27.858+08:00",
               "updated_at": "2022-02-25T00:02:45.940+08:00",
               "verifier_id": "user_56c24900-52e2-4474-a17b-90b8086ef4db",
               "verifier_name": "Ivan",
               "bank_statement_id": "ABCDEFxraxgmxQ4lkbaDw"
           }
	  ],
  "page_info": {
      "has_next_page": true,
      "has_previous_page": false,
      "start_cursor": "WyIyMDIyLTAyLTI0VDAxOjAxOjAzLjE5MiswODowMCIsInRyYW5zYWN0aW9uX2QxMmZiMGIxLTc4NzktNDU2Yi1iZDliLTNjMzIzOGE5NTkzNSJd",
      "end_cursor": "WyIyMDIyLTAyLTI0VDE2OjAwOjI3Ljg1OCswODowMCIsInRyYW5zYWN0aW9uXzFkYWFlZWVkLTAyNTAtNDljOS1iZDNiLWE1ODc5NzhlZGE2OCJd"
  }
}

Response Format

The response will include data which is an array of transaction objects.

Property	Type	Description
object	String	Value will be “transaction”.
id	String	Transaction id.
campaign_id	String	Campaign id.
transaction_type	String	Value will be “redeem”.
value	Number	Value of the transaction.
metadata	String	Null
merchant_id	String	Merchant id.
merchant_name	String	Merchant name.
created_at	String (ISO8601)	Datetime transaction was created.
updated_at	String (ISO8601)	Datetime transaction was updated (when assigned a payout)
verifier_id	String	User id that verified the transaction, which will be the API key user for supermarket merchants.
verifier_name	String	User name of the verifier.
bank_statement_id	String	Null

It will also include page_info which contains the following.

Property	Type	Description
has_next_page	Boolean	Indicator if there is a next page.
has_previous_page	Boolean	Indicator if there is a previous page.
start_cursor	String	Encoded string to indicate the reference starting point of the page. Similar behavior as typical paginated api.
end_cursor	String	Encoded string to indicate the reference ending point of the page. Similar behavior as typical paginated api. Can be supplied into the after query parameter to retrieve the next page.