Manage Cards

Endpoints

Time to play - access your API using these endpoints:

Overview

There may be a time where you need to update one of your customers personal details to process subsequent REBILLs'. For example, your customers may move house and as such, you need to ensure that you have the latest information on record.

If this happens, you will need to be able to update the token reference - otherwise known as the INIT transaction.

This is where the SUBSCRIPTION_MANAGE comes in. We allow you to update your customers personal details i.e. billing, shipping, customer data and 6012 data for example and update your token references. In fact, we allow you to update any parameter you wish to except the cardnumber and the exp_date. If you want these details updated, please process an UPDATE_BILLING request. For more information, please see here.

We will then go and update your INIT - the token reference - to allow for subsequent REBILLS to be processed.

To complete this, you will need to process an SUBSCRIPTION_MANAGE transaction. Simply populate the subscription_type parameter with SUBSCRIPTION_MANAGE of the authorisation request.

Please see below sample code of an SUBSCRIPTION_MANAGE request.

{
"timestamp":"20190620101530",
"company_id":113,
"company_pass":"password",
"company_mid_id":1045,
"vt":"",
"useragent":"",
"request_hash" : "f0a18260b08a0bfacb.....",
"transaction":{
    "merchant_order_id":"a9f0ce93-6f0d-4a15-a18b-45f1304b4bc0",
    "transaction_type":"AUTH_CAPTURE",
    "amount":"14.99",
    "currency_code_iso3":"GBP",
    "subscription_type":"SUBSCRIPTION_MANAGE",
    "merchant_customer_id":"",
    "merchant_custom_1":"",
    "merchant_custom_2":"",
    "merchant_custom_3":""
    },
"customer" : {
    "customer_fname":"Edward",
    "customer_lname":"Johnson",
    "customer_ipaddress":"127.0.0.1",
    "customer_dob":"1988-10-03"
    },
"billing" : {
    "cardholder_name":"",
    "cardnumber":4000011180138710,
    "cardcvv":123,
    "card_exp":"022020",
    "billing_street":"Suite 2, 4th Floor",
    "billing_street2":"44 Baker Street",
    "billing_city":"London",
    "billing_state":"",
    "billing_zipcode":"W1U7AL",
    "billing_country_code_iso2":"GB",
    "billing_phone":"+44(0)2039826580",
    "billing_email":"support@acquired.com"
    },
"shipping" : {
    "shipping_street":"Suite 2, 4th Floor",
    "shipping_street2":"44 Baker Street",
    "shipping_city":"London",
    "shipping_state":"",
    "shipping_zipcode":"W1U7AL",
    "shipping_country_code_iso2":"GB",
    "shipping_phone":"+44(0)2039826580",
    "shipping_email":"support@acquired.com"
    },
}

Request Parameters

The table below details the parameters that must be submitted in order to update your token reference - the INIT.

Parameter Format Length Description
subscription_type string 4 - 14 Set value to: SUBSCRIPTION_MANAGE.
This instructs us to update the already stored card and customer data associated with a token reference if the transaction is successfully authorised with the cardholders issuing bank.
Acceptable Characters: a-Z A-Z _
Hey - Does doing this automatically sound good to you - ensuring that all your tokens with us are all up to date with the latest information. Send a message to the Support Team and learn all about our Account Updater solution.

Response

{
  "timestamp": "20200602090551",
  "response_code": "1",
  "response_message": "Transaction Success",
  "company_id": "744",
  "mid": "1330",
  "transaction_id": "312791",
  "transaction_type": "SUBSCRIPTION_MANAGE",
  "bank_response_code": "00",
  "response_hash": "5480140a716fafc0e83ab06b50c5e7cefff8c1c13080e6a16673e15133ec52a2"
}

Response Parameters

Parameter Format Length Description
timestamp date 14 Date and time of transaction submission.
response_code int 1-3 Transaction result code.
response_message string 1-100 Transaction result text.
company_id int 1-11 API Company ID we issue to merchants, repeated from the request message.
mid int 1-11 MID_ID the transaction was processed through.
transaction_id int 1-10 Unique ID we generate to identify the transaction.
transaction_type string 1-20 The transaction type being performed.
bank_response_code int 2 Transaction result code communicated by the issuing bank.
response_hash string 64 Verification hash value.

Enable/Disable Tokens

This feature allows you to disable a token from being used in any future ACCOUNT_UPDATER, REBILL, REUSE and UPDATE_BILLING requests. In order to disable a token, simply set the transaction_type to SUBSCRIPTION_MANAGE, populate the token reference you would like to diable in the original_transaction_id and then set the subscription_type to DISABLE. In order to re-enable a token, repeat the exact same steps outlined above, except this time set the subscription_type to ENABLE.

Request

{
 "timestamp":"20170612200234",
 "company_id":"133",
 "company_pass":"password",
 "company_mid_id":"",
 "request_hash":"f0a18260b08a0bfacb...",
 "transaction":{
   "merchant_order_id":"20170612200234",
   "transaction_type":"SUBSCRIPTION_MANAGE",
   "original_transaction_id":"1234567",
   "subscription_type":"DISABLE"
 }
}

Request Parameters

The table below details the parameters that can be submitted in order to enable/disable your token reference - the INIT.

Parameter Format Length Description
timestamp
Required
date 14 Date and time of transaction submission.
Acceptable Characters: 0-9 in the format yyyymmddhhmmss
company_id
Required
int 1-11 API Company ID we issue to merchants.
Acceptable Characters: 0-9
company_pass
Required
string 10-30 API Password we issue to merchants.
Acceptable Characters: 0-9 a-z A-z
company_mid_id int 1-11 Targets a specific mid_id within the company structure. Leave it blank (or don't pass it) to balance traffic across multiple mid_ids (banks).
Acceptable Characters: 0-9
request_hash
Required
string 64 Verification hash value.
Acceptable Characters: 0-9 a-z A-z _ -
transaction object
merchant_order_id string 1-50 Unique ID you’ll use to identify each transaction, repeated from the request.
Acceptable Characters: a-z A-Z 0-9 _ -
transaction_type
Required
string 1-20 Transaction type is SUBSCRIPTION_MANAGE.
Acceptable Characters: a-z A-Z _
original_transaction_id
Required
int 1-10 Transaction_id value we generated and returned in the original request.
Acceptable Characters: 0-9
subscription_type string 4 - 14 Set value to: ENABLE / DISABLE.
This instructs us to either disable / enable the already stored card and customer data associated with a token reference
Acceptable Characters: a-Z A-Z _

Response

{
  "timestamp":"20200708131405",
  "response_code":"1",
  "response_message":"Transaction Success",
  "company_id":"272",
  "mid":"1320",
  "transaction_id":"316790",
  "transaction_type":"SUBSCRIPTION_MANAGE",
  "bank_response_code":"",
  "response_hash":"f7f67bf16c22a93cd21c3a6251759ba85b8af870f39e856531c2d8ff2331647d"
}

Response Parameters

Parameter Format Length Description
timestamp date 14 Date and time of transaction submission.
response_code int 1-3 Transaction result code.
response_message string 1-100 Transaction result text.
company_id int 1-11 API Company ID we issue to merchants, repeated from the request message.
mid int 1-11 MID_ID the transaction was processed through.
transaction_id int 1-10 Unique ID we generate to identify the transaction.
transaction_type string 1-20 The transaction type being performed.
bank_response_code int 2 Transaction result code communicated by the issuing bank.
response_hash string 64 Verification hash value.