From the corporate account to spending tracking.
API organises the corporate operation in separate resources, keeping accounts, carriers, cards, purchases, invoices and analyses within the same public contract.
Count, balance and limit.
Please check the account status, availability and request limit recharges.
Carriers and cards.
Create carriers, issue virtual or physical cards, and apply rules of use.
Purchases, invoices and analytics.
Keep track of expenditure, cost centers, invoices and analytical clusters.
Status of the corporate account
Activation is not done by public API. The endpoint GET /corporate/cards/account remain available in any State to consult the current status of the appeal.
Activation not yet requested.
Updated contract must be accepted in Account IOPAY.
Request under review by the IOPAY team.
Available API operations.
suspended indicates a resource not available for the account.Basic flow
Confirm that the appeal is active.
Define identity, limit, range and cost center.
Choose type, limit and restriction of establishment where applicable.
Use shopping, billing, cost centers and analytics.
Creating a carrier
{
"name": "NOME HOLDER",
"tax_id": "12345678909",
"amount": 1000,
"interval": "month",
"center_cost": "MeuCenterCost"
}Creating a card
{
"holder_id": "{{holder_id}}",
"name": "Google Ads",
"limit": 100000,
"interval": "month",
"type": "virtual",
"merchant": "GOOGLE"
}merchant It specifies a restricted establishment, not the card name. Use it name as an internal identification. Forget about merchant or send null does not define a restriction for that field.Resources and endpoints
| Area | Operations | Main route |
|---|---|---|
| It counts | Status, balance, limit and charge. | /corporate/cards/account · /balance · /recharge |
| Cardholders | List, consult, create, update and cancel. | /corporate/cards/holders |
| Card by carrier | Check out a cardholder's cards and shopping. | /holders/{holder_id}/cards · /purchases |
| Cards | List, consult, create, update and consult sensitive data. | /corporate/cards · /{card_id}/secrets |
| Purchases | General listing and by card/carrier. | /corporate/cards/purchases |
| Cost centers | Aggregate expenses and details of the center. | /corporate/cards/cost-centers |
| Statements | List, change maturity and generate payment. | /corporate/cards/invoices |
| The following is the list of the following: | Summary and groupings of expenditure. | /corporate/cards/analytics |
Limits, carriers and cost centres
Limit by rule.
The holder receives amount and interval day, week or month.
Virtual or physical.
Associate the card with the carrier and set the merchant limit, interval and restriction when necessary.
Context of the operation.
Group expenses and consult purchases, amounts and cashback by cost centre.
Resources and pageing
Successful responses identify the appeal by resource. Listings use a standardised envelope with items, limit, total, offset, has_more and query_count.
{
"resource": "list",
"sort": "time-descending",
"items": [],
"limit": 100,
"total": 0,
"offset": 0,
"has_more": false,
"query_count": 0
}limit and offset they're supported in the listings The default limit is 100 and the maximum is 1000 In Compatible Consultations ?refresh=true update the IOPAY database with the latest issuer bank data before the response.Invoices and analysis of expenditure
Winning and paying.
List invoices, set the due date between 1 and 28 and manage payment data, which may include brcode and link.
Consolidated expenses.
See total expenditure, quantity of purchases, cashback and groupings by category, cost centre, carrier and monthly evolution.
Card data
The endpoint GET /corporate/cards/{card_id}/secrets return PAN, CVV, validity and TTL when necessary for the operation.
Public collection
The collection brings together the 23 documented endpoints, success and error examples for relevant account, recharge, carrier and operation flows.