Create Certificate – UNDER CONSTRUCTION

Create Certificate creates a certificate for a customer on behalf of a partner. The certificate will belong to the “TO” user when “SEND_TO_ME” is “N”. When “Y”, the certificate belongs to the “FROM” user. This service requires a POST using JSON for both the request parameters and results.

Version

1.0

URL

https://www.giftrocker.com/services/createcert/

Request Parameters

  • partner – required – partner hash generated by GiftRocker during services registration.
  • password – required – partner password created during services registration.
  • version – required – version of service requested.
  • offering_id – required – offering id received after call to offerings for shop. It represents what is being purchased.
  • location_id – optional – if multi location shop
  • promo_code – optional – if applicable, matches promotion code created by shop
  • units – required – value is 1 unless offering units_ind = Y, then units = 1 to units_max.
  • amount – required – list price; value of certificate after sale.
  • tip_amount – required – default 0.
  • markup_amount – required – default 0.
  • cc_amount – required – amount + markup + tip = cc_amount.
  • personalization – optional – note with gift.
  • send_to_me – required – Y/N indicator should ownership go to To user or From user
  • to_partner_user – mixed – if send_to_me = N, required. to_partner_user is the partner’s user reference. This could be anything but will most likely be an email or an integer.
  • to_first_name – optional
  • to_last_name – optional
  • to_email – if send to self, not required.
  • from_partner_user – required – from_partner_user is the partner’s user reference. This could be anything but will most likely be an email or an integer.
  • from_first_name – optional.
  • from_last_name – optional.
  • from_email – required.
  • bill_first_name – optional matches credit card.
  • bill_last_name – optional.
  • bill_address – optional – 60 character billing address.
  • bill_city – optional – 40 character billing city.
  • bill_state – optional – 2 character billing state.
  • bill_zip – required – billing zip
  • cc_number – required – please pre-validate number.
  • cc_expiration – required – MMYY format.
  • cc_cvv – required – number on the back of the credit card (front of AMX).
  • opt_in – optional – Y/N indicator that customer is ok with future deals and offers from the shopkeeper.
  • giftrocker_terms – required – Y/N indicator that customer must accept GiftRocker terms (or agreed upon joint terms).

Results

  • name – name of service: CreateCert
  • status – result outcome from the service with possible values: GOOD, ERROR or INFORMATION.
  • detail – if status is ERROR or INFORMATIONAL, detail contains further information.
  • payload – JSON object containing the response if the service call was successful.

Payload details

  • certificate – JSON object holding resulting certificate if transaction was a success. More…

Example

"name":"CreateCert",
"status":"GOOD",
"detail":"",
"payload": {
    "certificate":{more...}
   }

Comments are closed.