Transaction creation service

Call details#

  • Resource: /v1/store
  • HTTP Method: POST
  • Request format: JSON
  • Response format: JSON
  • Header parameters:
    • Content-Type: application/json
    • merchant_id: {your merchant id}
    • merchant_key: {your merchant key}

Calling this service is mandatory in the JavaScript store flow.

Request parameters#

The following request parameters must be sent:

ParameterDescriptionFormatMandatory
merchant_usnUnique sequential number generated by the merchant.< 12 NYES
customer_idCustomer identification for card storage.< 20 ANYES

Response parameters#

In the table below is the description of the response parameters:

ParameterDescriptionFormat
codeCarat Portal response code. Any code different from 0 (zero) means failure. Learn more.< 4 N
messageCarat Portal response message.< 500 AN
store
statusStatus of the storage transaction on Carat Portal. Learn more.= 3 AN
nsuaUnique sequential number of the storage transaction on Carat Portal.= 15 AN
nitaEncrypted store transaction identifier number returned to the store by Carat Portal.= 65 AN
merchant_usnUnique sequential number generated by the merchant.< 12 N
customer_idCustomer identification for card storage.< 20 AN
store_tokenToken related to the JavaScript store.= 66 AN

Response codes

See reference on API codes - response codes