Orgs

https://api.payload.co/orgs

Nested Objects

https://api.payload.co/orgs/{id}/legal_entity

Example

{
  "id": "acct_1x1FPwEa6a9KmFKsZl8e51N3O",
  "object": "org",
  "attrs": {},
  "created_at": "2021-07-07 23:19:32",
  "industry": "string",
  "legal_entity_id": "le_24w2SipahiR17bHIqPDUOmeNO",
  "modified_at": "2021-07-07 23:19:32",
  "name": "string",
  "org_type": "string",
  "parent_org_id": "acct_oQJQgHdykPVXXzKXko9VMcMC",
  "phone_number": "(123) 456-7890",
  "primary_processing_id": "acct_Mmye8jdIU2B0gl3RDQV3c4NX",
  "processing_settings_id": "ps_IA5wjDkQQt0OYoW6rhns1KTx",
  "timezone": "string",
  "processing_settings": {
    "id": "ps_1LJvbIFgdRvhsCdKiiScN0coI",
    "applepay_enabled": false,
    "bank_account_conv_fee_alloc": 0,
    "bank_account_processing_enabled": false,
    "bank_account_trans_cost": 1.25,
    "bank_account_trans_rate": 0,
    "batch_fee": 344.59,
    "billing_preference": "netted_daily",
    "card_present": false,
    "card_processing_enabled": false,
    "change_fee": 771.91,
    "chargeback_fee": 733.07,
    "credit_conv_fee_alloc": 0,
    "credit_trans_cost": 0.1,
    "credit_trans_rate": 0.0275,
    "currency": "USD",
    "debit_conv_fee_alloc": 0,
    "debit_trans_cost": 0.1,
    "debit_trans_rate": 0.0275,
    "ecommerce": true,
    "funding_style": "batched",
    "googlepay_enabled": false,
    "googlepay_merchant_id": "string",
    "guarantor_required": false,
    "integration_type": "string",
    "minimum_bill": 839.6,
    "monthly_processing_fee": 25,
    "nabu_fee": 36.42,
    "pci_fee": 907.21,
    "prepaid_conv_fee_alloc": 0,
    "prepaid_trans_cost": 0.1,
    "prepaid_trans_rate": 0.0275,
    "pricing": "flat_rate",
    "processing_type": "payfac",
    "retrieval_fee": 571.08,
    "card_processing": {
      "credit": false,
      "debit": false,
      "prepaid": false
    }
  }
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: org
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
industry
string required
Primary processing industry
legal_entity_id
id
ID of associated legal entity
modified_at
datetime readonly
Timestamp object was last updated
name
string required
Name of the organization
org_type
string required
Type of organization
parent_org_id
id
Specify the parent org for an account
phone_number
phone
Phone number for the organization
primary_processing_id
id
Specify the primary processing account for the account
processing_settings_id
id readonly: function
ID of the associated processing settings
timezone
string
The primary timezone for the account
processing_settings:  
id
string readonly
Object ID
applepay_enabled
bool
Specify if account is capable of processing with Apple Pay
bank_account_conv_fee_alloc
number
Percentage of bank account fee charged as a convenience
bank_account_processing_enabled
bool
If enabled, bank payments allowed on the account
bank_account_trans_cost
number readonly: function
Per bank account transaction fixed cost
bank_account_trans_rate
number readonly: function
Per bank account transaction percentage rate
batch_fee
number
Per settlement batch fee
billing_preference
string
Values: netted_daily billed_monthly
card_present
bool
Specify if account is capable of processing card present transactions
card_processing_enabled
bool
If enabled, card payments allowed on the account
change_fee
number
Cost to change funding details
chargeback_fee
number
Cost per chargeback
credit_conv_fee_alloc
number
Percentage of credit card fee charged as a convenience
credit_trans_cost
number readonly: function
Per credit card transaction fixed cost
credit_trans_rate
number readonly: function
Per credit card transaction percentage rate
currency
string readonly: method
Values: USD CAD
debit_conv_fee_alloc
number
Percentage of debit card fee charged as a convenience
debit_trans_cost
number readonly: function
Per debit card transaction fixed cost
debit_trans_rate
number readonly: function
Per debit card transaction percentage rate
ecommerce
bool
Specify if account is capable of processing ecommerce transactions
funding_style
string
Values: batched individual
googlepay_enabled
bool
Specify if account is capable of processing with Google Pay
googlepay_merchant_id
string
Associated Google Pay merchant id
guarantor_required
bool readonly: function
Specify if a guarantor is required on the application
integration_type
string readonly: function
Specify if account is integrated, using external gateways, or both
minimum_bill
number
Minimum amount billed monthly
monthly_processing_fee
number readonly: function
Fixed monthly fee per processing account
nabu_fee
number
Network Access Brand Usage fee
pci_fee
number
Cost for PCI compliance
prepaid_conv_fee_alloc
number
Percentage of prepaid fee charged as a convenience
prepaid_trans_cost
number readonly: function
Per prepaid card transaction fixed cost
prepaid_trans_rate
number readonly: function
Per prepaid card transaction percentage rate
pricing
string
Values: flat_rate tiered interchange
processing_type
string readonly: function
Values: payfac mor mor_tsys forte istream payroc
retrieval_fee
number
Cost per retrieval request
card_processing:  
credit
bool
Enable or disable credit cards
debit
bool
Enable or disable debit cards
prepaid
bool
Enable or disable prepaid cards