Query

paymentLink

Get a payment link by its code (PaymentLink.code).

The code is the identifier contained in the payment link URL that was sent to the customer. Resolves to null if no payment link with the given code exists.

A payment link that was canceled with Mutation.cancelPaymentLink still resolves, so you can tell a canceled link apart from an unknown one. For a canceled link, PaymentLink.isRevoked and PaymentLink.isExpired are true, PaymentLink.isPaid is false, PaymentLink.items, PaymentLink.downloadsV2 and PaymentLink.paymentMethods are empty, PaymentLink.grandTotal is zero, and PaymentLink.owner and PaymentLink.customerData are null. Always check PaymentLink.isRevoked and PaymentLink.isExpired before offering the link for payment.

To let the customer pay, read PaymentLink.paymentMethods and pass the chosen PaymentMethod.key to Mutation.payPaymentLink. Once the payments connected to the link cover PaymentLink.grandTotal, PaymentLink.isPaid flips to true and PaymentLink.downloadsV2 resolves the documents the customer is entitled to; poll this field to observe that transition.