支払番号発行API

下記支払方法の注文に対してお支払い用の支払番号を発行します。

• モバイルSuica
• コンビニ決済（セブン・イレブン）
• コンビニ決済（その他）
• ペイジー

支払番号発行済みの場合、金額変更を伴う処理を行うと新たな支払番号が自動発行されます。
また、API呼び出し時にシステムが自動で支払番号発行の連絡メールを購入者に送信します。

変更履歴

利用申請について

本番環境について

注文APIを利用する場合は別途利用申請が必要です。下記フォームから申請をお願いします。
ショッピング注文API利用申請フォーム

テスト環境について

テスト用APIを利用する場合は、下記フォームから「テスト環境用」を指定して申請をお願いします。
新しいアプリケーションを開発
※テスト環境に関しては別途注文APIの利用申請をしていただく必要はありません。

リクエストURL

リクエストパラメータ

「Web APIの使い方#POSTとは」をご参照ください。

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

サンプルリクエスト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>

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

• Yahoo! ショッピングAPI共通エラーコード一覧

支払番号発行APIで固有に返すエラーコードは以下をご覧ください。

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

エラーコード

コード	HTTPステータスコード	説明
od90101	400	リクエストパラメータエラーです。
od90103	400	リクエストと注文の整合性エラーです。
od90166	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に関する利用約款はこちら。