Test Payment Processing in Sandbox

Processing Payments 

Payment processing involves the following workflows:

1. Check Payee Status
   • Payable/Not Payable: You will get a deferred status upon uploading a payment for a "Not Payable" payee. To avoid this, you can find out the status via IPN or API.

   • IPN - payee_details_changed This IPN notifies of details changed for a payee and is triggered on every iFrame step where the payee details are updated.  Look for the variable "is_payable" TRUE

     API - GetExtendedPayeeDetailList  Look for the variable "Payable" TRUE

     •  
2. Payment Uploads to Zipalti (CSV or API) - Before clicking on "Approve" or "Decline" in Zipalti
   • Upon uploading the payment batch to Zipalti, you will see one of the following statuses against individual payments in that payment batch - Submitted, Deferred/Deferred Internal. These statuses would differ if you have a "No Approval" workflow on Payments.
   
   
   • API Error Codes - If you do not see one of these statuses then you may run into line error codes. 
   • The above two points are valid for Payee Cashout functionality as well

   • IPN - payment_submitted This IPN will be triggered only for the individual payments with the status "Submitted", and not for Payment Batch IPN - deferred This IPN will be triggered only for the individual in a payment batch with the status "Deferred".

     API - ProcessPayments This API will allow you to push/upload the payment batch to Zipalti. A payment batch can have a single payment or multiple payments

3. Canceled Payments 
   • Payment can be canceled before clicking on the Approve button in Zipalti. You can cancel individual payments in a batch before Approving the batch. If scheduled, it can still be canceled one day before the planned date

   • IPN - payment_cancelled

     APIs -  To fetch RefCode - GetUpdatedPayments To fetch status and other payment details - GetExtendedPODetailsList

     •  
4. Approve/Decline Payment Batch
   • A payer can approve or decline a payment batch in Zipalti after uploading it
   • You cannot delete a payment batch or individual payments once uploaded. You can either Decline the entire batch or Cancel individual payments 
   • A payer can also request for no approval workflow, however, we recommend leaving it on for the first few months until you get comfortable with the system. You can request your IM to turn off the Approvals for testing purposes

   • IPNs -  payments_group_approved and payments_group_declined

     APIs - There is no API at present for the payment batch. Every payment uploaded is a batch even if it has a single payment

5. Payment processing - After clicking on "Approve" in Zipalti
   • Upon uploading a payment batch to Zipalti, the payer has to approve it, unless you have a no-approval workflow.
   • After approval, the individual payments will have one of the statuses: Paid, Rejected, Voided Checks, Deferred (if scheduled payment)
   • After processing all the payments in a payment batch, the status against the batch will say "COMPLETED". Only individual payments will have the actual transaction status as mentioned above. Transaction processing time is typically 1-2 business days after which the status will update to Paid/Rejected 

   • Paid - You can request your IM to change the status to Paid for testing purposes on SB.  IPN - completed Rejected/Voided Checks - You can request your IM to change the status to Paid for testing purposes on SB.  IPN - error Deferred - If the payee is "Not Payable" the status will automatically change to Deferred  IPN - deferred

     APIs -  To fetch RefCodes - GetUpdatedPayments To fetch status and other details - GetExtendedPODetailsList

      
6. Compliance OFAC Hit
   • This status change against individual payments cannot be tested on SB
   • On production, you can set up the following two IPNs that will alert you that Zipalti has requested your payee to submit additional compliance documents 
   • • IPN - payee_compliance_document_request
     • IPN - payee_compliance_document_closed 
      
   • Payment processing can take more than 2 business days to be processed in such a scenario. We request you create a support ticket for more information on such payment transactions that take longer than 2 business days
7. Paper Check Payments (Payment Method)
   • Upon uploading a payment with a payment method type as Paper Check the status changes to Paid immediately. This can be tested on SB as well. 
   • The status changes to "Cleared" after the payee encashes the check. This status change cannot be tested on SB
   • • IPN - Check Cashed