NAV Navbar
Logo

Object Reference

Accounts

https://api.payload.co/accounts

Nested Objects

https://api.payload.co/accounts/{id}/payment_methods

Example

{
  "id": "dl3TcHjCVo1DRhuytTfn9cpX",
  "object": "account",
  "attrs": {},
  "created_at": "2020-02-07 20:43:34",
  "description": "string",
  "email": "email@address.com",
  "modified_at": "2020-02-07 20:43:34",
  "name": "string",
  "parent_org_id": "1XLA2DKwsp88GW8k9fIyO6vh1",
  "payment_methods": [],
  "phone_number": "(123) 456-7890",
  "primary_processing_id": "139tVhbXsOByr6StQoEkmtP8O",
  "transaction_limit": 729.56,
  "type": "customer",
  "processing": {
    "industry": "string",
    "status": "incomplete",
    "settings": {
      "id": "aZL9yMwW8ufwGiruaP0SSQg2",
      "bank_account_conv_fee_alloc": 0,
      "bank_account_processing_enabled": true,
      "bank_account_trans_cost": 1.25,
      "bank_account_trans_rate": 0,
      "batch_fee": 239.38,
      "billing_preference": "netted_daily",
      "card_processing_enabled": false,
      "change_fee": 627.86,
      "chargeback_fee": 955.67,
      "credit_conv_fee_alloc": 0,
      "credit_trans_cost": 0.1,
      "credit_trans_rate": 0.0275,
      "debit_conv_fee_alloc": 0,
      "debit_trans_cost": 0.1,
      "debit_trans_rate": 0.0275,
      "minimum_bill": 520.47,
      "monthly_processing_fee": 25,
      "nabu_fee": 634.36,
      "pci_fee": 440.54,
      "prepaid_conv_fee_alloc": 0,
      "prepaid_trans_cost": 0.1,
      "prepaid_trans_rate": 0.0275,
      "pricing": "flat_rate",
      "processing_type": "payfac",
      "retrieval_fee": 291.31,
      "card_processing": {
        "credit": true,
        "debit": true,
        "prepaid": false
      }
    }
  }
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: account
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
description
string
Optional description of the account
email
email required
Email address for the account
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
phone_number
phone
Phone number for the account
primary_processing_id
id
Specify the primary processing account for a customer
transaction_limit
number readonly
The account’s transaction limit
type
string required
Values: customer processing
processing:  
industry
string required
Primary processing industry
status
string readonly: SessionPermission
Status of the processing account activation
settings:  
id
string readonly
Object ID
bank_account_conv_fee_alloc
number required
Percentage of bank account fee charged as a convenience
bank_account_processing_enabled
bool required
If enabled, bank payments allowed on the account
bank_account_trans_cost
number readonly
Per bank account transaction fixed cost
bank_account_trans_rate
number readonly
Per bank account transaction percentage rate
batch_fee
number required
None
billing_preference
string required
Values: netted_daily billed_monthly
card_processing_enabled
bool required
If enabled, card payments allowed on the account
change_fee
number required
None
chargeback_fee
number required
None
credit_conv_fee_alloc
number required
Percentage of credit card fee charged as a convenience
credit_trans_cost
number readonly
Per credit card transaction fixed cost
credit_trans_rate
number readonly
Per credit card transaction percentage rate
debit_conv_fee_alloc
number required
Percentage of debit card fee charged as a convenience
debit_trans_cost
number readonly
Per debit card transaction fixed cost
debit_trans_rate
number readonly
Per debit card transaction percentage rate
minimum_bill
number required
None
monthly_processing_fee
number readonly
Fixed monthly fee per processing account
nabu_fee
number required
None
pci_fee
number required
None
prepaid_conv_fee_alloc
number required
Percentage of prepaid fee charged as a convenience
prepaid_trans_cost
number readonly
Per prepaid card transaction fixed cost
prepaid_trans_rate
number readonly
Per prepaid card transaction percentage rate
pricing
string required
Values: flat_rate tiered interchange
processing_type
string readonly: SessionPermission
Values: payfac mor mor_tsys forte
retrieval_fee
number required
None
card_processing:  
credit
bool required
Enable or disable credit cards
debit
bool required
Enable or disable debit cards
prepaid
bool required
Enable or disable prepaid cards
 
 
 

Transactions

https://api.payload.co/transactions

Nested Objects

https://api.payload.co/transactions/{id}/payment_method

https://api.payload.co/transactions/{id}/ledger

https://api.payload.co/transactions/{id}/allocations

https://api.payload.co/transactions/{id}/reader

https://api.payload.co/transactions/{id}/customer

Example

{
  "id": "hlprcC7JaCnZAJJklRB94fee",
  "object": "transaction",
  "amount": 894.5,
  "attrs": {},
  "created_at": "2020-02-07 20:43:34",
  "customer_id": "1UkbIwXdnRF6vojB2s5lPDhSl",
  "description": "string",
  "fee": 1.32,
  "funding_status": "pending",
  "modified_at": "2020-02-07 20:43:34",
  "order_number": "string",
  "payment_method": {},
  "payment_method_id": "MKNL0Rw3ncMFgevoTTKl9BGJ",
  "processing_id": "f77fqR3fH4XUP8vEmqueOGOY",
  "reader_id": "1v6BIVPl1v4Hh70Z2czdvOSkk",
  "ref_number": "string",
  "risk_flag": "in_review",
  "risk_score": 928.51,
  "source": "keyed",
  "status": "processing",
  "status_code": "string",
  "status_message": "string",
  "type": "payment"
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: transaction
amount
number readonly: update
Transaction amount
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
customer_id
id readonly: update
ID of associated Customer object
description
string
Description of the transaction
fee
number readonly
Processing fee
funding_status
string readonly
Values: pending captured batched refunded reversed
modified_at
datetime readonly
Timestamp object was last updated
order_number
string
None
payment_method
object
Associated Payment Method object
payment_method_id
id readonly: update
ID of the associated Payment Method object
processing_id
id readonly: update
ID of the associated Processing Account object
reader_id
id readonly: update
None
ref_number
string readonly
Human-readable reference number for receipts and reporting
risk_flag
string readonly
Values: in_review allowed denied
risk_score
number readonly
Risk score between -1 to 1
source
string readonly: update
Values: keyed swipe emv emv_quickchip nfc
status
string
Values: processing processed declined voided rejected
status_code
string readonly
Code detailing the reason for the transaction status
status_message
string readonly
Human-readable status description
type
string readonly: update
Values: payment deposit reversal refund chargeback chargeback_reversal

Transaction Ledger

https://api.payload.co/transaction_ledgers

Example

{
  "id": "1cxG6yejJ9bbuUFAIoFokk7uE",
  "object": "transaction_ledger",
  "amount": 213.54,
  "assoc_transaction_id": "17A11tZu3ThlTLi4WA4959hcB",
  "attrs": {},
  "created_at": "2020-02-07 20:43:34",
  "entry_type": "string",
  "modified_at": "2020-02-07 20:43:34",
  "transaction_id": "CR28hR57U6CKNFoLuEuXqZzQ"
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: transaction_ledger
amount
number
Amount of the entry
assoc_transaction_id
id required
ID of the associated Transaction object
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
entry_type
string readonly
Resulting transfer type
modified_at
datetime readonly
Timestamp object was last updated
transaction_id
id required
ID of the Transaction object

Payment Methods

https://api.payload.co/payment_methods

Nested Objects

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

https://api.payload.co/payment_methods/{id}/processing_agreement

Example

{
  "id": "1neVUIs9M17w4aYCErqSas5TK",
  "object": "payment_method",
  "account_holder": "string",
  "account_id": "1c4FoShHMDearMRtw5iLZe6YK",
  "attrs": {},
  "created_at": "2020-02-07 20:43:34",
  "default_payment_method": true,
  "description": "string",
  "legal_entity": {},
  "modified_at": "2020-02-07 20:43:34",
  "phone_number": "(123) 456-7890",
  "processing_agreement": {},
  "type": "card",
  "bank_account": {
    "account_class": "personal",
    "account_number": "numeric",
    "account_type": "checking",
    "routing_number": "numeric"
  },
  "billing_address": {
    "city": "string",
    "postal_code": "numeric",
    "state_province": "string",
    "street_address": "string",
    "unit_number": "string"
  },
  "card": {
    "card_brand": "american_express",
    "card_code": "numeric",
    "card_number": "numeric",
    "card_type": "credit",
    "expiry": "expiry"
  }
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: payment_method
account_holder
string
Name of the account holder
account_id
id
ID of the associated Account object
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
default_payment_method
bool
If enabled, this method can be used as the default for the account
description
string readonly
A readable description for the payment method
legal_entity
object
Associated Legal Entity object
modified_at
datetime readonly
Timestamp object was last updated
phone_number
phone
Account holder’s phone number
processing_agreement
object
Associated Processing Agreement object
type
string required
Values: card bank_account
bank_account:  
account_class
string readonly: update
Values: personal business
account_number
numeric readonly: update
Bank account number
account_type
string readonly: update
Values: checking savings
routing_number
numeric readonly: update
Bank routing number for the account
 
billing_address:  
city
string
City of the company
postal_code
numeric required
Postal code of the billing address
state_province
string
State of the billing address
street_address
string
Street address of the billing address
unit_number
string
Unit number of the billing address
 
card:  
card_brand
string readonly
Values: american_express visa discover mastercard opticard
card_code
numeric
None
card_number
numeric readonly: update
Credit/Debit card number
card_type
string readonly: SessionPermission
Values: credit debit gift prepaid
expiry
expiry required
Expiration date of the card
 

Billing Schedules

https://api.payload.co/billing_schedules

Nested Objects

https://api.payload.co/billing_schedules/{id}/invoices

https://api.payload.co/billing_schedules/{id}/charges

Example

{
  "id": "1RdDF8DgEOFGzhfCNQyCN5p9X",
  "object": "billing_schedule",
  "attrs": {},
  "charges": [],
  "created_at": "2020-02-07 20:43:34",
  "customer_id": "IVM2ZIceNUTZBGhn7mUYHb1E",
  "description": "string",
  "end_date": "2020-02-07",
  "invoices": [],
  "modified_at": "2020-02-07 20:43:34",
  "processing_id": "wKiZExpAX9uGS1s6SUdeP3co",
  "recurring_frequency": "daily",
  "start_date": "2020-02-07",
  "type": "string",
  "annually": {
    "billing_day": 1,
    "billing_month": 1
  },
  "bimonthly": {
    "first_billing_day": 1,
    "second_billing_day": 1
  },
  "monthly": {
    "billing_day": 1
  },
  "quarterly": {
    "q1": {
      "billing_day": 1,
      "billing_month": 1
    },
    "q2": {
      "billing_day": 1,
      "billing_month": 4
    },
    "q3": {
      "billing_day": 1,
      "billing_month": 7
    },
    "q4": {
      "billing_day": 1,
      "billing_month": 10
    }
  }
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: billing_schedule
attrs
json
Custom object attributes
charges
list
Array of associated Billing Charge objects
created_at
datetime readonly
Timestamp object was created
customer_id
id required
ID of the associated Customer Account object
description
string
Billing Description
end_date
date
End date of the billing schedule
invoices
list
Array of associated Invoice objects
modified_at
datetime readonly
Timestamp object was last updated
processing_id
id required
ID of associated Processing Account object
recurring_frequency
string
Values: daily weekly biweekly bimonthly monthly quarterly annually
start_date
date
Start date of the billing schedule
type
string required
Arbitrary type classification
annually:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
billing_month
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12
 
bimonthly:  
first_billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
second_billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 
monthly:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 
quarterly:  
q1:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
billing_month
int required
Values: 1 2 3
 
q2:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
billing_month
int required
Values: 4 5 6
 
q3:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
billing_month
int required
Values: 7 8 9
 
q4:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
billing_month
int required
Values: 10 11 12
 
 

Billing Charges

https://api.payload.co/billing_charges

Example

{
  "id": "7QxgtH32zPGp9sw388S3DBvB",
  "object": "billing_charge",
  "amount": 885.01,
  "attrs": {},
  "billing_schedule_id": "NOVXn06DrqpNCn5rxsIHfWWW",
  "created_at": "2020-02-07 20:43:34",
  "description": "string",
  "modified_at": "2020-02-07 20:43:34",
  "qty": 169,
  "total": 461.45,
  "type": "string"
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: billing_charge
amount
number required
Amount of the charge
attrs
json
Custom object attributes
billing_schedule_id
id required
ID of the associated Billing Schedule object
created_at
datetime readonly
Timestamp object was created
description
string
Description of charge
modified_at
datetime readonly
Timestamp object was last updated
qty
int
Quantity of the item
total
number readonly
Total amount of charge
type
string
Arbitrary type classification

Invoices

https://api.payload.co/invoices

Nested Objects

https://api.payload.co/invoices/{id}/items

https://api.payload.co/invoices/{id}/processing_settings

https://api.payload.co/invoices/{id}/attachments

https://api.payload.co/invoices/{id}/customer

Example

{
  "id": "URAnUtzORgi2Yrw9cNuDLW90",
  "object": "invoice",
  "amount_due": 976.28,
  "attachments": [],
  "attrs": {},
  "billing_schedule_id": "1Hv28EgfQAWCAmrkkQVcUQAPo",
  "created_at": "2020-02-07 20:43:34",
  "customer_id": "1LEPuYDDPrptkmmGMcJs8srtW",
  "description": "string",
  "due_date": "2020-02-07",
  "items": [],
  "modified_at": "2020-02-07 20:43:34",
  "paid_timestamp": "2020-02-07",
  "processing_id": "OhijyJaNEsfWIAsBQ0OgDjZB",
  "processing_settings_id": "jnjakZknITJMLJUsn1USl3HD",
  "status": "pending",
  "total_due": 92.03,
  "total_paid": 444.14,
  "type": "string",
  "billing_contact": {
    "city": "string",
    "email": "string",
    "name": "string",
    "postal_code": "string",
    "state_province": "string",
    "street_address1": "string"
  }
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: invoice
amount_due
number readonly
Remaining amount paid
attachments
list
Array of associated Invoice Attachment objects
attrs
json
Custom object attributes
billing_schedule_id
id
ID of the associated Billing Schedule object
created_at
datetime readonly
Timestamp object was created
customer_id
id required
ID of the associated Customer Account object
description
string
Description of the invoice
due_date
date required
Date the invoice is due
items
list required
Array of associated Line Item objects
modified_at
datetime readonly
Timestamp object was last updated
paid_timestamp
date readonly
Timestamp invoice was fully paid
processing_id
id required
ID of the associated Processing Account object
processing_settings_id
id readonly
ID of the processing settings object
status
string
Values: pending overdue partially_paid paid
total_due
number readonly
Total amount due
total_paid
number readonly
Total amount paid
type
string
Arbitrary type classification
billing_contact:  
city
string readonly
City of the billing contact
email
string readonly
Email of the billing contact
name
string readonly
Name of the billing contact
postal_code
string readonly
Zipcode of the billing contact
state_province
string readonly
State of the billing contact
street_address1
string readonly
Street address of the billing contact
 

Line Items

https://api.payload.co/line_items

Example

{
  "id": "11ZHEjP1NUdnFUHGpo2z8XOnN",
  "object": "line_item",
  "amount": 606.0,
  "attrs": {},
  "created_at": "2020-02-07 20:43:34",
  "description": "string",
  "entry_type": "charge",
  "incurred_date": "2020-02-07",
  "invoice_id": "1rpoGJxd2pLLBIjRc2YgHPHK2",
  "modified_at": "2020-02-07 20:43:34",
  "qty": 84,
  "total": 704.36,
  "transaction_id": "1Vc3DIozu2Y2woxdVumr8eqNU",
  "type": "string"
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: line_item
amount
number required
Amount of line item
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
description
string
Description of invoice item
entry_type
string required
Values: charge payment
incurred_date
date
Date the item was incurred
invoice_id
id required
ID of the associated Invoice object
modified_at
datetime readonly
Timestamp object was last updated
qty
int
Quantity of item
total
number readonly
Total amount of line item
transaction_id
id
ID of the associated Transaction
type
string
Arbitrary type classification

Legal Entities

https://api.payload.co/legal_entities

Nested Objects

https://api.payload.co/legal_entities/{id}/owners

Example

{
  "id": "1GqiIGsx83kLCQv0WER0R06Eh",
  "object": "legal_entity",
  "attrs": {},
  "city": "string",
  "contact_email": "email@address.com",
  "contact_name": "string",
  "contact_title": "string",
  "created_at": "2020-02-07 20:43:34",
  "ein": "numeric",
  "legal_name": "string",
  "modified_at": "2020-02-07 20:43:34",
  "owners": [],
  "payment_method_id": "1hDv3eTZ0P4YlxrlaMzRL2jfU",
  "phone_number": "(123) 456-7890",
  "postal_code": "numeric",
  "start_date": "2020-02-07 20:43:34",
  "state_incorporated": "string",
  "state_province": "string",
  "street_address": "string",
  "type": "LIMITED_LIABILITY_COMPANY",
  "unit_number": "string",
  "website": "string"
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: legal_entity
attrs
json
Custom object attributes
city
string required
City of the business
contact_email
email required
Email of primary contact
contact_name
string required
Name of primary contact
contact_title
string required
Title of primary contact
created_at
datetime readonly
Timestamp object was created
ein
numeric required
Tax ID of the entity
legal_name
string required
Legal name of the entity
modified_at
datetime readonly
Timestamp object was last updated
owners
list required
Array of associated Legal Entity Owner objects
payment_method_id
id readonly
ID of the Funding Method object
phone_number
phone required
Phone number of the business
postal_code
numeric required
Postal code of the business
start_date
datetime required
Start date of the business
state_incorporated
string required
State where the legal entity was incorporated
state_province
string required
State of the business
street_address
string required
Street address of the business
type
string required
Values: LIMITED_LIABILITY_COMPANY CORPORATION PUBLIC_CORPORATION PARTNERSHIP GOVERNMENT_AGENCY ASSOCIATION_ESTATE_TRUST TAX_EXEMPT_ORGANIZATION INDIVIDUAL_SOLE_PROPRIETORSHIP
unit_number
string
Unit number of the business
website
string
Website of the business

Legal Entity Owners

https://api.payload.co/legal_entity_owners

Example

{
  "id": "9c6mvbhG1GMlaO34yek9vaTc",
  "object": "legal_entity_owner",
  "attrs": {},
  "birth_date": "2020-02-07 20:43:34",
  "city": "string",
  "created_at": "2020-02-07 20:43:34",
  "email": "email@address.com",
  "full_name": "string",
  "legal_entity_id": "10j5fuhdkk2AUCowccuS90EgE",
  "modified_at": "2020-02-07 20:43:34",
  "ownership": 411.52,
  "phone_number": "(123) 456-7890",
  "postal_code": "numeric",
  "ssn": "numeric",
  "state_province": "string",
  "street_address": "string",
  "title": "string",
  "type": "string",
  "unit_number": "string"
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: legal_entity_owner
attrs
json
Custom object attributes
birth_date
datetime required
Birth date of owner
city
string required
City of the owner
created_at
datetime readonly
Timestamp object was created
email
email required
Email address of owner
full_name
string required
Full name of owner
legal_entity_id
id readonly
ID of the associated Legal Entity object
modified_at
datetime readonly
Timestamp object was last updated
ownership
number required
Equity position in the company
phone_number
phone required
Phone number of the owner
postal_code
numeric required
Postal code of the owner
ssn
numeric required
Social security number of owner
state_province
string required
State of the owner
street_address
string required
Street address of the owner
title
string required
Title of owner at the company
type
string required
Type of owner
unit_number
string
Unit number of the owner

Orgs

https://api.payload.co/orgs

Nested Objects

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

Example

{
  "id": "CDRWbek0dmwCYsOuQUa8oWmM",
  "object": "org",
  "attrs": {},
  "created_at": "2020-02-07 20:43:34",
  "industry": "string",
  "modified_at": "2020-02-07 20:43:34",
  "name": "string",
  "org_type": "string",
  "parent_org_id": "OrXoLZCFxjzfvavRt0ZoPvoF",
  "phone_number": "(123) 456-7890",
  "primary_processing_id": "Z85dEoMlMhbO91Mpge8t9Fzl",
  "timezone": "string",
  "processing_settings": {
    "id": "10AEBrJwPq47H22siw5KY7lG0",
    "bank_account_conv_fee_alloc": 0,
    "bank_account_processing_enabled": false,
    "bank_account_trans_cost": 1.25,
    "bank_account_trans_rate": 0,
    "batch_fee": 514.7,
    "billing_preference": "netted_daily",
    "card_processing_enabled": false,
    "change_fee": 122.37,
    "chargeback_fee": 865.25,
    "credit_conv_fee_alloc": 0,
    "credit_trans_cost": 0.1,
    "credit_trans_rate": 0.0275,
    "debit_conv_fee_alloc": 0,
    "debit_trans_cost": 0.1,
    "debit_trans_rate": 0.0275,
    "minimum_bill": 502.64,
    "monthly_processing_fee": 25,
    "nabu_fee": 73.42,
    "pci_fee": 382.67,
    "prepaid_conv_fee_alloc": 0,
    "prepaid_trans_cost": 0.1,
    "prepaid_trans_rate": 0.0275,
    "pricing": "flat_rate",
    "processing_type": "payfac",
    "retrieval_fee": 496.66,
    "card_processing": {
      "credit": true,
      "debit": true,
      "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
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 of organization
primary_processing_id
id
The primary processing account for the account
timezone
string
The primary timezone for the account
processing_settings:  
id
string readonly
Object ID
bank_account_conv_fee_alloc
number required
Percentage of bank account fee charged as a convenience
bank_account_processing_enabled
bool required
If enabled, bank payments allowed on the account
bank_account_trans_cost
number readonly
Per bank account transaction fixed cost
bank_account_trans_rate
number readonly
Per bank account transaction percentage rate
batch_fee
number required
None
billing_preference
string required
Values: netted_daily billed_monthly
card_processing_enabled
bool required
If enabled, card payments allowed on the account
change_fee
number required
None
chargeback_fee
number required
None
credit_conv_fee_alloc
number required
Percentage of credit card fee charged as a convenience
credit_trans_cost
number readonly
Per credit card transaction fixed cost
credit_trans_rate
number readonly
Per credit card transaction percentage rate
debit_conv_fee_alloc
number required
Percentage of debit card fee charged as a convenience
debit_trans_cost
number readonly
Per debit card transaction fixed cost
debit_trans_rate
number readonly
Per debit card transaction percentage rate
minimum_bill
number required
None
monthly_processing_fee
number readonly
Fixed monthly fee per processing account
nabu_fee
number required
None
pci_fee
number required
None
prepaid_conv_fee_alloc
number required
Percentage of prepaid fee charged as a convenience
prepaid_trans_cost
number readonly
Per prepaid card transaction fixed cost
prepaid_trans_rate
number readonly
Per prepaid card transaction percentage rate
pricing
string required
Values: flat_rate tiered interchange
processing_type
string readonly: SessionPermission
Values: payfac mor mor_tsys forte
retrieval_fee
number required
None
card_processing:  
credit
bool required
Enable or disable credit cards
debit
bool required
Enable or disable debit cards
prepaid
bool required
Enable or disable prepaid cards
 
 

Webhooks

https://api.payload.co/webhooks

Nested Objects

https://api.payload.co/webhooks/{id}/logs

Example

{
  "id": "1v8ZxNT7N9BVpz2POj2suoYE2",
  "object": "webhook",
  "attrs": {},
  "created_at": "2020-02-07 20:43:34",
  "modified_at": "2020-02-07 20:43:34",
  "trigger": "bank_account_reject",
  "url": "https://example.com/bank_account_reject",
  "oauth_params": {
    "auth_url": "string",
    "client_id": "string",
    "client_secret": "string",
    "grant_type": "string",
    "resource": "string"
  }
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: webhook
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
modified_at
datetime readonly
Timestamp object was last updated
trigger
string required
Values: bank_account_reject refund void chargeback chargeback_reversal automatic_payment payment decline
url
string required
Url to trigger
oauth_params:  
auth_url
string required
The url of the OAuth 2.0 token request
client_id
string required
The client identifier of the OAuth 2.0 client
client_secret
string required
The client secret of the OAuth 2.0 client
grant_type
string required
Indicates that a token exchange is being performed
resource
string required
Indicates the location of the target service or resource
 

Webhook Logs

https://api.payload.co/webhook_logs

Example

{
  "id": "cgq8BO1RiL1S6D8qhkFeCJ2y",
  "object": "webhook_log",
  "attrs": {},
  "created_at": "2020-02-07 20:43:34",
  "http_status": 747,
  "modified_at": "2020-02-07 20:43:34",
  "trigger": "bank_account_reject",
  "url": "string",
  "webhook_id": "1sIlY5MbvR6xWL1qNflTepPOH",
  "triggered_on": {
    "id": "19yYIFaBCTa4ay714inxLKApv",
    "object": "string"
  }
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: webhook_log
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
http_status
int required
HTTP status response from URL
modified_at
datetime readonly
Timestamp object was last updated
trigger
string required
Values: bank_account_reject refund void chargeback chargeback_reversal automatic_payment payment decline processing_status
url
string required
Triggered URL
webhook_id
id required
None
triggered_on:  
id
string required
Object ID
object
string required
Object name