Platform Partners

Register a creator: POST /api/partner-payees

Authenticate with X-Game-Secret-Key.

{
  "partner_reference": "creator-001",
  "legal_name": "Sam Creator",
  "email": "sam@example.com",
  "country": "GB",
  "payee_type": "individual"
}

• • partner_reference: your own id for the creator, 1 to 128 characters from A-Z a-z 0-9 . _ : @ -, unique in your account. It comes back in webhooks, so don't use personal data such as an email address.
• • legal_name: the creator's legal name, or the registered business name.
• • country: an ISO 3166-1 alpha-2 code; a country under comprehensive sanctions returns 400 COUNTRY_NOT_SUPPORTED. payee_type: individual or business.

201 returns {success, payee, invite} with status: "invited". invite is {sent: true, expires_at}, or {sent: false, error_code, error} when INVO did not email the link; the creator is registered either way. ACCOUNT_NOT_VERIFIED there means INVO emails creators once your company verification is complete: resend the invite then. Sending the same partner_reference with the same details returns 200 with duplicate: true; with different details, 409 PARTNER_REFERENCE_CONFLICT. A game with no owner account returns 403 GAME_HAS_NO_OWNER.

payee_id is an opaque string starting cp_; store it as a string. The payee always shows the legal_name, email, country and payee_type you registered, and erased: true once the creator's details were erased (such a creator can't be invited or paid). payable is true when nothing on INVO's side stops a payout right now, and payable_blockers lists why not when it is false: erased, closed, not_verified, verification_expired, terms_not_accepted, bank_not_verified or not_payable_now (no action is needed from you; try again later). A game's key reads only the creators registered through that game; the console shows every creator on the account.

• • GET /api/partner-payees: this game's creators, newest first (limit, offset, status).
• • GET /api/partner-payees/{payee_id}: one creator.
• • POST /api/partner-payees/{payee_id}/resend-invite: email the creator a new link (the old one stops working). Links last 14 days. Allowed while the creator is invited, rejected or expired; otherwise 409 INVITE_NOT_NEEDED. 409 PAYEE_ERASED for an erased creator, and 429 INVITE_RATE_LIMITED with retry_after_seconds when invites are sent too often. If INVO asked the creator to update their details, a resend sends INVO's update notice again, with its reason.
• • POST /api/partner-payees/{payee_id}/remove: remove a creator from your program. The status becomes closed and INVO tells the creator. Refused with 409 PAYEE_HAS_PAYOUTS_IN_FLIGHT while a payout to them is still being processed (payouts_in_flight_by_status counts them by status). A requested payout can be cancelled; otherwise wait until it completes, fails or is declined. Removing is not a block: you can register the same person again under a new partner_reference.

In sandbox, invites go only to the account owner's or a team member's address, so register a test creator with one of those to try the page.

Creator statuses

• • invited: registered; INVO has emailed the creator a link.
• • details_submitted: the creator has sent their details; INVO is reviewing them.
• • verified: INVO has verified the creator and their bank account. Only a verified creator can be paid.
• • rejected: INVO asked the creator to correct or update something, and emailed them what to change.
• • suspended: INVO has stopped payouts to this creator. Final.
• • expired: the verification is more than a year old; INVO has emailed the creator to verify again.
• • closed: the creator is no longer in your program (you removed them, or they asked INVO to close their record).

INVO tells the creator the outcome itself and does not share the reason with you. payee.status_changed fires when a creator is registered and on every status change, and never carries the creator's name or email.

Pay a creator

Send the payout request with payee_id instead of a bank account:

POST /api/partner-payouts/request
X-Game-Secret-Key: <the key of the game the creator was registered through>

{
  "amount_usd": "250.00",
  "contact_email": "ops@example.com",
  "payee_id": "cp_3f9a1c2b7d4e5f60718293a4",
  "client_request_id": "<uuid>",
  "partner_note": "October revenue share"
}

• • The money comes from the earnings INVO owes your game, with the same 400 INSUFFICIENT_OWED_BALANCE check as a payout to your own bank.
• • The payout fee (1% of the payout, capped at $500 per payout, unless your agreement says otherwise) is taken from the payout. The creator receives net_payout_usd.
• • Send exactly one of payee_id or a bank destination; both together return 400 PAYEE_DESTINATION_FIXED. On a creator payout bank_account is null.
• • amount_usd is in USD with at most two decimal places. A creator whose bank account is in another currency receives USD, converted by their bank.
• • The same client_request_id with the same amount and creator returns the original payout; with a different amount or creator, 409 IDEMPOTENCY_KEY_REUSED.
• • The first payout to a creator registered with the game key has owner_confirmation_required: true. INVO approves it only after your account owner confirms it in the console.

Refusals:

• • 404 PAYEE_NOT_FOUND: not a creator of this game.
• • 409 PAYEE_NOT_VERIFIED: the creator is not verified right now. Check their status: they may still be finishing, or INVO may be reviewing them.
• • 409 PAYEE_VERIFICATION_EXPIRED, 409 PAYEE_BANK_NOT_VERIFIED: INVO has asked the creator to verify again or to add a bank account.
• • 409 PAYEE_CLOSED: the creator is no longer in your program.
• • 409 PAYEE_TERMS_NOT_ACCEPTED: the creator hasn't accepted INVO's current Payee Terms yet. INVO asks them to on their next visit.
• • 409 PAYEE_NOT_PAYABLE: the creator can't be paid right now. No action is needed from you or the creator; try again later.

INVO emails your account owner about every creator payout request. A creator payout still in requested can be cancelled with POST /api/partner-payouts/{payout_id}/cancel: its status becomes cancelled and the money is free again at once. Anything past requested returns 409 PAYOUT_NOT_CANCELLABLE, and a payout to your own bank returns 404 NOT_FOUND. If INVO stops paying a creator, it declines their payouts that have not started to leave INVO, and the money is free again.

GET /api/partner-payouts?payee_id=cp_... lists one creator's payouts. payout.status_changed carries payee_id (null for a payout to your own bank) and never carries the creator's bank or personal details. partner_message is a note INVO wrote for you, when there is one.

If the creator's bank sends the payment back, the payout moves to returned with return_reason_code: "returned": what the bank sent back is owed to your game again and the payout fee is not refunded. INVO contacts the creator about a new bank account; until it is verified, payouts to them are refused.

INVO issues each creator's year-end tax form. A creator payout is not counted as your own income on your INVO earnings statement.