Skip to main content
POST
/
v3
/
redemptions
/
{redemption}
/
return
Add Reward or Point Return
curl --request POST \
  --url http://localhost/api/v3/redemptions/{redemption}/return \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "<string>",
  "strict": true,
  "amount": 123,
  "meta": [
    "<string>"
  ],
  "transaction_external_id": "<string>",
  "transaction_receipt_ref": "<string>",
  "location_id": 123,
  "strategies": [
    "points"
  ],
  "benefits": [
    {
      "id": 123,
      "handle": "<string>",
      "quantity": 123
    }
  ]
}
'
{
  "data": {
    "id": "<string>",
    "profile_id": "<string>",
    "total_localised": "<string>",
    "total": "<string>",
    "location_id": "<string>",
    "balances": {
      "reward_balance": "<string>",
      "credit_balance": "<string>",
      "point_balance": "<string>",
      "point_balance_dollars": "<string>",
      "benefit_balance": "<string>",
      "combined_balance_dollars": "<string>",
      "localised": {
        "reward_balance": "<string>",
        "point_balance_dollars": "<string>",
        "combined_balance_dollars": "<string>"
      },
      "currency": {
        "id": 123,
        "from": "<string>",
        "to": "<string>",
        "rate": 123,
        "is_system": true,
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    },
    "meta": "<string>",
    "transaction_external_id": "<string>",
    "transaction_receipt_ref": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "location": {
      "id": "<string>",
      "type": "<string>",
      "name": "<string>",
      "description": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "external_id": "<string>",
      "is_published": "<string>",
      "is_permanently_closed": "<string>"
    },
    "currency": {
      "id": 123,
      "from": "<string>",
      "to": "<string>",
      "rate": 123,
      "is_system": true,
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

redemption
integer
required

The redemption ID

Body

application/json
currency
string
strict
boolean
amount
number | null
meta
string[] | null
transaction_external_id
string | null
transaction_receipt_ref
string | null
location_id
integer | null
strategies
enum<string>[]

Default to false

Minimum array length: 1
Available options:
points,
rewards,
benefits,
credits
benefits
object[] | null

Response

Return the redemption.

SuccessfulRedemption

data
SuccessfulRedemption · object
required