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

Chargeback

はじめに​

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 — 指定した取引についてチャージバック審査をリクエストします。

ヘッダー
ヘッダー値
AuthorizationBearer {token} — 有効なアクセストークン。
ボディ
{
  "datetime": "2023-01-05T03:00:00.000Z",
  "requestor": { "key": "cpf", "value": "USER_CPF" },
  "name": "USER_NAME",
  "reason": "REQUEST_REASON",
  "observation": "GENERAL_OBSERVATIONS",
  "documents": [
    { "label": "FILE_NAME", "data": "JVBERi0xLjQKMSAwI==" }
  ]
}
フィールド型必須説明
datetimestringyesチャージバックリクエストの日時、ISO 8601形式。
requestorobjectyesリクエスト者の情報。
requestor.keystringyesリクエスト者の識別キーのタイプ(例:cpf)。
requestor.valuestringyesリクエスト者の識別キーの値。
namestringyesリクエスト者の氏名。
reasonstringyesチャージバックリクエストの理由。
observationstringnoリクエストに関する一般的な所見。
documentsarraynoチャージバックに関連する書類。最大3件、各項目はBase64エンコード — PDFのみ。
documents[].labelstringyes (per item)ファイル名または説明。
documents[].datastringyes (per item)Base64エンコードされたPDFファイル。
200 OK
{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}
フィールド説明
id生成されたチャージバックID。

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

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

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

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

考えられるすべてのステータスについては、列挙値 — チャージバック結果をご覧ください。パフォーマンスを最適化するため、このエンドポイントをポーリングする代わりにWebhookを実装してください。

最終更新 に