Payment Confirmation Status
The paymentConfirmation field provides the status of the payment landing in the client account. Webhooks can be received
for PaymentConfirmation updates by adding it to the PaymentRequest node subscription.
A Stitch intermediary account is required to use the paymentConfirmation field. For clients without a Stitch account, it
will appear as null for all paymentRequests.
The following table outlines the possible paymentConfirmation statuses:
| Status | Description |
|---|---|
| null | The PaymentConfirmation will be null on any paymentRequest that is not completed |
| PaymentPending | The PaymentRequest has been completed, but the payment has not yet been received into the Stitch intermediary account |
| PaymentReceived | The payment was received into the Stitch intermediary account |
| PaymentUnsettled | The payment was not received into the Stitch intermediary account after 7 days |
Here is an example of a paymentInitiationRequest query including paymentConfirmation:
Webhooks can also be received for payment confirmation updates by subscribe to the paymentConfirmation event type. An
example is as follows:
Simulating Payment Confirmations
In order to simulate receiving a payment confirmation for a test client, the testClientCreatePaymentConfirmation mutation
can be used. This will change the status of the paymentConfirmation field to PaymentReceived.