Skip to main content
GET
/
v1
/
payments
/
{id}
Get Payment
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",
  "psp_reference": "pi_xxxxx",
  "external_id": "order_12345",
  "amount_refunded": "0",
  "refunds": [
    {
      "id": "orf_xyz789",
      "amount": "5.50",
      "status": "succeeded",
      "reason": "Customer request",
      "created_at": "2024-01-15T10:35:00Z"
    }
  ],
  "metadata": {},
  "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"