https://api.payload.co/processing_accounts
Nested Objects
https://api.payload.co/processing_accounts/{id}/application_link
https://api.payload.co/processing_accounts/{id}/legal_entity
https://api.payload.co/processing_accounts/{id}/parent_org
https://api.payload.co/processing_accounts/{id}/payment_methods
Example
{
"id": "acct_1P9gQdVRhbY2aoXlDRd72KOS7",
"object": "processing_account",
"attrs": {},
"created_at": "2022-02-02 21:11:49",
"description": "string",
"industry": "string",
"legal_entity": {},
"legal_entity_id": "le_1iA2KgxC1SEXA16GIGqJS8D6k",
"modified_at": "2022-02-02 21:11:49",
"name": "string",
"parent_org_id": "acct_YnQrS9vGZceuBGLfLfsUXmYg",
"payment_methods": [],
"processing_settings_id": "ps_zpIDwRlq0ul1N0l4qsJzqWJf",
"status": "incomplete",
"billing_contact": {
"city": "string",
"email": "string",
"name": "string",
"phone": "string",
"postal_code": "string",
"state_province": "string",
"street_address1": "string",
"street_address2": "string",
"website": "string"
},
"processing_settings": {
"id": "ps_kLjYnlIRgqqjeTiaacAjNyh1",
"amex_trans_cost": 0.1,
"amex_trans_rate": 0.0275,
"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": 270.84,
"billing_preference": "netted_daily",
"card_avs_auth_threshold": "no_match",
"card_present": true,
"card_processing_enabled": true,
"change_fee": 981.39,
"chargeback_fee": 774.48,
"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": false,
"funding_style": "batched",
"googlepay_enabled": true,
"googlepay_merchant_id": "string",
"guarantor_required": false,
"integration_type": "string",
"minimum_bill": 921.98,
"monthly_processing_fee": 25,
"nabu_fee": 12.13,
"pci_fee": 495.85,
"prepaid_conv_fee_alloc": 0,
"prepaid_trans_cost": 0.1,
"prepaid_trans_rate": 0.0275,
"pricing": "flat_rate",
"processing_type": "payfac",
"retrieval_fee": 316.65,
"card_processing": {
"credit": true,
"debit": true,
"prepaid": false
}
}
}
Attributes | Description |
---|---|
id string readonly |
Object ID |
object string readonly |
Value: processing_account |
attrs json |
Custom object attributes |
created_at datetime readonly |
Timestamp object was created |
description string |
Optional description of the account |
industry string required |
Primary processing industry |
legal_entity object |
Associated Legal Entity object |
legal_entity_id id |
ID of associated legal entity |
modified_at datetime readonly |
Timestamp object was last updated |
name string required |
Name for the account, either a person or company name |
parent_org_id id |
Specify the parent org for an account |
payment_methods list |
Array of associated Payment Method objects |
processing_settings_id id readonly: function |
ID of the associated processing settings |
status string |
Status of the processing account activation |
billing_contact: | |
---|---|
city string |
City of the billing contact |
email string |
Email of the billing contact |
name string |
Name of the billing contact |
phone string |
Phone number of the billing contact |
postal_code string |
Zipcode of the billing contact |
state_province string |
State of the billing contact |
street_address1 string |
Street address of the billing contact |
street_address2 string |
Street address 2 of the billing contact |
website string |
Website of the billing contact |
processing_settings: | |
---|---|
id string readonly |
Object ID |
amex_trans_cost number readonly: function |
Per AMEX card transaction fixed cost |
amex_trans_rate number readonly: function |
Per AMEX card transaction percentage rate |
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_avs_auth_threshold string |
Values: no_match street_and_zip street_or_zip zip |
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 |