取引を登録する

概要

以下の手順で進めます。

  1. 取引の請求先(destination)を登録する
  2. 取引を登録する

手順

1. 取引の請求先(destination)を登録する

請求先がすでに登録済みの場合、この手順はスキップできます。

リクエスト

curl -X POST "https://sandbox-api.mfkessai.co.jp/v1/destinations" \
-H "apikey: [apikey]" \
-H "content-type: application/json" \
-d '{
  "address1": "千代田区1-2-3",
  "address2": "サンプルビル3F",
  "cc_emails": [ "another.tanto1@example.jp", "another.tanto2@example.jp" ],
  "customer": {
    "office_name": "サンプル商事株式会社",
    "user_defined_id": "customer123456"
  },
  "department": "経理部",
  "email": "kesai.tanto@example.jp",
  "name": "請求先氏名",
  "name_kana": "セイキュウサキ シメイ",
  "prefecture": "東京都",
  "tel": "03-1234-5678",
  "title": "部長",
  "zip_code": "111-1111"
  }'

レスポンス

{
  "address1": "千代田区1-2-3",
  "address2": "サンプルビル3F",
  "cc_emails": [
    "another.tanto1@example.jp",
    "another.tanto2@example.jp"
  ],
  "customer_id": "AY9N-VPN3",
  "department": "経理部",
  "email": "kesai.tanto@example.jp",
  "id": "9NRM-A376",
  "name": "請求先氏名",
  "prefecture": "東京都",
  "tel": "03-1234-5678",
  "title": "部長",
  "zip_code": "111-1111"
}

次の手順に利用するので、idを保存しておきます。

2. 取引を登録する

リクエスト

destination_id に手順1で保存したidを設定します。

$ curl -X POST "https://sandbox-api.mfkessai.co.jp/v1/transactions" \
-H "accept: application/vnd.mfk.transaction" \
-H "apikey: [apikey]" \
-H "content-type: application/json" \
-d '
{
  "amount": 2160,
  "date": "2018-07-31T00:00:00+09:00",
  "destination_id": "9NRM-A376",
  "due_date": "2018-09-30T00:00:00+09:00",
  "email_flag": true,
  "issue_date": "2018-08-30T00:00:00+09:00",
  "posting_flag": false,
  "transaction_details": [
    {
      "amount": 2000,
      "description": "商品名A",
      "quantity": 2,
      "unit_price": 1000
    },
    {
      "amount": 160,
      "description": "消費税",
      "quantity": 1,
      "unit_price": 160
    }
  ],
  "user_defined_id": "transaction_2018080901"
}
'

レスポンス

{
  "amount": 2160,
  "destination": {
    "address1": "千代田区1-2-3",
    "address2": "サンプルビル3F",
    "cc_emails": [
      "another.tanto1@example.jp",
      "another.tanto2@example.jp"
    ],
    "customer_id": "AY9N-VPN3",
    "department": "経理部",
    "email": "kesai.tanto@example.jp",
    "id": "9NRM-A376",
    "name": "請求先氏名",
    "prefecture": "東京都",
    "tel": "03-1234-5678",
    "title": "",
    "zip_code": "111-1111"
  },
  "destination_id": "9NRM-A376",
  "id": "4NWA-GG7N",
  "status": "examination_passed",
  "transaction_details": [
    {
      "amount": 2000,
      "description": "商品名A",
      "quantity": 2,
      "unit_price": 1000
    },
    {
      "amount": 160,
      "description": "消費税",
      "quantity": 1,
      "unit_price": 160
    }
  ],
  "user_defined_id": "transaction_2018080901"
}

statusには以下のように審査結果が格納されています。

status 意味
examination_passed 審査通過
examination_rejected 審査否決
unexamined 審査待ち

審査待ち状態の取引は、審査結果を得られるまで/v1/transactions/{id}で定期的に最新のステータスを取得してください。