Postmanで「CRUD: Create payment」APIを実行し、外部決済の回収処理を複数顧客アカウントに対して一括実行する手順

[Yoshihisa]

Postmanで「CRUD: Create payment」APIを実行し、外部決済の回収処理を複数顧客アカウントに対して一括実行する手順を紹介します。

Postman,
https://www.getpostman.com/

CRUD: Create payment,
https://www.zuora.com/developer/api-reference/#operation/Object_POSTPayment

■手順
1, データソース「請求書 」で、回収を行う請求データをエクスポートする。
「請求書: ID、請求書: 総額、アカウント: ID、デフォルトの回収方法: ID」フィールドの値を取得。
※今回は「回収期限 2020/07/31」の請求書のデータを対象とします。

2, ファイルをダウンロード

3, ダウンロードしたファイルを開いて、列名をそれぞれ「InvoiceId」、「Amount」、「AccountId」、「PaymentMethodId」にする

4, Postmanで、Collectionを作成

5, 新規タブで以下のように設定し、SaveをクリックしてCollection内に保存

・メソッド: POST
・URL: https://rest.apisandbox.zuora.com/v1/object/payment

・Authentication: 対象環境のユーザーログイン情報を設定

・Bodyに以下のリクエストボディを入力

{
  "InvoiceId": "{{InvoiceId}}",
  "Amount": {{Amount}},
  "AppliedInvoiceAmount": {{Amount}},
  "AccountId": "{{AccountId}}",
  "PaymentMethodId": "{{PaymentMethodId}}",
  "EffectiveDate": "2020-07-01",
  "Type": "External",
  "Status": "Processed"
}

6, 当該Collectionの右上の三角マークをクリックし、「Run」をクリック

7, CSVファイルを選択して、「Run "Collection名"」をクリックしてAPIを実行