Gift Card SPI

POST Activate Gift Card

POST /merchant/spi/sample/endpoint/spiGiftCard/activateGiftCard

Operation ID: activateGiftCard. Tags: Gift Card SPI.

Activates a new or inactive gift card at the provider with the specified amount. Called when a store associate sells a new gift card or issues a refund to a new card (step 1 of a two-step flow). The response cardNumber should echo back the card number from the request. The providerTransactionId returned must be stored by the platform and passed back in any subsequent void request. On error, set errorCode and errorMessage inherited from SpiPSResponse and leave the data fields unset.

Request body

Media type: application/json. Schema: SpiGiftCardActivateRequest.

Responses

  • default default response.

    Media type: application/json. Schema: SpiGiftCardActivateResponse.