DOCS

Manual payment capture

Manual payment capture

Capture payments on demand when fulfilling orders outside of the Zonos Dashboard.

When delayed payment capture is enabled, Zonos automatically captures payment three days after an order is placed or until the order is shipped from the Zonos Dashboard.

If you're fulfilling orders outside of the Dashboard, you can use our orderPaymentCapture mutation to capture payment before the 3 day delay period or before the order is shipped, whichever comes first.

Capturing payment manually 

To capture payment for an order, call the orderPaymentCapture mutation, passing the orderId as an input parameter.

Manual payment capture mutation

1
2
3
4
5
6
7
8
9
10
11
mutation manualCapture {
  orderPaymentCapture(
    input: { orderId: "order_a190981e-276a-4daf-927e-fc17f62a49cc" }
  ) {
    id
    charges {
      id
      paymentStatus
    }
  }
}

Verifying payment status 

An order can have one of the following statuses:

  • UNPAID
  • PAID
  • PARTIALLY_REFUNDED
  • REFUNDED
  • VOIDED

After you have called to capture payment, you can query the order to see that the payment status for the order has changed to PAID.

Query order payment status

1
2
3
4
5
6
7
8
9
query order {
  order(orderId: "order_a190981e-276a-4daf-927e-fc17f62a49cc") {
    id
    charges {
      id
      paymentStatus
    }
  }
}

Was this page helpful?