メインコンテンツへスキップ

Chargeback

Markdown

はじめに​

APIリクエストはアクセストークンを使用して認証されます。有効なアクセストークンを含まないリクエストはすべてエラーを返します。詳しくは認証をご覧ください。

ベースURL
  • UAT:https://transactions.transactional.uat.unico.app/api/public/v1
  • 本番:https://transactions.transactional.unico.app/api/public/v1

チャージバックの報告​

POST /credit/transactions/{transaction_id}/chargeback — 指定した取引でチャージバックを受けたことをUnicoに報告します。

報告は異議申し立てではありません

このエンドポイントはチャージバックを報告するだけです。チャージバック分析は開始されず、責任保証も適用されません。Unicoにチャージバックを分析してもらうには、ポータルで該当取引の異議申し立てを行ってください。

ヘッダー
ヘッダー値
AuthorizationBearer {token} — 有効なアクセストークン。
ボディ
{
  "datetime": "2023-01-05T03:00:00.000Z",
  "requestor": { "key": "cpf", "value": "USER_CPF" },
  "name": "USER_NAME",
  "reason": "REQUEST_REASON",
  "observation": "GENERAL_OBSERVATIONS"
}
フィールド型必須説明
datetimestringyesチャージバックを受けた日時、ISO 8601形式。
requestorobjectyesリクエスト者の情報。
requestor.keystringyesリクエスト者の識別キーのタイプ(例:cpf)。
requestor.valuestringyesリクエスト者の識別キーの値。
namestringyesリクエスト者の氏名。
reasonstringyesチャージバックの理由。
observationstringnoチャージバックに関する一般的な所見。
201 Created
{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}
フィールド説明
idチャージバックID。

1つの取引に存在するチャージバックは1件のみです。すでにチャージバックがある取引を報告すると、既存のチャージバックのidとともに200 OKが返され、そのチャージバックは変更されません。

エラーレスポンスについては、エラー — 取引の作成をご覧ください。

チャージバックステータスの取得​

GET /credit/transactions/{transaction_id}/chargeback/{chargeback_id} — 特定のチャージバックのステータスを確認します。

ヘッダー
ヘッダー値
AuthorizationBearer {token} — 有効なアクセストークン。
200 OK
{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "status": "waiting"
}
フィールド説明
idチャージバックID。
statusチャージバックの現在のステータス。

報告されたチャージバックはwaitingのままです。ポータルで取引に異議が申し立てられた場合、同じidで分析の進捗と結果を確認できます。考えられるすべてのステータスについては、列挙値 — チャージバック結果をご覧ください。パフォーマンスを最適化するため、このエンドポイントをポーリングする代わりにWebhookを実装してください。

最終更新 に