Orders API Doubts

Answered

Pedro Rios

August 09, 2021 15:17

Hello,

I'm using the Orders API to get information about an order. The order has checks and each check may have payments. That's fine.

I can read in the API reference page that Payment has the property paymentStatus with these possible values: OPEN, PROCESSING, AUTHORIZED_AT_RISK, AUTHORIZED, ERROR, ERROR_NETWORK, DENIED, PROCESSING_VOID, VOIDED_AT_RISK, CANCELLED, CAPTURE_IN_PROGRESS, CAPTURED, VOIDED

I know when the status of the payment is CAPTURED then the payment is applied to the order, and when the status of the payment is VOIDED or ERROR this payment is NOT applied to the order.

I need to know which other statuses are applied to the order and which ones don't.

Thanks in advance

0

• 

  Will MacReynolds

  August 10, 2021 16:48

  Hi Pedro,

   
  To clarify which statuses will result in a successful payment; you can expect the following "AUTHORIZED", "CAPTURE_IN_PROGRESS", and "CAPTURED".

  However I'd like to provide color on "CAPTURE_IN_PROGRESS" as this status is reflected when a batch of payments is in process of being captured and should eventually become "CAPTURED". This is expected for very short periods of time during our Toast Auto-Capture process after 4:00am local time or during a Manual Batch completed by the staff on-site. Similarly, "PROCESSING" is a status that should be expected for short periods of time and will result as a success or denial. 

  All other responses are to share insight into what occurred when attempting to authorize a payment or if further action was taken to reconcile the payment after it was captured, for example "PROCESSING_VOID" or "VOIDED".

  We'll be adding further clarification of each paymentStatus in our documentation guide in the near future but please let me know if there's anything else I can clarify for you in the meantime. 

  Best,

  Will 

  0

Please sign in to leave a comment.