Redeem Rewards

Overview

Once an account holder earns reward points, they can redeem rewards. They can redeem rewards based on the redemption configurations you have added to your card product.

At this time, rewards can be redeemed for statement credit.

Redeem rewards for statement credit

Use the following mutation to redeem rewards for statement credit. If your rewards program has more than one reward redemption configuration, reference the correct REWARD_REDEMPTION_CONFIGURATION_ID to ensure the correct redemption rule is applied:

RedeemRewardsForStatementCredit

Query

mutation RedeemRewards($input: RedeemRewardsForStatementCreditInput!) {
  redeemRewardsForStatementCredit(input: $input) {
    __typename
    ... on RewardPointsTransfer {
      id
      rewardPointsValue {
        currencyCode
        value
      }
      rewardPointsAmount {
        currencyCode
        value
      }
      createdAt
      updatedAt
      ledgers {
        name
      }
      status {
        ... on RewardPointsTransferSuccessStatus {
          status
        }
        ... on RewardPointsTransferFailureStatus {
          status
          statusReasonCode
        }
      }
      activity
      memo
    }
  }
}

Variables

{
  "input": {
    "financialAccountId": "FINANCIAL_ACCOUNT_ID",
    "redemption": {
      "redemptionConfigurationId": "REWARD_REDEMPTION_CONFIGURATION_ID",
      "pointsToRedeem": "REWARD POINTS"
    },
    "memo": "memo",
    "externalTransactionIdentifier": "external-id"
  }
}

⚠️ Please login to execute queries. Visit the dashboard to authenticate.

Result

{
  "data": {
    "redeemRewardsForStatementCredit": {
      "__typename": "RewardPointsTransfer",
      "id": "REWARD_POINTS_TRANSFER_ID",
      "rewardPointsValue": {
        "currencyCode": "USD",
        "value": 100
      },
      "rewardPointsAmount": {
        "currencyCode": "USD",
        "value": 10000
      },
      "createdAt": "2024-06-10T12:34:56Z",
      "updatedAt": "2024-06-10T12:34:56Z",
      "ledgers": [
        {
          "name": "Main Ledger"
        }
      ],
      "status": {
        "__typename": "RewardPointsTransferSuccessStatus",
        "status": "COMPLETED"
      },
      "activity": "REDEMPTION",
      "memo": "memo"
    }
  }
}