API End Point

• https://air.veritrans.co.jp/vtdirect

EndPoint for each API

• /v1/veritrans.min.js
• /v1/charges
• /v1/recharges
• /v1/creditcard/list
• /v1/creditcard/destroy
• /v1/capture
• /v1/search
• /v1/status
• /v1/void
• /v1/mpi_charges
• /v1/tokens
• /v1/cvs

Response Patterns

failure error samples

{
  "data": {
    "order_id": "TEST0005",
    "gross_amount": 1980,
    "card_number": "4111XXXXXXXXXX11",
    "with_capture": false
  },
  "mstatus": "failure",
  "vresult_code": "NH18000000000000",
  "code": "Q001",
  "status": "failure",
  "message": "[Order already succeeded]",
  "errors": [
    "Order already succeeded"
  ]
}

fatal error sample

{
  "code": "Q099",
  "status": "fatal",
  "message": "Fatal error, please contact veriTrans"
}

Contents of successful response

When register is disabled

{
  "data": {
    "order_id": "TEST0004",
    "gross_amount": 1980,
    "card_number": "4111XXXXXXXXXX11",
    "with_capture": false
  },
  "mstatus": "success",
  "vresult_code": "A001H00100000000",
  "transaction_type": "a",
  "pending": "0",
  "acquirer_code": "05",
  "trad_url": "https://www.example.com/abcde;fghij;klmno",
  "code": "Q000",
  "status": "success",
  "message": "Success do charge transaction"
}
        

When register is enable

{
  "data": {
    "order_id": "TEST0005",
    "gross_amount": 1980,
    "card_number": "4111XXXXXXXXXX11",
    "with_capture": false
  },
  "mstatus": "success",
  "vresult_code": "A001H00100000000",
  "transaction_type": "a",
  "pending": "0",
  "acquirer_code": "05",
  "trad_url": "https://www.example.com/abcde;fghij;klmno",
  "register_id": "3a582e5c-4d68-47c5-861e-74bb1b50a05d1384309014",
  "customer_id": "C0001",
  "code": "Q000",
  "status": "success",
  "message": "Success do charge transaction"
}
        

※customer_id has the value that was specified in charge request.

Contents of failed response

When Token is expired

{
  "code": "Q001",
  "status": "failure",
  "message": "[Token was expired]",
  "errors": [
    "Token was expired"
  ]
}

When OrderID is duplicated

{
  "data": {
    "order_id": "TEST0005",
    "gross_amount": 1980,
    "card_number": "4111XXXXXXXXXX11",
    "with_capture": false
  },
  "mstatus": "failure",
  "vresult_code": "NH18000000000000",
  "code": "Q001",
  "status": "failure",
  "message": "[Order already succeeded]",
  "errors": [
    "Order already succeeded"
  ]
}

Card error

{
  "data": {
    "order_id": "TEST0007",
    "gross_amount": 1980,
    "card_number": "4111XXXXXXXXXX11",
    "with_capture": false
  },
  "mstatus": "failure",
  "vresult_code": "AG72000000000000",
  "transaction_type": "init",
  "pending": "",
  "acquirer_code": "05",
  "code": "Q001",
  "status": "failure",
  "message": "[Card Error]",
  "errors": [
    "Card Error"
  ]
}

Contents of successful response

{
  "data": {
    "order_id": "TEST0007",
    "gross_amount": 1980,
    "with_capture": false
  },
  "mstatus": "success",
  "vresult_code": "A001000000000000",
  "transaction_type": "a",
  "pending": "0",
  "acquirer_code": "05",
  "register_id": "3a582e5c-4d68-47c5-861e-74bb1b50a05d1384309014",
  "customer_id": "C0001",
  "trad_url": "https://www.example.com/abcde;fghij;klmno",
  "code": "Q000",
  "status": "success",
  "message": "Success do recharge transaction"
}
        

Contents of failed response

When OrderID is duplicated.

{
  "data": {
    "order_id": "TEST0007",
    "gross_amount": 1980,
    "with_capture": false
  },
  "mstatus": "failure",
  "vresult_code": "NH18000000000000",
  "code": "Q001",
  "status": "failure",
  "message": "[Order already succeeded]",
  "errors": [
    "Order already succeeded"
  ]
}

In case specified register_id is not registered.

{
  "code": "Q001",
  "status": "failure",
  "message": "[No such credit card bind]",
  "errors": [
    "No such credit card bind"
  ]
}

Contents of successful response

