--- title: List Rewards slug: mihai-tests/list-rewards createdAt: 2025-05-02T10:16:35.486Z --- { "id": "5H7s9y8kWoWJOZACL_XEe", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.sandbox.tripleup.dev/partner/rewards", "servers": [ { "url": "https://api.sandbox.tripleup.dev/partner/rewards", "description": "triple Sandbox" } ], "name": "List Rewards", "description": "Lists Rewards and associated Transaction details that triple has matched\nto active Offers in the last 90 days.\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "status", "type": "object", "description": "", "schema": [], "complexItems": [ { "name": "object", "schema": [] }, { "name": "object", "schema": [], "modelRef": "#/components/schemas/RewardStatus", "customType": "RewardStatus" } ], "complexType": "allOf" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "Rewards", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "rewards", "kind": "required", "type": "array", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "card_bin", "kind": "optional", "type": "string", "description": "The Bank Identification Number (BIN) of a payment card.\n", "example": "444789", "modelRef": "#/components/schemas/CardBIN", "customType": "CardBIN", "schema": [] }, { "name": "card_last_4", "kind": "optional", "type": "string", "description": "The last four digits of the Primary Account Number (PAN) of\na card.\n", "example": "0001", "modelRef": "#/components/schemas/CardLast4", "customType": "CardLast4", "schema": [] }, { "name": "merchant_complete_address", "kind": "optional", "type": "string", "description": "The complete delivery address, composed from the Address properties.\n", "example": "7370 BAKER ST, STE 100\nPITTSBURGH, PA 15206", "modelRef": "#/components/schemas/CompleteAddress", "customType": "CompleteAddress", "schema": [] }, { "name": "merchant_name", "kind": "required", "type": "string", "description": "The (doing-business-as) name of the Merchant.", "modelRef": "#/components/schemas/MerchantAssumedName", "customType": "MerchantAssumedName", "schema": [] }, { "name": "offer_external_id", "kind": "optional", "type": "object", "description": "Partner-provided, external ID for an Offer.\n\nExternal IDs should be **stable** and **never sensitive**.\n\nExternal IDs do not need to be globally unique, but we encourage\nthe use of UUIDs. They must be unique for the Offer within\nthe scope of its parent Content Provider.\n\nTo protect against accidental inclusion of sensitive personal\ninformation, external IDs may not be 9-digit numbers or use the\nUS Tax ID format (###-##-####).\n", "modelRef": "#/components/schemas/OfferExternalId", "customType": "OfferExternalId", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "ExternalId", "description": "", "modelRef": "#/components/schemas/ExternalId", "schema": [] } ] }, { "name": "offer_headline", "kind": "optional", "type": "string", "description": "The headline or title for the offer, appropriate for top-level\ndisplay.\n", "modelRef": "#/components/schemas/OfferHeadline", "customType": "OfferHeadline", "schema": [] }, { "name": "offer_id", "kind": "required", "type": "string", "description": "The triple-defined ID for the entity.", "example": "triple-abc-123", "modelRef": "#/components/schemas/EntityId", "customType": "EntityId", "schema": [] }, { "name": "reward_id", "kind": "required", "type": "string", "description": "The triple-defined ID for the entity.", "example": "triple-abc-123", "modelRef": "#/components/schemas/EntityId", "customType": "EntityId", "schema": [] }, { "name": "reward_amount", "kind": "optional", "type": "number", "description": "The calculated reward amount for this Transaction and Offer.\n\nThis field may be negative if the Transaction is a Return that\nhas resulted in an adjustment to a previous reward.\n", "modelRef": "#/components/schemas/RewardAmount", "customType": "RewardAmount", "schema": [] }, { "name": "reward_currency_code", "kind": "optional", "type": "string", "description": "3-character ISO-4217 currency code. Only USD is currently supported.\n\nContact your Triple representative for support with additional\ncurrencies. Note that some values are not supported, particularly\ntest and fund codes.\n", "example": "USD", "default": "USD", "modelRef": "#/components/schemas/CurrencyCode", "customType": "CurrencyCode", "schema": [] }, { "name": "status", "kind": "required", "type": "string", "description": "The Reward status.\n\n- `REJECTED` - The Transaction did not meet the offer terms.\n- `PENDING_REVIEW` - The Transaction is pending a manual review.\n The reward may be deleted if it is determined to be an invalid\n match to this merchant's offer.\n- `PENDING_MERCHANT_APPROVAL` - The Transaction is waiting for the\n Merchant or Content Provider to approve or deny the Reward.\n- `DENIED_BY_MERCHANT` - The Merchant or Content Provider denied\n the Reward. A reason will be included in `reward_details`.\n- `PENDING_MERCHANT_FUNDING` - The Reward was approved and is\n awaiting funding by the Merchant.\n- `PENDING_TRANSFER_TO_PUBLISHER` - The Reward is funded and funds\n are awaiting distribution to the Publisher.\n- `DISTRIBUTED_TO_PUBLISHER` - Reward funds have been sent to the\n Publisher.\n- `DISTRIBUTED_TO_CARDHOLDER` - The Publisher has reported that the\n Reward has been given to the cardholder.\n", "modelRef": "#/components/schemas/RewardStatus", "customType": "RewardStatus", "schema": [] }, { "name": "transaction_amount", "kind": "required", "type": "object", "description": "The amount of the transaction. An error will be returned if the\nfield contains fractional amounts smaller than those allowed by the\ntransaction's currency code.\n", "example": 12, "modelRef": "#/components/schemas/TransactionAmount", "customType": "TransactionAmount", "schema": [] }, { "name": "transaction_currency_code", "kind": "required", "type": "string", "description": "3-character ISO-4217 currency code. Only USD is currently supported.\n\nContact your Triple representative for support with additional\ncurrencies. Note that some values are not supported, particularly\ntest and fund codes.\n", "example": "USD", "default": "USD", "modelRef": "#/components/schemas/CurrencyCode", "customType": "CurrencyCode", "schema": [] }, { "name": "transaction_id", "kind": "required", "type": "string", "description": "The triple-defined ID for the entity.", "example": "triple-abc-123", "modelRef": "#/components/schemas/EntityId", "customType": "EntityId", "schema": [] }, { "name": "transaction_timestamp", "kind": "required", "type": "object", "complexType": "allOf", "complexItems": [ { "name": "Timestamp", "description": "", "modelRef": "#/components/schemas/Timestamp", "schema": [] } ], "schema": [] } ] }, { "name": "total", "kind": "required", "type": "number", "description": "The total number of rewards.", "example": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "TripleBadRequestError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request is malformed." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "403", "description": "TripleNotAuthenticatedError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "Client authentication failed." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "TripleInvalidPathError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The url path or path parameter is invalid." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "409", "description": "TripleIntegrityError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request was well-formed but violated entity integrity constraints." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "415", "description": "TripleUnsupportedMediaType", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request defined an unsupported media type." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "422", "description": "TripleUnprocessableEntity", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request was well-formed but could not be processed." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "500", "description": "TripleInternalServerError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "Triple was unable to process the request due to an internal error." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "501", "description": "TripleNotImplementedError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request failed because it requires a feature that is not yet implemented." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "503", "description": "TripleServiceUnavailable", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request failed due to a triple service interruption." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.sandbox.tripleup.dev/partner/rewards?status=object' \\\n --header 'accept: application/json'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.sandbox.tripleup.dev/partner/rewards?status=object\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.sandbox.tripleup.dev/partner/rewards?status=object\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.sandbox.tripleup.dev/partner/rewards?status=object\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Rewards\n{\n \"rewards\": [\n {\n \"card_bin\": \"444789\",\n \"card_last_4\": \"0001\",\n \"merchant_complete_address\": \"7370 BAKER ST, STE 100\\nPITTSBURGH, PA 15206\",\n \"merchant_name\": \"\",\n \"offer_external_id\": {},\n \"offer_headline\": \"\",\n \"offer_id\": \"triple-abc-123\",\n \"reward_id\": \"triple-abc-123\",\n \"reward_amount\": 0,\n \"reward_currency_code\": \"USD\",\n \"status\": \"\",\n \"transaction_amount\": {},\n \"transaction_currency_code\": \"USD\",\n \"transaction_id\": \"triple-abc-123\",\n \"transaction_timestamp\": {}\n }\n ],\n \"total\": 0\n}" }, { "id": "response-1-400", "language": "400", "code": "// TripleBadRequestError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-2-403", "language": "403", "code": "// TripleNotAuthenticatedError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-3-404", "language": "404", "code": "// TripleInvalidPathError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-4-409", "language": "409", "code": "// TripleIntegrityError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-5-415", "language": "415", "code": "// TripleUnsupportedMediaType\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-6-422", "language": "422", "code": "// TripleUnprocessableEntity\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-7-500", "language": "500", "code": "// TripleInternalServerError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-8-501", "language": "501", "code": "// TripleNotImplementedError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-9-503", "language": "503", "code": "// TripleServiceUnavailable\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "id": "lIpxLSVgSWPcjCVhEQJbC", "type": "paragraph", "children": [ { "text": "Lists Rewards and associated Transaction details that triple has matched\nto active Offers in the last 90 days." } ] } ] }