Create Account

POST

/api/accounts/

POST

/api/accounts/

1 curl -X POST https://app.paymentkit.com/api/accounts/ \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "Production Environment",
6   "organization_id": "org_dev_x7k9m2n4p8q1"
7 }'

1 {
2   "id": "acc_dev_x7k9m2n4p8q1",
3   "name": "Production Environment",
4   "description": "Main production environment",
5   "account_type": "production",
6   "organization_id": "org_dev_x7k9m2n4p8q1",
7   "settings": {
8     "auto_deploy": true,
9     "notifications": false
10   },
11   "created_at": "2024-01-15T09:30:00Z",
12   "updated_at": "2024-01-15T09:30:00Z",
13   "brand_settings": {
14     "icon": "https://storage.googleapis.com/bucket/icon.png",
15     "logo": "https://storage.googleapis.com/bucket/logo.png",
16     "brand_color": "#FF5733",
17     "accent_color": "#3498DB",
18     "custom_domain": "pay.example.com",
19     "apple_pay_merchant_key_file": "https://storage.googleapis.com/bucket/merchant-key.pem",
20     "legal_name": "Acme Corporation Inc.",
21     "privacy_policy_url": "https://example.com/privacy",
22     "terms_of_service_url": "https://example.com/terms",
23     "billing_descriptor": "ACME CORP"
24   },
25   "invoice_settings": {
26     "billing_address": {
27       "line1": "123 Main St",
28       "line2": "Suite 100",
29       "line3": "Building A",
30       "city": "San Francisco",
31       "state": "CA",
32       "country": "US",
33       "zip_code": "94105"
34     },
35     "tax_ids": [
36       {
37         "value": "PBGPS03456H",
38         "is_default": true
39       }
40     ],
41     "custom_footer": "Thank you for your business!"
42   },
43   "notification_settings": {
44     "invoice": {
45       "on_finalized": true,
46       "on_paid": true
47     },
48     "dunning": {
49       "failed_payment": true
50     },
51     "slack_enabled": true,
52     "slack_webhook_urls": [
53       "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
54     ],
55     "slack_payment_succeeded": true,
56     "slack_payment_failed": true,
57     "email_enabled": true,
58     "emails_to_notify": [
59       "notifications@acmecorp.com"
60     ],
61     "email_payment_succeeded": true,
62     "email_payment_failed": true,
63     "email_config": {
64       "from_email": "billing@example.com",
65       "reply_to_email": "support@example.com",
66       "email_signature_title": "Billing Department",
67       "email_signature_name": "John Smith",
68       "cc_recipients": [
69         "cc1@merchant.com"
70       ],
71       "bcc_recipients": [
72         "bcc1@merchant.com"
73       ],
74       "primary_color": "#2563EB",
75       "text_color": "#1F2937",
76       "background_color": "#FFFFFF"
77     }
78   },
79   "billing_portal_settings": {
80     "allow_create_sub": true,
81     "allow_update_sub": true,
82     "allow_cancel_sub": true,
83     "upgrade_immediate": true,
84     "cancel_immediate": true,
85     "downgrade_immediate": true,
86     "hide_price_ids": [
87       "price_abc123",
88       "price_def456"
89     ]
90   },
91   "dunning_settings": {
92     "enable_retries": true,
93     "enable_emails": true,
94     "contact_info": {
95       "from_email": "billing@example.com",
96       "reply_to_email": "support@example.com",
97       "email_signature_title": "Billing Department",
98       "email_signature_name": "John Smith",
99       "cc_recipients": [
100         "cc1@merchant.com",
101         "cc2@merchant.com"
102       ],
103       "bcc_recipients": [
104         "bcc1@merchant.com",
105         "bcc2@merchant.com"
106       ]
107     },
108     "subscription_status_on_failure": "cancel",
109     "invoice_status_on_failure": "mark_uncollectible",
110     "apply_to_product_ids": [
111       "prod_abc123",
112       "prod_def456"
113     ],
114     "settle_past_due_on_pm_update": true,
115     "update_renewal_on_overdue_paid": true
116   },
117   "checkout_settings": {
118     "session_expiration_minutes": 30,
119     "enable_posthog": true,
120     "posthog_api_key": "phc_abcdef123456",
121     "posthog_init_keys": {
122       "api_host": "https://app.posthog.com",
123       "autocapture": true
124     },
125     "create_new_customer_per_session": true,
126     "detach_failed_payment_method": true,
127     "enable_promo_code": true,
128     "default_country": "US",
129     "enable_full_billing_address": true,
130     "billing_address_country": true,
131     "billing_address_address": true,
132     "billing_address_city_state": true,
133     "billing_address_zip": true,
134     "enable_shipping_address": true,
135     "enable_consent_checkbox": true,
136     "custom_checkbox_text": "I agree to the terms and conditions",
137     "custom_footer_text": "Thank you for choosing Acme Corp!",
138     "primary_color": "#0052cc",
139     "text_color": "#333333",
140     "background_color": "#f9f9f9"
141   },
142   "fraud_settings": {
143     "enabled": false,
144     "fraud_rules": [
145       {
146         "id": "rule_001",
147         "name": "Block High Risk Countries",
148         "logic": "AND",
149         "enabled": true,
150         "reason": "Transactions from high risk countries are blocked",
151         "conditions": [
152           {
153             "field": "country",
154             "operator": "in",
155             "value": "['NG', 'PK', 'UA']"
156           }
157         ],
158         "created_at": "2024-01-15T09:30:00Z",
159         "updated_at": "2024-01-15T09:30:00Z"
160       }
161     ],
162     "custom_message": "This payment method is not accepted."
163   },
164   "mit_settings": {
165     "cascading_enabled": true,
166     "fallback_processor_1_id": "proc_dev_a1b2c3d4e5f6g7h8",
167     "fallback_processor_2_id": "proc_dev_b2c3d4e5f6g7h8i9"
168   },
169   "cit_processing_enabled": true,
170   "mit_processing_enabled": true,
171   "default_processor_route_id": "proute_dev_a1b2c3d4e5f6g7h8"
172 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired

Account name

organization_idstringRequired

Organization ID

descriptionstring or nullOptional

Account description

account_typestring or nullOptional

Account type (defaults to server environment)

settingsmap from strings to any or nullOptional

Account settings

Response

Successful Response

idstring

Unique account identifier

namestring

Account name

descriptionstring or null

Account description

account_typestring

Account type

organization_idstring

Organization ID

settingsmap from strings to any or null

Account settings

created_atdatetime

When the account was created

updated_atdatetime

When the account was last updated

brand_settingsobject or null

Brand customization settings for checkout

invoice_settingsobject or null

Invoice customization settings

notification_settingsobject or null

Notification settings for invoice/dunning and channels

billing_portal_settingsobject or null

Billing portal settings for customer self-service

dunning_settingsobject or null

Dunning settings for failed payment recovery

checkout_settingsobject or null

Checkout settings for session configuration and analytics

fraud_settingsobject or null

Fraud protection settings for card blocking

mit_settingsobject or null

MIT cascade control settings for subscription payments

cit_processing_enabledboolean or nullDefaults to true

Whether CIT (checkout/card) processing is enabled

mit_processing_enabledboolean or nullDefaults to true

Whether MIT (subscription/recurring) processing is enabled

default_processor_route_idstring or null

ID of the default processor route for card checkout. A processor route contains an ordered list of processors tried sequentially as a fallback chain. This route is used when no route is specified on a checkout session.

Authentication

Request

Response

Errors