A restricted key calls only the operations its permissions cover. Each resource below has a read permission, rak_<resource>_read, which covers its GET operations, and a write permission, rak_<resource>_write, which covers all of its operations, the reads too. A read-only resource has no write permission, so no restricted key can change it. Paths match leading whole URL segments, where {id} matches any single segment. The first matching resource in the table applies, so customer payment-method paths use payment_method, not customer. A call the key cannot make answers 403. If the operation has a permission, the message names it; otherwise it says restricted keys cannot use the operation. You choose the permissions when you create the key, as Authentication shows.
| Resource | Paths | Permissions |
|---|---|---|
charge | /v1/charges, /v1/refunds | rak_charge_read, rak_charge_write |
payment_intent | /v1/payment_intents | rak_payment_intent_read, rak_payment_intent_write |
payment_method | /v1/payment_methods, /v1/customers/{id}/payment_methods | rak_payment_method_read, rak_payment_method_write |
customer | /v1/customers | rak_customer_read, rak_customer_write |
setup_intent | /v1/setup_intents | rak_setup_intent_read, rak_setup_intent_write |
payout | /v1/payouts | rak_payout_read, rak_payout_write |
balance | /v1/balance, /v1/balance_transactions | rak_balance_read |
reserve | /v1/reserve | rak_reserve_read, rak_reserve_write |
dispute | /v1/disputes | rak_dispute_read, rak_dispute_write |
event | /v1/events | rak_event_read |
file | /v1/files, /v1/file_links | rak_file_read, rak_file_write |
product | /v1/products | rak_product_read, rak_product_write |
plan | /v1/prices | rak_plan_read, rak_plan_write |
payment_links | /v1/payment_links | rak_payment_links_read, rak_payment_links_write |
checkout_session | /v1/checkout/sessions | rak_checkout_session_read, rak_checkout_session_write |
webhook | /v1/webhook_endpoints | rak_webhook_read, rak_webhook_write |
payment_method_domain | /v1/payment_method_domains | rak_payment_method_domain_read, rak_payment_method_domain_write |
payment_method_configurations | /v1/payment_method_configurations | rak_payment_method_configurations_read, rak_payment_method_configurations_write |
account | /v1/account | rak_account_read |
charge#
Paths: /v1/charges, /v1/refunds. Permissions: rak_charge_read, rak_charge_write.
| Operation | Needs |
|---|---|
GET /v1/charges | rak_charge_read |
GET /v1/charges/search | rak_charge_read |
GET /v1/charges/{charge} | rak_charge_read |
POST /v1/charges/{charge} | rak_charge_write |
GET /v1/charges/{charge}/refunds | rak_charge_read |
GET /v1/charges/{charge}/refunds/{refund} | rak_charge_read |
GET /v1/refunds | rak_charge_read |
POST /v1/refunds | rak_charge_write |
GET /v1/refunds/{refund} | rak_charge_read |
POST /v1/refunds/{refund} | rak_charge_write |
payment_intent#
Paths: /v1/payment_intents. Permissions: rak_payment_intent_read, rak_payment_intent_write.
| Operation | Needs |
|---|---|
GET /v1/payment_intents | rak_payment_intent_read |
POST /v1/payment_intents | rak_payment_intent_write |
GET /v1/payment_intents/search | rak_payment_intent_read |
GET /v1/payment_intents/{intent} | rak_payment_intent_read |
POST /v1/payment_intents/{intent} | rak_payment_intent_write |
POST /v1/payment_intents/{intent}/cancel | rak_payment_intent_write |
POST /v1/payment_intents/{intent}/capture | rak_payment_intent_write |
POST /v1/payment_intents/{intent}/confirm | rak_payment_intent_write |
payment_method#
Paths: /v1/payment_methods, /v1/customers/{id}/payment_methods. Permissions: rak_payment_method_read, rak_payment_method_write.
| Operation | Needs |
|---|---|
GET /v1/customers/{customer}/payment_methods | rak_payment_method_read |
GET /v1/customers/{customer}/payment_methods/{payment_method} | rak_payment_method_read |
GET /v1/payment_methods | rak_payment_method_read |
GET /v1/payment_methods/{payment_method} | rak_payment_method_read |
POST /v1/payment_methods/{payment_method} | rak_payment_method_write |
POST /v1/payment_methods/{payment_method}/attach | rak_payment_method_write |
POST /v1/payment_methods/{payment_method}/detach | rak_payment_method_write |
customer#
Paths: /v1/customers. Permissions: rak_customer_read, rak_customer_write.
| Operation | Needs |
|---|---|
GET /v1/customers | rak_customer_read |
POST /v1/customers | rak_customer_write |
GET /v1/customers/search | rak_customer_read |
DELETE /v1/customers/{customer} | rak_customer_write |
GET /v1/customers/{customer} | rak_customer_read |
POST /v1/customers/{customer} | rak_customer_write |
GET /v1/customers/{customer}/tax_ids | rak_customer_read |
POST /v1/customers/{customer}/tax_ids | rak_customer_write |
DELETE /v1/customers/{customer}/tax_ids/{id} | rak_customer_write |
GET /v1/customers/{customer}/tax_ids/{id} | rak_customer_read |
setup_intent#
Paths: /v1/setup_intents. Permissions: rak_setup_intent_read, rak_setup_intent_write.
| Operation | Needs |
|---|---|
GET /v1/setup_intents | rak_setup_intent_read |
POST /v1/setup_intents | rak_setup_intent_write |
GET /v1/setup_intents/{intent} | rak_setup_intent_read |
POST /v1/setup_intents/{intent} | rak_setup_intent_write |
POST /v1/setup_intents/{intent}/cancel | rak_setup_intent_write |
POST /v1/setup_intents/{intent}/confirm | rak_setup_intent_write |
payout#
Paths: /v1/payouts. Permissions: rak_payout_read, rak_payout_write.
| Operation | Needs |
|---|---|
GET /v1/payouts | rak_payout_read |
POST /v1/payouts | rak_payout_write |
GET /v1/payouts/{payout} | rak_payout_read |
POST /v1/payouts/{payout} | rak_payout_write |
POST /v1/payouts/{payout}/cancel | rak_payout_write |
balance#
Paths: /v1/balance, /v1/balance_transactions. Read-only: rak_balance_read is its only permission.
| Operation | Needs |
|---|---|
GET /v1/balance | rak_balance_read |
GET /v1/balance/fluveo_payable_now | rak_balance_read |
GET /v1/balance/fluveo_payout_hold | rak_balance_read |
GET /v1/balance_transactions | rak_balance_read |
GET /v1/balance_transactions/{id} | rak_balance_read |
reserve#
Paths: /v1/reserve. Permissions: rak_reserve_read, rak_reserve_write.
| Operation | Needs |
|---|---|
GET /v1/reserve/holds | rak_reserve_read |
GET /v1/reserve/holds/{id} | rak_reserve_read |
GET /v1/reserve/plans | rak_reserve_read |
GET /v1/reserve/plans/{id} | rak_reserve_read |
GET /v1/reserve/releases | rak_reserve_read |
GET /v1/reserve/releases/{id} | rak_reserve_read |
dispute#
Paths: /v1/disputes. Permissions: rak_dispute_read, rak_dispute_write.
| Operation | Needs |
|---|---|
GET /v1/disputes | rak_dispute_read |
GET /v1/disputes/{dispute} | rak_dispute_read |
POST /v1/disputes/{dispute} | rak_dispute_write |
POST /v1/disputes/{dispute}/close | rak_dispute_write |
event#
Paths: /v1/events. Read-only: rak_event_read is its only permission.
| Operation | Needs |
|---|---|
GET /v1/events | rak_event_read |
GET /v1/events/{id} | rak_event_read |
file#
Paths: /v1/files, /v1/file_links. Permissions: rak_file_read, rak_file_write.
| Operation | Needs |
|---|---|
GET /v1/file_links | rak_file_read |
POST /v1/file_links | rak_file_write |
GET /v1/file_links/{link} | rak_file_read |
POST /v1/file_links/{link} | rak_file_write |
GET /v1/files | rak_file_read |
GET /v1/files/{file} | rak_file_read |
GET /v1/files/{file}/contents | rak_file_read |
product#
Paths: /v1/products. Permissions: rak_product_read, rak_product_write.
| Operation | Needs |
|---|---|
GET /v1/products | rak_product_read |
POST /v1/products | rak_product_write |
GET /v1/products/search | rak_product_read |
DELETE /v1/products/{id} | rak_product_write |
GET /v1/products/{id} | rak_product_read |
POST /v1/products/{id} | rak_product_write |
plan#
Paths: /v1/prices. Permissions: rak_plan_read, rak_plan_write.
| Operation | Needs |
|---|---|
GET /v1/prices | rak_plan_read |
POST /v1/prices | rak_plan_write |
GET /v1/prices/search | rak_plan_read |
GET /v1/prices/{price} | rak_plan_read |
POST /v1/prices/{price} | rak_plan_write |
payment_links#
Paths: /v1/payment_links. Permissions: rak_payment_links_read, rak_payment_links_write.
| Operation | Needs |
|---|---|
GET /v1/payment_links | rak_payment_links_read |
POST /v1/payment_links | rak_payment_links_write |
GET /v1/payment_links/{payment_link} | rak_payment_links_read |
POST /v1/payment_links/{payment_link} | rak_payment_links_write |
GET /v1/payment_links/{payment_link}/line_items | rak_payment_links_read |
checkout_session#
Paths: /v1/checkout/sessions. Permissions: rak_checkout_session_read, rak_checkout_session_write.
| Operation | Needs |
|---|---|
GET /v1/checkout/sessions | rak_checkout_session_read |
POST /v1/checkout/sessions | rak_checkout_session_write |
GET /v1/checkout/sessions/{session} | rak_checkout_session_read |
POST /v1/checkout/sessions/{session} | rak_checkout_session_write |
POST /v1/checkout/sessions/{session}/expire | rak_checkout_session_write |
GET /v1/checkout/sessions/{session}/line_items | rak_checkout_session_read |
webhook#
Paths: /v1/webhook_endpoints. Permissions: rak_webhook_read, rak_webhook_write.
| Operation | Needs |
|---|---|
GET /v1/webhook_endpoints | rak_webhook_read |
POST /v1/webhook_endpoints | rak_webhook_write |
DELETE /v1/webhook_endpoints/{webhook_endpoint} | rak_webhook_write |
GET /v1/webhook_endpoints/{webhook_endpoint} | rak_webhook_read |
POST /v1/webhook_endpoints/{webhook_endpoint} | rak_webhook_write |
payment_method_domain#
Paths: /v1/payment_method_domains. Permissions: rak_payment_method_domain_read, rak_payment_method_domain_write.
| Operation | Needs |
|---|---|
GET /v1/payment_method_domains | rak_payment_method_domain_read |
POST /v1/payment_method_domains | rak_payment_method_domain_write |
GET /v1/payment_method_domains/{payment_method_domain} | rak_payment_method_domain_read |
POST /v1/payment_method_domains/{payment_method_domain} | rak_payment_method_domain_write |
POST /v1/payment_method_domains/{payment_method_domain}/validate | rak_payment_method_domain_write |
payment_method_configurations#
Paths: /v1/payment_method_configurations. Permissions: rak_payment_method_configurations_read, rak_payment_method_configurations_write.
| Operation | Needs |
|---|---|
GET /v1/payment_method_configurations | rak_payment_method_configurations_read |
GET /v1/payment_method_configurations/{configuration} | rak_payment_method_configurations_read |
POST /v1/payment_method_configurations/{configuration} | rak_payment_method_configurations_write |
account#
Paths: /v1/account. Read-only: rak_account_read is its only permission.
| Operation | Needs |
|---|---|
GET /v1/account | rak_account_read |
Operations no restricted key may call#
Only a secret key may call these operations. A restricted key gets 403 on them whatever permissions it holds, and the message says that restricted keys cannot use the operation.