{
  "cards": [
    {
      "register_id": "414264f0-87da-4bba-8da8-25df92fd35dc1384314166",
      "brand": "MASTER",
      "last4": "4444",
      "original_order_id": "TEST0010",
      "last_updated": "2013-11-13 12:40:08",
      "customer_id": "C0001"
    },
    {
      "register_id": "3a582e5c-4d68-47c5-861e-74bb1b50a05d1384309014",
      "brand": "VISA",
      "last4": "1111",
      "original_order_id": "TEST0009",
      "last_updated": "2013-11-13 11:40:16",
      "customer_id": "C0001"
    }
  ],
  "customer_id": "C0001",
  "code": "Q000",
  "status": "success",
  "message": "Success do query credit card list"
}

Contents of successful response

{
  "customer_id": "C0001",
  "register_id": "414264f0-87da-4bba-8da8-25df92fd35dc1384314166",
  "code": "Q000",
  "status": "success",
  "message": "Success do destroy credit card bind"
}

Contents of unsuccessful response

In case specified register_id is not registered.

{
  "register_id": "414264f0-87da-4bba-8da8-25df92fd35dc1384314166",
  "code": "Q001",
  "status": "failure",
  "message": "[No such credit card bind]",
  "errors": [
    "No such credit card bind"
  ]
}

Contents of successful response

In normal case

{
  "data": {
    "order_id": "TEST0001",
    "transaction_status": "capture"
  },
  "vresult_code": "A001000000000000",
  "code": "Q000",
  "status": "success",
  "message": "Success do capture transaction"
}

Contents of unsuccessful response

In case of trying "Capture" twice.

{
  "vresult_code": "NH18000000000000",
  "code": "Q001",
  "status": "failure",
  "message": "[This order is already captured]",
  "errors": [
    "This order is already captured"
  ]
}

In case of trying "Capture" the order that has been already cancelled.

{
  "vresult_code": "NH02000000000000",
  "code": "Q001",
  "status": "failure",
  "message": "[Order invalid]",
  "errors": [
    "Order invalid"
  ]
}

In case of try to Capture the order that order doesn't exist.

{
  "code": "Q001",
  "status": "failure",
  "message": "[Order not found]",
  "errors": [
    "Order not found"
  ]
}

Details upon successful response

In normal case

{
  "order_info": {
    "order_id": "TEST0011",
    "service_type_code": "mpi",
    "last_success_command": "Capture",
    "success_detail_transaction_type": "pa",
    "proper_order_info": {},
    "memo1": "memo",
    "free_key": "keyinfo",
    "transaction_info_array": [
      {
        "amount": 100,
        "command": "Authorize",
        "mstatus": "success",
        "vresult_code": "G001H00100000000",
        "transaction_datetime": "2014-12-16 12:06:21.048",
        "properTransactionInfo": {
          "transaction_kind": "mpi",
          "transaction_type": "auth",
          "corporation_id": "05",
          "res_3d_message_version": "1.0.2"
        }
      },
      {
        "amount": 100,
        "command": "Verify",
        "mstatus": "success",
        "vresult_code": "G011A00100000000",
        "transaction_datetime": "2014-12-16 12:06:46.74",
        "properTransactionInfo": {
          "transaction_kind": "mpi",
          "transaction_type": "vd",
          "res_3d_cavv": "OTg3NjU0MzIxMDk4NzY1NDMyMT\u003d\u003d",
          "res_3d_cavv_algorithm": "2",
          "res_3d_eci": "05",
          "res_3d_message_version": "1.0.2",
          "res_3d_transaction_id": "MDEyMzQ1Njc4OT\u003dxMjM0NTY3ODk\u003d",
          "res_3d_transaction_status": "Y"
        }
      },
      {
        "amount": 100,
        "command": "Verify",
        "mstatus": "success",
        "vresult_code": "G011A00100000000",
        "transaction_datetime": "2014-12-16 12:06:46.932",
        "properTransactionInfo": {
          "transaction_kind": "card",
          "res_auth_code": "000000",
          "res_center_error_code": "   "
        }
      },
      {
        "amount": 100,
        "command": "Capture",
        "mstatus": "success",
        "vresult_code": "A001000000000000",
        "transaction_datetime": "2014-12-18 14:46:10.94",
        "properTransactionInfo": {
          "transaction_kind": "card",
          "res_auth_code": "000000",
          "res_center_error_code": "   "
        }
      }
    ]
  },
  "vresult_code": "N001000000000000",
  "mstatus": "success",
  "code": "Q000",
  "status": "success",
  "message": "Search request was successful"
}

Contents of unsuccessful response

In case the specifying order that doesn't exist.

{
  "vresult_code": "N001000000000000",
  "mstatus": "success",
  "code": "Q001",
  "status": "failure",
  "message": "[such an order was not found]",
  "errors": ["such an order was not found"]
}

Contents of successful response

In normal case

