メインコンテンツへスキップ
GET
/
v1
/
payments
/
{id}
決済取得
curl --request GET \
  --url https://api.sandbox.zafapay.com/v1/payments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "tx_abc123",
  "request_id": "req_xyz789",
  "status": "completed",
  "amount": "17.62",
  "currency": "usd",
  "capture_method": "automatic",
  "external_id": "order_12345",
  "payment_method": "card",
  "amount_refunded": "0",
  "original_amount": null,
  "original_currency": null,
  "applied_rate": null,
  "card_brand": "visa",
  "card_last4": "4242",
  "cardholder_name": "TARO YAMADA",
  "card_exp_month": 12,
  "card_exp_year": 2028,
  "card_country": "JP",
  "card_funding": "credit",
  "payment_method_id": null,
  "is_recurring": false,
  "customer_id": null,
  "email": "customer@example.com",
  "tel": null,
  "product_name": null,
  "error_code": null,
  "refunds": [
    {
      "id": "orf_xyz789",
      "amount": "5.50",
      "status": "succeeded",
      "reason": "お客様都合",
      "created_at": "2024-01-15T10:35:00Z"
    }
  ],
  "metadata": {},
  "created_at": "2024-01-15T10:30:00.000Z",
  "updated_at": "2024-01-15T10:31:00.000Z"
}

承認

Authorization
string
header
必須

アクセストークンを使用したBearer認証

パスパラメータ

id
string
必須

トランザクションID

:

"tx_abc123"

レスポンス

成功

id
string

トランザクションID

:

"tx_abc123"

request_id
string

決済リクエストID

:

"req_xyz789"

status
enum<string>

ステータス

利用可能なオプション:
pending,
requires_action,
authorized,
completed,
failed,
canceled,
partially_refunded,
refunded
:

"completed"

amount
string

決済金額(文字列形式)

:

"17.62"

currency
string

通貨コード

:

"usd"

capture_method
string

キャプチャ方式

:

"automatic"

external_id
string

加盟店側の注文ID

:

"order_12345"

payment_method
string

決済方法

:

"card"

amount_refunded
string

返金済み金額(文字列形式)

:

"0"

original_amount
number | null

通貨変換前の元の金額

:

null

original_currency
string | null

通貨変換前の元の通貨

:

null

applied_rate
number | null

適用された為替レート

:

null

card_brand
string | null

カードブランド

:

"visa"

card_last4
string | null

カード番号の下4桁

:

"4242"

cardholder_name
string | null

カード名義人

:

"TARO YAMADA"

card_exp_month
integer | null

カード有効期限(月、1〜12)

:

12

card_exp_year
integer | null

カード有効期限(年)

:

2028

card_country
string | null

カード発行国(ISO 3166-1 alpha-2)

:

"JP"

card_funding
string | null

カードの資金源タイプ(credit, debit, prepaid)

:

"credit"

payment_method_id
string | null

保存されたカードのID(pmi_xxx形式)

:

null

is_recurring
boolean

リカーリング決済の場合true

:

false

customer_id
string | null

顧客ID

:

null

email
string | null

顧客のメールアドレス

:

"customer@example.com"

tel
string | null

顧客の電話番号

:

null

product_name
string | null

商品名

:

null

error_code
string | null

失敗した決済のエラーコード

:

null

refunds
object[]

返金履歴

metadata
object

メタデータ

created_at
string<date-time>

作成日時

:

"2024-01-15T10:30:00.000Z"

updated_at
string<date-time>

更新日時

:

"2024-01-15T10:31:00.000Z"