Skip to main content
GET
/
v1
/
payments
/
{id}
curl https://api.sandbox.zafapay.com/v1/payments/tx_abc123 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
{
  "id": "tx_abc123",
  "request_id": "req_xyz789",
  "status": "completed",
  "amount": 100,
  "currency": "usd",
  "capture_method": "automatic",
  "connector": "card_processor",
  "psp_reference": "pi_xxxxx",
  "external_id": "order_12345",
  "amount_refunded": 0,
  "refunds": [],
  "metadata": {
    "customer_name": "山田太郎"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:31:00Z"
}

パスパラメータ

id
string
required
トランザクションID(tx_xxx)またはリクエストID(req_xxx

レスポンス

id
string
トランザクションID
request_id
string
リクエストID(決済作成時に発行されたID)
status
string
ステータス
amount
number
決済金額
currency
string
通貨コード
capture_method
string
キャプチャ方式
connector
string
使用されたコネクタ
psp_reference
string
PSP側のトランザクションID
external_id
string
加盟店側の注文ID
amount_refunded
number
返金済み金額
refunds
array
返金履歴の配列
metadata
object
メタデータ
created_at
string
作成日時
updated_at
string
更新日時
curl https://api.sandbox.zafapay.com/v1/payments/tx_abc123 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
{
  "id": "tx_abc123",
  "request_id": "req_xyz789",
  "status": "completed",
  "amount": 100,
  "currency": "usd",
  "capture_method": "automatic",
  "connector": "card_processor",
  "psp_reference": "pi_xxxxx",
  "external_id": "order_12345",
  "amount_refunded": 0,
  "refunds": [],
  "metadata": {
    "customer_name": "山田太郎"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:31:00Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication using access token

Path Parameters

id
string
required

Transaction ID

Example:

"tx_abc123"

Response

Success

id
string

Transaction ID

Example:

"tx_abc123"

request_id
string

Payment request ID

Example:

"req_xyz789"

status
enum<string>

Status

Available options:
pending,
requires_action,
authorized,
completed,
failed,
canceled,
partially_refunded,
refunded
Example:

"completed"

amount
string

Payment amount (string format)

Example:

"17.62"

currency
string

Currency code

Example:

"usd"

capture_method
string

Capture method

Example:

"automatic"

psp_reference
string

PSP transaction ID

Example:

"pi_xxxxx"

external_id
string

Merchant's order ID

Example:

"order_12345"

amount_refunded
string

Refunded amount (string format)

Example:

"0"

refunds
object[]

Refund history

metadata
object

Metadata

created_at
string<date-time>

Created at

Example:

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

updated_at
string<date-time>

Updated at

Example:

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