Skip to main content
GET
/
api
/
gateway
/
payments
/
{paymentId}
Get a payment
curl --request GET \
  --url https://dash.getopenrails.com/api/gateway/payments/{paymentId}
{
  "id": "<string>",
  "amount": 123,
  "currency": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "customerId": "<string>",
  "invoiceId": "<string>",
  "sessionId": "<string>",
  "route": {
    "id": "<string>",
    "label": "<string>"
  },
  "fees": {
    "buyer_fee": 123,
    "gateway_fee": 123,
    "merchant_net": 123,
    "total": 123
  },
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.getopenrails.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

paymentId
string
required

A pay_* payment ID or chk_* checkout session ID.

Response

Payment record

id
string
required

Payment ID with pay_* prefix.

object
enum<string>
required
Available options:
payment
amount
number
required
currency
string
required
status
enum<string>
required
Available options:
pending,
paid,
failed
ledgerStatus
enum<string>
required
Available options:
pending,
settled,
refunded
created
string<date-time>
required
customerId
string
invoiceId
string
sessionId
string
route
object
fees
object
metadata
object