Skip to main content
GET
Get a payment

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Response

Success.

id
string<uuid>
required
status
enum<string>
required
Available options:
CONFIRMED,
CANCELLED,
REFUNDED,
HELD,
HOLD_RELEASED,
HOLD_EXPIRED
amount
number
required
currency
string
required
createdAt
string<date-time>
required
operationCode
integer

The reference printed on receipts and shown in the dashboard.

type
string

CARD_PRESENT or CARD_NOT_PRESENT.

fee
number | null

The percentage fee charged to this merchant on this payment.

terms
integer

Installments agreed. 1 for a single payment.

paidTerms
integer

Installments already settled to the merchant.

periodicity
string | null
financingMethod
string | null
source
string | null

Where the payment originated, e.g. SHAREPAY_PAYMENT_LINK.

refundedAt
string<date-time> | null
heldAmount
number | null

What the bank authorized. Differs from amount after a partial capture.

heldAt
string<date-time> | null
capturedAt
string<date-time> | null
holdReleasedAt
string<date-time> | null
holdExpiresAt
string<date-time> | null

When the authorization lapses.

holdExpired
boolean

Only meaningful while the payment is HELD.

holdDaysRemaining
integer | null

Only set while the payment is HELD.

card
object | null

The card, masked. The full number and the stored token are never returned.

customer
object | null
paymentIntentId
string<uuid> | null
oneTimePaymentId
string<uuid> | null
paymentMethodId
string<uuid> | null
subscriptionId
string<uuid> | null