Integrations & ERP Custom Fields / API Developer Documentation

Payment through API

After the payment is made from the Customer Portal web page, the invoice status changes to Pending.

While in this status, it is not possible to apply any payment on the Statement page.


If the system does not receive any payment confirmation from your ERP, its status remains Pending for 7 days, after which it expires.

To find out about any payments made through YayPay, request payment info from YayPay's API by calling the GET/v2/yaypay_payments endpoint:


Until calling this endpoint, the payment is marked as Applied in YayPay’s Cash App and is seen in OPEN PAYMENTS.

To move the payment from OPEN PAYMENTS to CLOSED PAYMENTS, follow these steps:

  1. When you create a payment in Cash App (with or without allocation to invoice), select it and click Push to ERP.

  2. When the payment is pushed to the ERP, the call includes the external_id value of the payment which is generated by YayPay. This external_id value is used to compare it with that of the received payment to change its status to Synced.

  3. Update the invoice and payment open balance, as well as its status by calling the POST/invoices endpoint.

  4. The invoice records will now reflect the changes in Cash App.

Payments are also shown on the Customer Portal web page.

The whole process is summarized by these diagrams:

Process Flow

The following diagram shows how the payment statuses change:

Statuses Flow











Can't find what you need?

Contact our support team support@yaypay.com for help.