POST and PATCH endpoints to provide the ability to edit specific balance attributes, depending on the end-user access level.
Learn more about campaign management with our API here!
Endpoints
Verb | Endpoint | Description |
|---|---|---|
GET |
| Get All Balances |
GET |
| Get a specific balance |
POST |
| Create a new balance |
POST |
| Add funds to an existing balance |
POST |
| Change a balance dates |
PATCH |
| Update balance fields without changing the funds |
Balance response attributes
Retailer-assigned purchase order number. Replaces the former
poNumber field.Values: string, nullableThe amount of billable funds allotted to the balance. The amount should be based on the currency types of an account that the balance link to. User may want to confirm currency with their account settings.For uncapped budgets pass
null as the deposited amount.Values: decimal value or null for uncapped balancesAmount of funds remaining until the balance cap is hit. The balance will return a
null value if no funds have been used.Values: between 0 and depositedThe balance start date in the account timeZone if not setValues: YYYY-MM-DD
Balance end date in the account timeZone, wrapped in a Nillable object to allow explicit clearing.Shape:
{ "value": "YYYY-MM-DD" | null }Computed value that defines whether the balance will be billed by the retailer or by Criteo.Values:
billByRetailer, billByCriteoGet all balances
This endpoint lists all balances in an account. Response results will be provided in paginated form. Sample RequestGet specific balance
Retrieves the balance details of one specific balances belonging to an account Sample RequestCreate a new account balance
The endpoint allows you to create a new account balance Sample RequestReadjust funds for an existing balance
Adjust an existing balance funds without changing other balance attributes. Sample Request In the example below, the call requests a $10 deduction from an existing balance. The original balance was $100, and after the call, the new balance amount is now $90. To remove funds from a balance set thedeltaAmount to a negative number, whereas set a positive amount to add funds.