Sign in

v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB
Redemption Order

Redeem points related to a card

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.

post/api/v2/transactions/redemption

Headers

x-vfi-api-idempotencykeystring

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.

Request body

OR

Response

Response for gift card transactions

idstring uuid-flexible

The ID of the transaction.

amountinteger

Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.

balance_amountinteger

Balance amount is the amount remaining on a card or account of cardholder without a decimal place e.g. $1.5 = 150.

The required number of decimal places for a currency code is according to ISO 4217. However the following table takes precedence over ISO 4217:

created_atstring date-time

The time at which the transaction was created.

customerstring

The ID of a customer

merchant_referencestring

A reference specified by the merchant to identify the transaction

invoice_numberstring

Optional. The invoice number to track this payment.

processorstring

The name of the processor used for this transaction

processor_referencestring

Reference identifying the transaction, as provided by the processor.

processor_detailsobject

Stores all details specific for the processor of the transaction.

status'INITIATED' | 'AUTHORIZED' | 'AUTHORIZATION_VOIDED' | 'CANCELLED' | 'CUSTOMER_ACCEPTED' | 'REFUNDED' | 'FAILED' | 'PENDING' | 'DECLINED' | 'SETTLEMENT_CANCELLED' | 'SETTLEMENT_REQUESTED' | 'SETTLEMENT_SUBMITTED' | 'SETTLEMENT_COMPLETED' | 'SETTLEMENT_PARTIAL' | 'SETTLEMENT_DECLINED' | 'VOIDED' | 'UNKNOWN'

The outcome of the payment request.

status_reasonstring

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

reason_codestring

A reason code assigned by the acquiring platform success

arnstring

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring

Authorization code:

  • When the payment is authorized successfully, this field holds the authorization code for the payment.
  • When the payment is not authorized, this field is not returned.
rrnstring

A client (user friendly) identifier for the transaction generated at the outset of a business event. The format will be dependent on the calling system.

A reference supplied by the system retaining the original source information and used to assist in locating that transaction or a copy of the transaction. This value is critical in matching values that are sent to other Payment processors or Acquirers. This value would correspond to the ISO8583 specification as RRN in attribute DE 37, which limits the value to being an alphanumeric value 12 characters.

For the GSC client android application the format will correspond to <strong>YYMMdd<stan 6 digits></strong>.

shopper_interaction'ecommerce' | 'pos' | 'moto' | 'mail_order' | 'cont_auth' | 'telephone_order' | 'unknown'

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth

stannumber

System Trace Audit Number.

promo_codestring

A code defined by the merchant that affects the calculation of the total amount.