URL
http://[platform_URL]/api/manager/get-payments-list?FinancesParams[types]=1,1&FinancesParams[filter]=1,1,1&expand=affiliate&page=1&per-page=1000
Parameters
| Field Name | Required | Description |
|---|---|---|
| api-key | Yes | Ask your Admin for API activation. API Key could be found on your Profile page. |
| FinancesParams[types] | Yes |
1,1 (required, the same for all requests). First param - Affiliates (1 - show, 0 - not show). |
| FinancesParams[filter] | Yes |
1,1,1 (required, the same for all requests). First param - Paid (1 - show, 0 - not show). |
| expand | Yes | affiliate (required, the same for all requests) |
| page | Yes | 1 |
| per-page | Yes | 1000 |
| FinancesParams[dateFrom] | Yes | Example: 02/21/2016 |
| FinancesParams[dateTo] | Yes | Example: 02/21/2016 |
| FinancesParams[affiliates] | No | Affiliates IDs |
| FinancesParams[advertisers] | No | Advertisers IDs |
Output Parameters
| Field Name | Description |
|---|---|
| id | The request ID |
| type | User type (5=affiliate, 4=advertiser) |
| user_id | User ID |
| source | Balance source (1=main balance, 2=referral balance) |
| amount | Payment amount |
| notes | Notes for the payment |
| "status": { "id": 3, "title": "In Progress" } |
Payment status (1=Paid, 2=Unpaid, 3=In Progress) |
| payment_date | - |
| added | Payment add date (yyyy-mm-dd hh:mm:ss) |
| User info | |
| id | User ID |
| type | User type (1=affiliate, 2=advertiser) |
| name | User name |
| affiliate_type | Affiliate type (1=Basic, 2=Premium) |
| account | Main balance value |
| ref_account | Referral balance |
| payment_details | Details (Account number, WebMoney wallet, ID etc.) |
| payment_type | Payment method (1=Bank Wire, 2=WebMoney, 3=PayPal) |
| payment_terms | Payment terms (1=NET 0, 2=NET 7, 3=NET 14, 4=NET 30, 5=NET 60) |
| fname | First name |
| lname | Last name |
| phone | Phone number |
| fax | - |
| title | - |
Sample
Request
http://demo.scaleo-up.com/api/manager/get-payments-list?api-key=9eb500a476603546a779e6418117ef0403aa3f64&FinancesParams[types]=1,1&FinancesParams[filter]=1,1,1&expand=affiliate&page=1&per-page=1000&FinancesParams[dateFrom]=07/01/2017&FinancesParams[dateTo]=07/30/2017
Response
{
"code": 0,
"status": 200,
"count": 3,
"payoutRequests": [
{
"id": "52",
"type": "5",
"user_id": "3",
"source": "1",
"amount": "34.00",
"notes": "",
"status": {
"id": 3,
"title": "In Progress"
},
"payment_date": null,
"added": "2017-07-07 16:28:58",
"affiliate": {
"id": "3",
"type": "1",
"name": "Basic SPONSOR aff",
"affiliate_type": "1",
"account": "138.20",
"ref_account": "4.12",
"payment_details": "ooollooo",
"payment_type": "3",
"payment_terms": "3",
"fname": "Mrs.",
"lname": "First",
"phone": "123654681",
"fax": "NET 14",
"title": "PayPal"
}
}
]
}