転送元 - Razorpay
    • PDF

    転送元 - Razorpay

    • PDF

    The content is currently unavailable in Korean. You are viewing the default Ja - 日本語 version.
    기사 요약

    本ページでは、Razorpayからデータを取得するための設定(転送設定)について説明します。
    接続に関する設定については、接続情報 - Razorpayを参照ください。

    利用上の注意・制約

    API Rate Limit

    Razorpay APIには、一定期間内のリクエスト回数に制限があります。詳細はRazorpay公式ドキュメント - Rate Limitsを参照ください。

    取得対象

    Customers

    顧客情報一覧を取得します。
    詳しくは、Razorpay公式ドキュメント - Customersを参照ください。

    設定項目

    設定項目はありません。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idstring顧客の一意識別子
    entitystringエンティティタイプ
    namestring顧客名
    emailstringメールアドレス
    contactstring連絡先情報
    gstinstringGST識別番号
    notesjson追加メモ
    shipping_addressjson配送先住所詳細
    created_atlong作成日時

    Orders

    注文情報一覧を取得します。
    詳しくは、Razorpay公式ドキュメント - Ordersを参照ください。

    設定項目

    項目名必須デフォルト値説明
    Created date/time from--取得対象期間の開始日時を入力できます。
    ISO 8601形式(例:2023-01-01T00:00:00Z)で入力してください。
    Created date/time to--取得対象期間の終了日時を入力できます。
    ISO 8601形式(例:2023-12-31T23:59:59Z)で入力してください。
    Authorized?--認証ステータスでフィルタできます。
    0 (Not Authorized)または1 (Authorized)を選択してください。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idstring注文の一意識別子
    entitystringエンティティタイプ
    amountlong注文金額
    amount_paidlong支払済み金額
    amount_duelong未払い金額
    currencystring通貨コード
    receiptstring領収書番号
    offer_idstringオファーID
    statusstring注文ステータス
    attemptslong支払い試行回数
    notesjson追加メモ
    created_atlong作成日時

    Payments

    支払い情報一覧を取得します。
    詳しくは、Razorpay公式ドキュメント - Paymentsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    Created date/time from--取得対象期間の開始日時を入力できます。
    ISO 8601形式(例:2023-01-01T00:00:00Z)で入力してください。
    Created date/time to--取得対象期間の終了日時を入力できます。
    ISO 8601形式(例:2023-12-31T23:59:59Z)で入力してください。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idstring支払いの一意識別子
    entitystringエンティティタイプ
    amountlong支払い金額
    currencystring通貨コード
    statusstring支払いステータス
    order_idstring関連する注文ID
    invoice_idstring関連する請求書ID
    internationalboolean国際決済フラグ
    methodstring支払い方法
    amount_refundedlong返金済み金額
    refund_statusstring返金ステータス
    capturedbooleanキャプチャ状態
    descriptionstring支払い説明
    card_idstringカードID
    cardjsonカード詳細
    bankstring銀行名
    walletstringウォレットタイプ
    vpastringバーチャルペイメントアドレス
    emailstring顧客メールアドレス
    contactstring連絡先情報
    token_idstringトークンID
    notesjson追加メモ
    feelong取引手数料
    taxlong税額
    error_codestringエラーコード
    error_descriptionstringエラー説明
    error_sourcestringエラー発生元
    error_stepstringエラー発生ステップ
    error_reasonstringエラー理由
    acquirer_datajsonアクワイアラデータ
    created_atlong作成日時

    Refunds

    返金情報一覧を取得します。
    詳しくは、Razorpay公式ドキュメント - Refundsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    Created date/time from--取得対象期間の開始日時を入力できます。
    ISO 8601形式(例:2023-01-01T00:00:00Z)で入力してください。
    Created date/time to--取得対象期間の終了日時を入力できます。
    ISO 8601形式(例:2023-12-31T23:59:59Z)で入力してください。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idstring返金の一意識別子
    entitystringエンティティタイプ
    amountlong返金金額
    currencystring通貨コード
    payment_idstring関連する支払いID
    notesjson追加メモ
    receiptstring領収書番号
    acquirer_datajsonアクワイアラデータ
    batch_idstringバッチID
    statusstring返金ステータス
    speed_processedstring処理速度
    speed_requestedstring要求速度
    created_atlong作成日時

    Settlements

    精算情報一覧を取得します。
    詳しくは、Razorpay公式ドキュメント - Settlementsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    Created date/time from--取得対象期間の開始日時を入力できます。
    ISO 8601形式(例:2023-01-01T00:00:00Z)で入力してください。
    Created date/time to--取得対象期間の終了日時を入力できます。
    ISO 8601形式(例:2023-12-31T23:59:59Z)で入力してください。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idstring精算の一意識別子
    entitystringエンティティタイプ
    amountlong精算金額
    statusstring精算ステータス
    feeslong精算手数料
    taxlong税額
    utrstringユニーク取引リファレンス
    created_atlong作成日時

    Invoices

    請求書情報一覧を取得します。
    詳しくは、Razorpay公式ドキュメント - Invoicesを参照ください。

    設定項目

    項目名必須デフォルト値説明
    Payment ID--特定の支払いIDでフィルタできます。
    Receipt--特定の領収書番号でフィルタできます。
    Customer ID--特定の顧客IDでフィルタできます。
    Customer IDによるフィルタ

    Customer IDは他のパラメーターと組み合わせて指定できません。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idstring請求書の一意識別子
    entitystringエンティティタイプ
    receiptstring領収書番号
    invoice_numberstring請求書番号
    customer_idstring顧客ID
    customer_detailsjson顧客詳細
    order_idstring関連する注文ID
    subscription_idstring関連するサブスクリプションID
    line_itemsjson明細項目
    payment_idstring関連する支払いID
    statusstring請求書ステータス
    expire_bylong有効期限
    issued_atlong発行日時
    paid_atlong支払い日時
    cancelled_atlongキャンセル日時
    expired_atlong期限切れ日時
    sms_statusstringSMS送信ステータス
    email_statusstringメール送信ステータス
    datelong請求書日付
    termsstring利用規約
    partial_paymentboolean分割払い可否
    gross_amountlong総額
    tax_amountlong税額
    taxable_amountlong課税対象金額
    amountlong合計金額
    amount_paidlong支払済み金額
    amount_duelong未払い金額
    currencystring通貨コード
    currency_symbolstring通貨記号
    descriptionstring請求書説明
    notesjson追加メモ
    commentstringコメント
    short_urlstring短縮URL
    view_lessboolean簡易表示フラグ
    billing_startlong請求期間開始日時
    billing_endlong請求期間終了日時
    typestring請求書タイプ
    group_taxes_discountsboolean税金・割引のグループ化
    created_atlong作成日時

    Items

    アイテム情報一覧を取得します。
    詳しくは、Razorpay公式ドキュメント - Itemsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    Created date/time from--取得対象期間の開始日時を入力できます。
    ISO 8601形式(例:2023-01-01T00:00:00Z)で入力してください。
    Created date/time to--取得対象期間の終了日時を入力できます。
    ISO 8601形式(例:2023-12-31T23:59:59Z)で入力してください。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idstringアイテムの一意識別子
    activebooleanアクティブ状態
    namestringアイテム名
    descriptionstringアイテム説明
    amountlongアイテム金額
    unit_amountlong単価
    currencystring通貨コード
    typestringアイテムタイプ
    unitlong数量単位
    tax_inclusiveboolean税込み価格フラグ
    hsn_codelongHSNコード
    sac_codelongSACコード
    tax_ratestring税率
    tax_idstring税金ID
    tax_group_idstring税金グループID
    created_atlong作成日時

    Subscriptions

    サブスクリプション情報一覧を取得します。
    詳しくは、Razorpay公式ドキュメント - Subscriptionsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    Created date/time from--取得対象期間の開始日時を入力できます。
    ISO 8601形式(例:2023-01-01T00:00:00Z)で入力してください。
    Created date/time to--取得対象期間の終了日時を入力できます。
    ISO 8601形式(例:2023-12-31T23:59:59Z)で入力してください。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idstringサブスクリプションの一意識別子
    entitystringエンティティタイプ
    plan_idstringプランID
    customer_idstring顧客ID
    statusstringサブスクリプションステータス
    current_startlong現在の期間開始日時
    current_endlong現在の期間終了日時
    ended_atlong終了日時
    quantitylong数量
    notesjson追加メモ
    charge_atlong請求日時
    start_atlong開始日時
    end_atlong終了日時
    auth_attemptslong認証試行回数
    total_countlong総回数
    paid_countlong支払い済み回数
    customer_notifyboolean顧客通知フラグ
    created_atlong作成日時
    expire_bylong有効期限
    short_urlstring短縮URL
    has_scheduled_changesboolean変更予定フラグ
    sourcestringソース
    payment_methodstring支払い方法
    offer_idstringオファーID
    remaining_countlong残り回数
    change_scheduled_atstring変更予定日時

    Contacts

    連絡先情報一覧を取得します。
    詳しくは、Razorpay公式ドキュメント - Contactsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    Active?--アクティブ状態でフィルタできます。
    0 (Inactive)または1 (Active)を選択してください。
    Type--連絡先タイプでフィルタできます。
    customeremployeeself、またはvendorを選択してください。
    Created date/time from--取得対象期間の開始日時を入力できます。
    ISO 8601形式(例:2023-01-01T00:00:00Z)で入力してください。
    Created date/time to--取得対象期間の終了日時を入力できます。
    ISO 8601形式(例:2023-12-31T23:59:59Z)で入力してください。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idstring連絡先の一意識別子
    entitystringエンティティタイプ
    namestring連絡先名
    contactstring連絡先情報
    emailstringメールアドレス
    typestring連絡先タイプ
    reference_idstringリファレンスID
    batch_idstringバッチID
    activebooleanアクティブ状態
    notesjson追加メモ
    created_atlong作成日時

    이 문서가 도움이 되었습니까?