データタイプ

Smartpay API では、通貨、金額、日付について全体で一貫した形式を使用しています。

通貨

通貨には、ISO 4217 規格で定義された通貨コードを使用しています。

現在使用できるのは JPY のみです。

{
 "currency": "jpy"
}

金額

金額は、ISO 4217 規格に従い、最小単位で表されます。つまり、各通貨の最小の単位で表されます。

たとえば、JPY と 1000 は ¥1000 を表し、USD と 1000 は $10 を表します。

現在使用できるのは JPY のみです。

{
 "amount": 1000,
 "currency": "jpy"
}

文字列

文字列は、フィールドに特に記載がない限り、最大で255文字です。

日付

日付は、Unix タイムスタンプ (Unix エポックからのミリ秒) で表されます。例外は dateOfBirth フィールドで、YYYY-MM-DD 形式の値を受け入れて返します。

{
 "createdAt": 1630569530084,
 "dateOfBirth": "1981-09-06"
}

国は、ISO 3166-1 に従い、2文字の国コードで表されます。たとえば、日本は JP、米国は US などです。

現在使用できるのは JP のみです。

{
 "country": "jp"
}

エンコード

Smartpay の API に送信されるすべてのデータが UTF-8 でエンコードされると想定しています。