Redemption Order

Redeem points related to a card

post

https://emea.gsc.verifone.cloud/oidchttps://us.gsc.verifone.cloud/oidchttps://nz.gsc.verifone.cloud/oidchttps://cst.test-gsc.vfims.com/oidchttps://uscst-gb.gsc.vficloud.net/oidc

/api/v2/transactions/redemption

Redeem points that is related to a given card. Redemptions on this endpoint will not be seen as a financial operation, but an order request to update the points used. This operation is currently only supported for Amex Pay with Points.

Authorizations

BearerAuthBasicAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-vfi-api-idempotencykeystringOptional

Example: 63bbc548-d2de-4546-b106-880a5018461c

A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.

Body

application/json

or

Responses

201

Response for gift card transactions

application/json

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/api/v2/transactions/redemption

HTTPcURLJavaScriptPython

POST /oidc/api/v2/transactions/redemption HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 651

{
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "card_brand": "text",
  "amount": 0,
  "currency_code": "AED",
  "pay_with_points": {
    "enabled": false,
    "points_type": "AMEX",
    "points_transaction_reference": "text",
    "points_transaction_reference_type": "text",
    "points_to_redeem": "text",
    "total_basket_amount": 1
  },
  "merchant_reference": "7a1db7a8-6f24-4bc5-a51b-cef33fc05140",
  "shopper_interaction": "ECOMMERCE",
  "invoice_number": "text",
  "encrypted_card": "U3dhZ2dlciByb2Nrcw==",
  "public_key_alias": "text",
  "token_preference": {
    "token_scope": "0e48425a-f1bc-431a-b7d8-f866de8ba276",
    "reuse_token_type": "INTERNAL",
    "token_type": "REUSE",
    "token_expiry_date": "2026-06-12"
  }
}

{
  "id": "text",
  "amount": 0,
  "balance_amount": 1,
  "detailed_points": {
    "points_type": "AMEX",
    "balance_points": "text",
    "identifier": "text",
    "points_transaction_reference": "text",
    "points_transaction_reference_type": "text",
    "points_conversion_rate": 1,
    "min_reward_amount": 1,
    "max_reward_amount": 1
  },
  "created_at": "2026-06-12T17:03:58.525Z",
  "customer": "text",
  "merchant_reference": "text",
  "invoice_number": "text",
  "processor": "text",
  "processor_reference": "text",
  "processor_details": {},
  "status": "AUTHORIZED",
  "status_reason": "text",
  "reason_code": "text",
  "arn": "text",
  "authorization_code": "5B1D4C",
  "rrn": "200211654321",
  "shopper_interaction": "ecommerce",
  "stan": 1,
  "promo_code": "text",
  "token_details": {
    "reuse_token": "text",
    "reuse_token_type": "CHASE",
    "analytics_token": "text",
    "token_expiry_date": "2026-06-12",
    "token_scope": "123e4567-e89b-12d3-a456-426614174000",
    "token_status": "DELETED",
    "created_at": "2026-06-12",
    "updated_at": "2026-06-12",
    "variant": "NEW_WORLD",
    "type": "CREDIT",
    "issuer_name": "HSBC",
    "issuer_country": "ZZZ",
    "brand": "VISA",
    "expiry_year": 2021,
    "expiry_month": 12,
    "card_holder_name": "MR J HOLDER",
    "last_four": "3127",
    "bin": "492912",
    "currency_code": "AED"
  },
  "card_details": {
    "masked_card_number": "520000****1096",
    "expiry_month": "12",
    "expiry_year": "2024"
  },
  "additional_data": {
    "acquirer_response_code": "0000",
    "acquirer_response_message": "text",
    "acquirer_authorizing_network_id": "text",
    "acquirer_authorizing_network_id_descriptor": "text",
    "settlement_date": "2026-06-12",
    "issuer_receipt_text": "text"
  }
}