UpPromote Public API
  1. Payment
UpPromote Public API
  • API overview
  • Affiliate
    • Get affiliates
      GET
    • Get affiliate by ID
      GET
    • Create an affiliate
      POST
    • Approve/Deny affiliate
      POST
    • Set upline for an affiliate
      POST
    • Move an affiliate to a program
      POST
    • Connect a customer to an affiliate
      POST
  • Coupon
    • Get coupons
      GET
    • Assign a coupon to an affiliate
      POST
  • Payment
    • Get unpaid payments
      GET
    • Get paid payments (History)
      GET
    • Count total paid payments
      GET
    • Get a payment by ID
      GET
    • Mark as paid a manual payment
      POST
  • Referral
    • Get list referrals
      GET
    • Get a referral by ID
      GET
    • Create a referral
      POST
    • Add referral adjustment
      POST
  • Webhook
    • Get webhook subscriptions
      GET
    • Subscribe a webhook event
      POST
    • Update a webhook subscription
      PUT
    • Delete a webhook subscription
      DELETE
  • Webhook Event Payload
    • Webhook overview
    • Referral new
      POST
    • Referral approved
      POST
    • Referral denied
      POST
    • Referral status changed
      POST
    • Affiliate new
      POST
    • Affiliate approved
      POST
    • Affiliate inactive
      POST
    • Affiliate status changed
      POST
    • Payment paid
      POST
  1. Payment

Get unpaid payments

GET
/api/v2/payments/unpaid
The payment_method field accepts the values no_payment_method, paypal, bank, wise, debit, cheque, venmo, paytm, upi, store_credit, other.

Request

Query Params

Header Params

Body Params multipart/form-data

Responses

🟢200Success
application/json
Body

🔴500Server Error
🟠401Unauthorized
🟠422Parameter Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://aff-api.uppromote.com/api/v2/payments/unpaid' \
--header 'Accept: application/json' \
--header 'Authorization: ****************************'
Response Response Example
200 - Example
{
    "status": 200,
    "message": "success",
    "data": [
        {
            "affiliate_id": 1969236,
            "affiliate_email": "example1@gmail.com",
            "total_referrals": 2,
            "payment_method": null,
            "total_commission": 56.98,
            "total_sales": 598.75,
            "total_products": 1
        },
        {
            "affiliate_id": 1987024,
            "affiliate_email": "example2@outlook.com",
            "total_referrals": 2,
            "payment_method": "store_credit",
            "total_commission": 553.817,
            "total_sales": 10069.34,
            "total_products": 1
        }
    ]
}
Modified at 2025-10-06 04:44:48
Previous
Assign a coupon to an affiliate
Next
Get paid payments (History)
Built with