SET Direct Deposit API · Keys
Pin your key to your servers' addresses
POST/api/partner/keys/allowed_cidrs
Sets the addresses your partner key may be used from: up to 20 IPv4 or IPv6 addresses or CIDR ranges, or [] for any address. A request with the key from anywhere else is refused with 403 ip_not_allowed. Event key.allowed_cidrs_changed.
Body
allowedCidrsstring[]required- The full list; it replaces the one before.
Notes
- Only the current partner key, or an admin on the partner dashboard, can change the list. A SET API key with the
direct_depositscope gets403 partner_key_required; the previous key during an overlap gets409 key_not_current. - The current key cannot shut itself out: a list that leaves out the address you are calling from is
409 would_lock_out. See Pinning a key to your servers.
Errors
400 body_invalid400 cidrs_invalid403 partner_key_required409 key_not_current409 would_lock_out401 partner_key_required401 partner_key_invalid403 ip_not_allowed429 rate_limited503 direct_deposit_disabled