Skip to main content

TempLinkPaymentStatusSummary

statusstringrequired

Collection status for this specific temporary link only.

Possible values: [unpaid, partial, paid, overpaid]

Example: partial
requestedAmountdecimalrequired

Target amount configured on the temporary link.

Example: 150
paidAmountdecimalrequired

Amount collected through completed payments for this temporary link.

Example: 75
remainingAmountdecimalrequired

Amount still pending on this temporary link.

Example: 75
paymentCountintegerrequired

Total number of payment attempts linked to this temporary link.

Example: 2
completedPaymentCountintegerrequired

Number of completed payments linked to this temporary link.

Example: 1
currencystringrequired

Currency of the temporary link amount.

Example: USD
TempLinkPaymentStatusSummary
{
"status": "partial",
"requestedAmount": 150,
"paidAmount": 75,
"remainingAmount": 75,
"paymentCount": 2,
"completedPaymentCount": 1,
"currency": "USD"
}