GMO ｜コンビニ｜取引状態参照

概要

GMO に登録した指定したオーダーIDの取引情報を取得する API です。

本APIで取得した結果に応じて、請求状態を必要に応じて更新してください。

尚、状態の説明については「コンビニ概要・基本事項」を参照してください。

資料

コンビニ決済公式資料 444P

コンビニ決済公式資料 449P

エンドポイント

メソッド URI Headers
POST {GmoApiUrl}/SearchTradeMulti Default

リクエストパラメーター

パラメーター名 必須 型 桁 項目名 特記
version CHAR 3 バージョン パラメータバージョン(予約項目のため、省略してください。)
shopID 〇 CHAR 13 ショップ ID 弊社が発行する値を設定します。
shopPass 〇 CHAR 8 ショップパスワード 弊社が発行する値を設定します。
orderID 〇 CHAR 27 オーダーID 加盟店様が取引を識別するための値を設定します。
payType 〇 CHAR 2 決済方法 0：クレジット 
{
    "shopID"      : "tshop99887902",
    "shopPass"    : "7ry53fqm",
    "orderID"     : "4cfffa3f3ef6e90692dbc204e09b351b",
    "payType"     : "0",
}

レスポンス

正常時

ステータスコード：200

パラメーター名 型 桁 項目名 特記
status CHAR - 現状態 「コンビニ概要・基本事項」を参照
processDate CHAR 14 処理日時 処理を実施した日時を返却します。yyyyMMddHHmmss書式
accessID CHAR 32 取引ID ※：同一オーダーIDでも決済手段が異なると、異なった「取引ID」および「取引パスワード」が返却されます。
accessPass CHAR 32 取引パスワード ※：同一オーダーIDでも決済手段が異なると、異なった「取引ID」および「取引パスワード」が返却されます。
amount NUMBER 10 利用金額 決済または決済依頼をした金額を返却します。
tax NUMBER 10 税送料
siteID CHAR 13 サイトID
currency CHAR 3 通貨コード 決済に利用された通貨を返却します。
clientField1 CHAR 100 加盟店自由項目1
clientField2 CHAR 100 加盟店自由項目2
clientField3 CHAR 100 加盟店自由項目3
payType CHAR 2 決済方法 3：コンビニ
cvsCode CHAR 5 支払先コンビニコード 支払先コンビニ会社コード
cvsConfNo CHAR 20 確認番号 コンビニ確認番号
cvsReceiptNo CHAR 32 受付番号 支払先コンビニが返却した受付番号
paymentTerm CHAR 14 支払期限日時 yyyyMMddHHmmss書式
finishDate CHAR 8 入金確定日 yyyyMMdd書式 
{

}
失敗時

ステータスコード：不明

パラメーター名 型 桁 項目名 特記
ErrCode CHAR 3 エラーコード エラー発生時のみ
複数ある場合は"｜"で接続された文字列
ErrInfo CHAR 9 エラー詳細コード エラー発生時のみ
複数ある場合は"｜"で接続された文字列

・エラー時(複数エラーがある場合は下記のような形式にて出力されます。ErrCode の n 番目と ErrInfo の n 番目は対となります)

[
  {
    "errCode":"E01",
    "errInfo":"E01010001"
  },
  {
    "errCode":"E01",
    "errInfo":"E01020001"
  },
]