RemitAid API Reference (1.0.0-beta.1)

Download OpenAPI specification:Download

RemitAidが提供するAPIのリファレンスです。
ご不明な点がありましたらsupport@remitaid.co.jpまでお問い合わせください。
変更履歴はこちらからご確認ください。

Introduction

RemitAid APIは、RESTを中心に構成されています。

Overview

認証

APIの認証はアクセストークンを用いたBasic認証です。
アクセストークンを発行する場合、support@remitaid.co.jpまでご連絡ください。
アクセストークンは安全に保管してください。Githubやクライアントサイドのコードなど一般的にアクセス可能な場所に置かないでください。
なお全てのAPIリクエストはHTTPSで行う必要があります。
curl 実行例

curl -u YOUR_ACCESS_TOKEN https://{FQDN}/v1/xxxx -d '{...}'

※FQDNについては利用申込後の審査が完了次第、共有いたします。

エラーレスポンス

APIリクエストで発生するエラーは標準的なHTTPステータスコードとともにJSON形式のレスポンスを返却します。
エラーレスポンス例

{
  "code":"BAD_REQUEST_ERROR",
  "message":"不正なJSONです。"
}

HTTP ステータスコード	意味	内容
400	Bad Request	リクエストパラメータに不正があります。
401	Unauthorized	認証できません。API Keyをご確認ください。
404	Not Found	指定したリソースが見つかりません。
409	Conflict	操作が重複して実行されました。
429	Too Many Requests	一定時間内のリクエストが多すぎます。
500	Internal Server Error	サーバー側でエラーが発生しました。
503	Service Unavailable	サーバー側はリクエストを処理する準備ができていません。

レートリミット

仕様の開示まで少々お待ちください。

Payment Links

Create Payment Link API

決済リンクを作成するAPI

Request Body schema: application/json

payment_link_id required	string [ 1 .. 20 ] characters 決済リンクID 使用可能文字：半角英数字 + 半角記号(!"$%'()*+,-.;<=>\^_`{\|}~)
object_key	string オブジェクトキー
product_name required	string [ 1 .. 250 ] characters サービス・商品の名称
description	string <= 250 characters サービス・商品の説明改行を含む場合エスケープされた改行コード\\nを含みます。
currency required	string (currency) Enum: "JPY" "USD" "EUR" "TWD" "HKD" "CNY" "AUD" 通貨
is_amount_changeable required	boolean 決済金額変更可否
amount required	number <float> <= 8 characters 決済金額
payment_due_date	string <date> 支払い期限日
required_fields required	Array of strings (required_fields) Items Value: "buyer_email" 必須項目
display_fields required	Array of strings (display_fields) Items Enum: "buyer_company_name" "buyer_name" "buyer_address" 表示項目

Responses

Request samples

Payload

Content type

application/json

{"payment_link_id": "0001",
"object_key": "123_2023-06-07T102030.jpg",
"product_name": "商品名",
"description": "説明\\n説明",
"currency": "JPY",
"is_amount_changeable": false,
"amount": 10000,
"payment_due_date": "2023-06-30",
"required_fields": ["buyer_email"
],
"display_field": ["company_name",
"name",
"address"
]
}

Response samples

201

Content type

application/json

{"payment_link_id": "0001",
"url": "https://buy.remitaid.io/{short_company_name}/{merchant_id}/{payment_link_id}"
}

Update Payment Link API

決済リンクのステータスを更新するAPI

Request Body schema: application/json

payment_link_id required	string [ 1 .. 20 ] characters 決済リンクID
status required	string ステータス

Responses

Request samples

Payload

Content type

application/json

{"payment_link_id": "0001",
"status": "10"
}

Response samples

201

Content type

application/json

{"payment_link_id": "0001",
"status": "10"
}

List All Payment Links API

決済リンク一覧を取得する

Responses

Response samples

200

Content type

application/json

{"payment_links": [{"payment_link_id": "PLID1000",
"created_at": "2023/06/21 10:00:00",
"product_name": "商品名1",
"description": "商品の説明1",
"object_key": "123_2023-06-07T102030.jpg",
"currency": "JPY",
"is_amount_changeable": true,
"amount": "1000",
"author": "伊藤千尋",
"payment_due_date": "2023/06/30",
"payment_link_url": "https://dashboard.dev.remitaid.io/link-payment?token=hogehoge",
"status": "10",
"transaction_count": 2,
"required_fields": ["buyer_email"
],
"display_field": ["company_name",
"name",
"address"
]
},
{"payment_link_id": "PLID2000",
"created_at": "2023/06/22 10:00:00",
"product_name": "商品名2",
"description": "商品の説明2",
"object_key": "123_2023-06-08T102030.jpg",
"currency": "USD",
"is_amount_changeable": false,
"amount": "1000",
"author": "伊藤千尋",
"payment_due_date": "2023/06/30",
"payment_link_url": "https://dashboard.dev.remitaid.io/link-payment?token=fugafuga",
"status": "00",
"transaction_count": 2,
"required_fields": ["buyer_email"
],
"display_field": ["company_name",
"name",
"address"
]
}
]
}