{
  "data": {
    "order_id": "TEST0011",
    "service_type_code": "card",
    "order_status": "end",
    "last_success_transaction_type": "Authorize",
    "success_detail_transaction_type": "a",
    "amount": 1980,
    "transaction_type": "a",
    "gateway_request_date": "2013-11-13 15:41:37",
    "gateway_response_date": "2013-11-13 15:41:37",
    "pending": "0",
    "auth_code": "000000",
    "action_code": "000"
  },
  "vresult_code": "N001000000000000",
  "code": "Q000",
  "status": "success",
  "message": "Success search card order transaction"
}

Contents of unsuccessful response

In case the specifying order that doesn't exist.

{
  "vresult_code": "N001000000000000",
  "code": "Q001",
  "status": "failure",
  "message": "[such an order was not found]",
  "errors": [
    "such an order was not found"
  ]
}

Contents of successful response

In normal case

{
  "data": {
    "order_id": "TEST0002",
    "transaction_status": "cancel"
  },
  "vresult_code": "A001000000000000",
  "code": "Q000",
  "status": "success",
  "message": "Success do void transaction"
}

Contents of unsuccessful response

When try to cancel the order that was already cancelled.

{
  "vresult_code": "NH18000000000000",
  "code": "Q001",
  "status": "failure",
  "message": "[This order is already cancelled]",
  "errors": [
    "This order is already cancelled"
  ]
}

Details upon successful response.

{
  "data": {
    "order_id": "TEST1006",
    "gross_amount": 1980,
    "with_capture": false,
    "service_option_type": "mpi-complete",
    "response_contents": "\u003c!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 ....(abbr",
    "res_corporation_id": "05",
    "res_brand_id": "5"
  },
  "mstatus": "success",
  "vresult_code": "G001H00100000000",
  "code": "Q000",
  "status": "success",
  "message": "mpi authorize request was successful"
}

Contents of failed response

Cannot execute 3-D secure authorization (Issuer or card member has not participate.)

{
  "mstatus": "failure",
  "vresult_code": "GE02000000000000",
  "code": "Q001",
  "status": "failure",
  "message": "[Cannot perform the authentication]",
  "errors": [
    "Cannot perform the authentication"
  ]
}

$setting = new \VtDirect\Client\Setting();
$input = new \VtDirect\Client\Request\TokensParameter();
$input->card_number = "4111111111111111";
$input->card_exp_month = "12";
$input->card_exp_year = "2018";
$input->card_cvv = "1234";
$input->client_key = "bbbbbbbb-2222-cccc-3333-eeeeeeeeeeee";
$tokens = new \VtDirect\Client\Tokens($setting);
$response = $tokens->GetToken($input);

setting = VtDirect::Setting.new
tokens = VtDirect::Tokens.new setting
response = tokens.get_token(
    'bbbbbbbb-2222-cccc-3333-eeeeeeeeeeee',
    '4111111111111111', '2018', '12', '123')

ClientConfiguration clientConfiguration = new ClientConfiguration();
TokenRequest input = new TokenRequest();
input.setClientKey("bbbbbbbb-2222-cccc-3333-eeeeeeeeeeee");
input.setCardNumber("4111111111111111");
input.setCardExpireYear("2018");
input.setCardExpireMonth("12");
input.setCardCvv("123");
Tokens tokens = new Tokens(clientConfiguration);
TokenResponse response = tokens.GetToken(input);

* The codes sample implementation on for merchant wesite side, but in principle, Tokens API is callback from veritrans.min.js

Content of successful response

{
  "data": {
    "token_id": "8ebec161-b054-4d31-83a1-4b58de696f89-411111-1111"
  },
  "code": "Q000",
  "status": "success",
  "message": "Success request new token"
}

* When Token Id is issued, token_id contains the first 6 digits and the last 4 digits of credit card number on its last part.

Content of unsuccessful response

In case client_key is not correct.

{
  "code": "Q001",
  "status": "failure",
  "message": "[Cannot find merchant]",
  "errors": [
    "Cannot find merchant"
  ]
}

In case card_number format is not in correct.

{
  "code": "Q001",
  "status": "failure",
  "message": "[Invalid card number]",
  "errors": [
    "Invalid card number"
  ]
}

Content of successful response

{
  "data": {
    "order_id": "TEST0013",
    "gross_amount": 1980
  },
  "mstatus": "success",
  "vresult_code": "D001H00100000000",
  "url": "https://payment.sej.co.jp/od/hi.asp?HARAIKOMIXXXXXXXXXXXXX0000010001",
  "receipt_no": "2000000010001",
  "trad_url": "https://www.example.com/abcde;fghij;klmno",
  "code": "Q000",
  "status": "success",
  "message": "Success do cvs authorize transaction"
}