ショッピング

支払番号発行API

リクエストURL
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderPayNumber


本番環境用APIを利用したい場合は、こちらをご確認ください。

テスト用APIはどなたでもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderPayNumber
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

モバイルSuica、コンビニ決済(セブン・イレブン)、コンビニ決済(その他)、ペイジーでのお支払の注文に対して購入者様のお支払い用の支払番号を発行します。支払番号発行済みの場合、金額変更を伴う処理を行うと新たな支払番号が自動発行されます。
また、API自動時にシステムが自動で支払番号発行の連絡メールを購入者に送信します。

リクエストパラメータ

RESTリクエストの構築(POST)」をご参照ください。

パラメータ 説明
/Req リクエストパラメータ
/Req/Target 更新対象指定情報
/Req/Target/OrderId
(必須)
string 注文ID
/Req/Target/OperationUser string 更新者名(ビジネスID登録氏名)
/Req/SellerId
(必須)
string ストアアカウント

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
Yahoo! ID連携
Yahoo! ID連携によるAPIアクセス実装方法


サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderPayNumber

サンプルリクエスト

POST /ShoppingWebService/V1/orderPayNumber HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

<Req>
 <Target>
  <OrderId>testseller-10000001</OrderId>
  <OperationUser>矢風太郎</OperationUser>
 </Target>
 <SellerId>testseller</SellerId>
</Req>



レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含み、次の属性を持ちます。

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返された値の個数です。
  • ok : 更新OKになった要素数です。(常に1です。)
  • ng : 更新NGになった要素数です。(常に0です。)

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/Status 処理成否(OKのみ)
/ResultSet/Result/Warning 警告情報(ある場合)
/ResultSet/Result/Warning/Code 警告コード(エラーコードと同じ体系です。)
/ResultSet/Result/Warning/Message 警告メッセージ
/ResultSet/Result/Warning/Detail 警告詳細(ある場合)



サンプルレスポンス

<!--・サンプルXML-->

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" ok="1" ng="0">
    <Result>
        <Status>OK</Status>
    </Result>
</ResultSet>


<!--・警告ありのサンプルXML-->

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" ok="1" ng="0">
    <Result>
        <Status>OK</Status>
        <Warning>
            <Code>od91130</Code>
            <Message></Message>
            <Detail></Detail>
        </Warning>
    </Result>
</ResultSet>



エラー

支払番号発行APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

フィールド 説明
/Error - エラーレスポンスのすべてを含みます。
/Error/Code string エラーコード
/Error/Message string エラーメッセージ
/Error/Detail - エラー詳細(ある場合)
/Error/Detail/SettleCode string 決済システムのエラーコード(APIエラーコードが「od91112」の場合)


・エラーコード

コード HTTPステータスコード 説明
od90101 400 リクエストパラメータエラーです。
od90103 400 リクエストと注文の整合性エラーです。
od91801 404 該当注文がありません。
od91008 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91009 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91011 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91012 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91110 500 決済におけるメンテナンスエラーです。
od91112 500 決済におけるシステムエラーです。連続して発生する場合はお問い合わせください。
od91116 500 決済におけるエラーです。連続して発生する場合はお問い合わせください。
od91118 500 決済における一時的な操作不可エラーです。連続して発生する場合はお問い合わせください。
od91132 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91902 404 メンテナンスエラー




利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。

利用約款

このAPIに関する利用約款はこちら