PayFacto API - v2.0 - GET /refunds/{refundId}

Retrieves a single refund by its unique identifier.

Prerequisites

🔑

Authentication — HTTP Basic Auth

All v2.0 endpoints use HTTP Basic Authentication. Set Authorization: Basic base64(username:password). Contact PayFacto for credentials.

🌐

Environment Base URLs

UAT: https://uat.ca.api.payfacto.cloud/payments/v1 | Production: https://ca.api.payfacto.cloud/payments/v1

📋

Content-Type

All request bodies require Content-Type: application/json.

🔄

Idempotency

Include Idempotency-Key header (max 64 chars) on POST requests. 200 = duplicate; 201 = newly created.

💵

Amounts

All monetary amounts are positive integers in cents. $12.99 = 1299.

Request

GET https://uat.ca.api.payfacto.cloud/payments/v1/refunds/{refundId}

Path parameter

Parameter	Type	Description
refundId	string (UUID) · required	Unique refund identifier.

Request — Code Example

cURL

curl -X GET "https://uat.ca.api.payfacto.cloud/payments/v1/refunds/3a2049fb-6c9f-433d-9cef-701b6843f0cd" \
  -H "Authorization: Basic YOUR_BASE64_CREDENTIALS"

Response

Response fields (refund object)

Field	Type	Description
id	string (UUID)	Unique refund identifier.
amount	integer	Refund amount in cents.
chargeId	string (UUID)	The charge that was refunded.
failureReason	string	If failed: LOST_OR_STOLEN_CARD, EXPIRED_OR_CANCELLED_CARD, UNKNOWN.
metadata	object	Key-value pairs.
originalTransactionTime	string (ISO 8601)	UTC timestamp of original charge.
paymentMethod	object	Payment method used for the refund.
reason	string	Refund reason from request.
result	object	Auth result including `authCode`.
status	string	SUCCEEDED, FAILED, or VOIDED.
transactionTime	string (ISO 8601)	UTC timestamp when this refund was created.
voidDetail	object	Void details if voided.
error	object	Error object on failure.

Response — Code Examples

JSON — 200 Success

{
  "id": "3a2049fb-6c9f-433d-9cef-701b6843f0cd",
  "amount": 1299,
  "chargeId": "a1822999-099d-4fb1-a354-77be553a5b22",
  "reason": "REQUESTED_BY_CUSTOMER",
  "result": { "authCode": "012345" },
  "status": "SUCCEEDED",
  "transactionTime": "2024-05-15T17:00:01Z"
}

JSON — 404 Not Found

{
  "error": { "code": "NOT_FOUND", "type": "INVALID_REQUEST_ERROR", "message": "Not Found" }
}

Error / HTTP Status Codes

HTTP Status	Meaning	Recommended Action
200	OK — Previously created (same idempotency key)	Check `status` field in response body
201	Created — New resource created	Store the `id` for future operations
400	Bad Request — Invalid payload	Check `error.details` and `error.invalidFields`
402	Payment Required — Issuer declined	Check `result.declineCode` — do not retry automatically
404	Not Found	Verify the ID in the request path
422	Unprocessable — Invalid state	Check `error.message`
500	Internal Server Error	Retry with backoff; contact PayFacto Support if persistent