reconcile-payout

Reconcile Payout

Reconcile a single Alternative Payments payout: retrieve the payout, list every transaction it settled, sum those transactions, confirm the total matches the payout amount, and trace each transaction back to its invoice and customer. This command is entirely read-only.

Prerequisites

• Valid Alternative Payments OAuth2 credentials configured (AP_CLIENT_ID, AP_CLIENT_SECRET)
• Environment selected (AP_ENVIRONMENT = production or demo)
• Scope payments:read

Steps

1. Authenticate with Alternative Payments

   BASE=https://public-api.alternativepayments.io
   TOKEN=$(curl -s -X POST "${BASE}/oauth/token" \
     -u "${AP_CLIENT_ID}:${AP_CLIENT_SECRET}" \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "grant_type=client_credentials" \
     | jq -r '.access_token')
   

2. Retrieve the payout

   curl -s "${BASE}/payouts/${PAYOUT_ID}" \
     -H "Authorization: Bearer ${TOKEN}"
   

3. List the payout's transactions (cursor-paginated)

   curl -s "${BASE}/payouts/${PAYOUT_ID}/transactions?limit=100" \
     -H "Authorization: Bearer ${TOKEN}"
   

   Loop on has_more / next_cursor, passing cursor=<next_cursor> per page.

4. Sum and compare — total the transaction amount values and compare to the payout's amount. Agreement within rounding = reconciled; otherwise flag a discrepancy.

5. Trace each transaction — for each transaction, resolve its invoice_id and customer_id so the deposit can be tied to specific receivables. Optionally fetch the customer name:

   curl -s "${BASE}/customers/${CUSTOMER_ID}" \
     -H "Authorization: Bearer ${TOKEN}"
   

6. Format and return the reconciliation report

Parameters