Skip to main content
GET
Read payment details
Use the Sarafa tx_reference as id, for example TX7A2B9C4D1E0. This is different from your merchant reference and is not a database ID. The payment must belong to your organization’s account. The response includes transaction and quote. A quote can be null for records without payment pricing. Transaction details include exchange_details, and approval requests also include expires_at and reason. The top-level status: "success" only confirms the read succeeded. Check transaction.status before fulfilling an order. For hosted payment links, you can also read the checkout using your merchant reference.

Authorizations

Authorization
string
header
required

Use the full key from the merchant dashboard API section. Keep it on your server.

Path Parameters

id
string
required

Sarafa tx_reference, not the merchant reference or a database ID.

Example:

"TX7A2B9C4D1E0"

Response

Payment status and quote. This example is awaiting approval.

status
enum<string>
required
Available options:
success
transaction
object
required
quote
object | null
required