NAV Navbar
Logo

Billing Charges

https://api.payload.co/billing_charges

Nested Objects

https://api.payload.co/billing_charges/{id}/billing_schedule

Example

{
  "id": "bcrg_1UvPTCbEddPQyBT5Sp2uhqx8p",
  "object": "billing_charge",
  "amount": 921.41,
  "attrs": {},
  "billing_schedule_id": "bscd_1X275DTl29od0GsnAOjEdfid8",
  "created_at": "2020-09-20 18:34:50",
  "description": "string",
  "modified_at": "2020-09-20 18:34:50",
  "qty": 364.82,
  "total": 318.38,
  "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
number
Quantity of the item
total
number readonly
Total amount of charge
type
string
Arbitrary type classification

Billing Schedules

https://api.payload.co/billing_schedules

Nested Objects

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

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

Example

{
  "id": "bscd_1p18gqL3b5zdsNSnc7Kmknqee",
  "object": "billing_schedule",
  "attrs": {},
  "charges": [],
  "created_at": "2020-09-20 18:34:50",
  "customer_id": "acct_mmqEoobXGhIuWcBRqgUfFcO7",
  "description": "string",
  "end_date": "2020-09-20",
  "invoices": [],
  "modified_at": "2020-09-20 18:34:50",
  "processing_id": "acct_1HgbOXQoJP2Ubd4WJPm219fRZ",
  "recurring_frequency": "daily",
  "start_date": "2020-09-20",
  "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
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
 
 

Customers

https://api.payload.co/customers

Nested Objects

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

Example

{
  "id": "acct_gM1Ul4wCWgvFmatxQ0gS32Wv",
  "object": "customer",
  "attrs": {},
  "created_at": "2020-09-20 18:34:50",
  "description": "string",
  "email": "email@address.com",
  "modified_at": "2020-09-20 18:34:50",
  "name": "string",
  "payment_methods": [],
  "phone_number": "(123) 456-7890",
  "primary_processing_id": "acct_aUwX493qNFNCaRyrrcJ7V6JN"
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: customer
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
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

Invoices

https://api.payload.co/invoices

Nested Objects

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

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

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

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

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

Example

{
  "id": "inv_UEb2u9TsIzMLf0PnO8hZusi4",
  "object": "invoice",
  "amount_due": 259.57,
  "attachments": [],
  "attrs": {},
  "billing_schedule_id": "bscd_1KlBDUdboLQ4gN6Q3yksJwAJn",
  "created_at": "2020-09-20 18:34:50",
  "customer_id": "acct_TqeXA0deyiBsNvFe3MyR03ZT",
  "description": "string",
  "due_date": "2020-09-20",
  "items": [],
  "modified_at": "2020-09-20 18:34:50",
  "paid_timestamp": "2020-09-20",
  "processing_id": "acct_zrnfGbSyNtfaH1HT8UQHZv9A",
  "processing_settings_id": "ps_1Tb5jjzLUcnPn3miGMLa03JYt",
  "status": "unpaid",
  "total_due": 717.99,
  "total_paid": 293.99,
  "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 due
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
Date the invoice is due
items
list
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
ID of the associated Processing Account object
processing_settings_id
id readonly
ID of the processing settings object
status
string
Values: unpaid partially_paid paid canceled
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
 

Legal Entities

https://api.payload.co/legal_entities

Nested Objects

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

Example

{
  "id": "le_1WltwEOdhGufFIbSsJ2opW2yG",
  "object": "legal_entity",
  "attrs": {},
  "business_id": "string",
  "city": "string",
  "contact_email": "email@address.com",
  "contact_name": "string",
  "contact_title": "string",
  "created_at": "2020-09-20 18:34:50",
  "ein": "numeric",
  "legal_name": "string",
  "modified_at": "2020-09-20 18:34:50",
  "owners": [],
  "phone_number": "(123) 456-7890",
  "postal_code": "postal_code",
  "start_date": "2020-09-20 18:34:50",
  "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
business_id
string
Business ID (CAD)
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
Array of associated Legal Entity Owner objects
phone_number
phone required
Phone number of the business
postal_code
postal_code 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

Nested Objects

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

Example

{
  "id": "ownr_6I7XHuaJKRBmib0RGVzNn9NC",
  "object": "legal_entity_owner",
  "attrs": {},
  "birth_date": "2020-09-20",
  "city": "string",
  "created_at": "2020-09-20 18:34:50",
  "email": "email@address.com",
  "full_name": "string",
  "legal_entity_id": "le_1ETPfYa16VqR3ayOnJ1z3cPWk",
  "modified_at": "2020-09-20 18:34:50",
  "ownership": 426.81,
  "phone_number": "(123) 456-7890",
  "postal_code": "postal_code",
  "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
date 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
postal_code 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
Type of owner
unit_number
string
Unit number of the owner

Line Items

https://api.payload.co/line_items

Nested Objects

https://api.payload.co/line_items/{id}/invoice

Example

{
  "id": "item_h6eA65v901ZtEi7cKwb1j2z8",
  "object": "line_item",
  "amount": 769.95,
  "attrs": {},
  "created_at": "2020-09-20 18:34:50",
  "description": "string",
  "entry_type": "charge",
  "incurred_date": "2020-09-20",
  "invoice_id": "inv_1wgOWbOYDdUs4rtZyCznTWlZZ",
  "modified_at": "2020-09-20 18:34:50",
  "qty": 591,
  "total": 532,
  "transaction_id": "txn_11UylliMCZFkC9CSLq0nr95dh",
  "type": "string"
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: line_item
amount
number
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
int readonly
Total amount of line item
transaction_id
id
ID of the associated Transaction
type
string
Arbitrary type classification

Orgs

https://api.payload.co/orgs

Nested Objects

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

Example

{
  "id": "acct_9iYx1Jqo6W9ZFfwyPLiGCT0R",
  "object": "org",
  "attrs": {},
  "created_at": "2020-09-20 18:34:50",
  "industry": "string",
  "legal_entity_id": "le_1jhBsyWqZpPISDmCyQGjs9m06",
  "modified_at": "2020-09-20 18:34:50",
  "name": "string",
  "org_type": "string",
  "parent_org_id": "acct_18lf9MNR7HWY2mKBGiqZbdEPu",
  "phone_number": "(123) 456-7890",
  "primary_processing_id": "acct_fVq5Ki52vqQOyaDmNdFDxDx0",
  "processing_settings_id": "ps_1VcY7kmgxp62H5IpJyfm00vqK",
  "timezone": "string",
  "processing_settings": {
    "id": "ps_15tFUyswVp8TTlEQO9WO82jjs",
    "applepay_enabled": false,
    "bank_account_conv_fee_alloc": 0,
    "bank_account_processing_enabled": true,
    "bank_account_trans_cost": 1.25,
    "bank_account_trans_rate": 0,
    "batch_fee": 214.6,
    "billing_preference": "netted_daily",
    "card_present": true,
    "card_processing_enabled": false,
    "change_fee": 727.67,
    "chargeback_fee": 336.63,
    "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,
    "googlepay_enabled": false,
    "googlepay_merchant_id": "string",
    "guarantor_required": true,
    "integrated": true,
    "minimum_bill": 894.68,
    "monthly_processing_fee": 25,
    "nabu_fee": 265.71,
    "pci_fee": 223.85,
    "prepaid_conv_fee_alloc": 0,
    "prepaid_trans_cost": 0.1,
    "prepaid_trans_rate": 0.0275,
    "pricing": "flat_rate",
    "processing_type": "payfac",
    "retrieval_fee": 897.3,
    "card_processing": {
      "credit": false,
      "debit": false,
      "prepaid": true
    }
  }
}
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: SessionPermission
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
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
integrated
bool readonly: function
Specify if account integrated or using external gateways
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
 
 

Payment Methods

https://api.payload.co/payment_methods

Nested Objects

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

Example

{
  "id": "pm_1J9DOhg9dU4DehuqAaw3DHO1k",
  "object": "payment_method",
  "account_holder": "string",
  "account_id": "acct_1MKzhXdbjPyGp8HwlbRRD0BR9",
  "attrs": {},
  "created_at": "2020-09-20 18:34:50",
  "customer_id": "acct_10vw6L23mgztweI8PXNgrcdVv",
  "default_payment_method": false,
  "description": "string",
  "modified_at": "2020-09-20 18:34:50",
  "phone_number": "(123) 456-7890",
  "processing_agreement": {},
  "type": "card",
  "bank_account": {
    "account_class": "personal",
    "account_currency": "USD",
    "account_number": "numeric",
    "account_type": "checking",
    "routing_number": "numeric"
  },
  "billing_address": {
    "city": "string",
    "postal_code": "postal_code",
    "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 non-default
ID of the associated Customer or Processing Account object
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
customer_id
id
ID of the associated Customer or Processing Account object
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
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_currency
string readonly: update
Values: USD CAD
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
postal_code 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
CVV code on back of card
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
 

Processing Accounts

https://api.payload.co/processing_accounts

Nested Objects

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_1KgfqQQhZEv3iu7d18WkwBwQR",
  "object": "processing_account",
  "attrs": {},
  "created_at": "2020-09-20 18:34:50",
  "description": "string",
  "industry": "string",
  "legal_entity": {},
  "legal_entity_id": "le_14OD55ghplGBhiFm9AmV7Z7Pe",
  "modified_at": "2020-09-20 18:34:50",
  "name": "string",
  "parent_org_id": "acct_1APzXxp3fxXZDEexvm4Pn3WLW",
  "payment_methods": [],
  "primary_processing_id": "acct_TGzQrWBft6nymXg3DtTjbVTp",
  "processing_settings_id": "ps_1JM0epWFNeIQsUzvFzQGweBrb",
  "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_1gyirxcNNV9l1ilIyouyguRMV",
    "applepay_enabled": true,
    "bank_account_conv_fee_alloc": 0,
    "bank_account_processing_enabled": true,
    "bank_account_trans_cost": 1.25,
    "bank_account_trans_rate": 0,
    "batch_fee": 824.21,
    "billing_preference": "netted_daily",
    "card_present": false,
    "card_processing_enabled": false,
    "change_fee": 918.48,
    "chargeback_fee": 469.15,
    "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,
    "googlepay_enabled": true,
    "googlepay_merchant_id": "string",
    "guarantor_required": true,
    "integrated": false,
    "minimum_bill": 316.74,
    "monthly_processing_fee": 25,
    "nabu_fee": 638.15,
    "pci_fee": 343.09,
    "prepaid_conv_fee_alloc": 0,
    "prepaid_trans_cost": 0.1,
    "prepaid_trans_rate": 0.0275,
    "pricing": "flat_rate",
    "processing_type": "payfac",
    "retrieval_fee": 123.94,
    "card_processing": {
      "credit": false,
      "debit": false,
      "prepaid": true
    }
  }
}
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
primary_processing_id
id
Specify the primary processing account for a customer
processing_settings_id
id readonly: function
ID of the associated processing settings
status
string readonly: SessionPermission
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
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: SessionPermission
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
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
integrated
bool readonly: function
Specify if account integrated or using external gateways
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
 
 

Transaction Ledger

https://api.payload.co/transaction_ledgers

Example

{
  "id": "lgr_BILnuzGzexsyV8R0NrjozuEv",
  "object": "transaction_ledger",
  "amount": 250.95,
  "assoc_transaction_id": "txn_wAQnnPgca8AOiTX5YZW9u9MT",
  "attrs": {},
  "created_at": "2020-09-20 18:34:50",
  "entry_type": "string",
  "modified_at": "2020-09-20 18:34:50",
  "processed_date": "2020-09-20",
  "transaction_id": "txn_1st61rbNobUXNTQbBMvcxbKNv"
}
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
processed_date
date readonly
Date transaction was processed
transaction_id
id required
ID of the Transaction object

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": "txn_5kdCNooM8Z2ojIEdwGv2hgPn",
  "object": "transaction",
  "amount": 786.01,
  "attrs": {},
  "card_code": "numeric",
  "conv_fee": 1.32,
  "created_at": "2020-09-20 18:34:50",
  "customer_id": "acct_5koKp3Hk2hY4ZXQGCiEjdHcK",
  "description": "string",
  "fee": 1.32,
  "funding_status": "pending",
  "modified_at": "2020-09-20 18:34:50",
  "order_number": "string",
  "payment_method": {},
  "payment_method_id": "pm_28M4PoQf7QwFuUzuNoLhgRrNI",
  "processed_date": "2020-09-20",
  "processing_id": "acct_d5omItKbxJjE3IZx4VUnJiKQ",
  "reader_id": "rdr_iYMczFRG5rTcqQe7GGmwj23W",
  "ref_number": "string",
  "risk_flag": "in_review",
  "risk_score": 492.13,
  "source": "keyed",
  "status": "authorized",
  "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
card_code
numeric non-default
CVV code on back of card
conv_fee
number non-default readonly
Convenience fee
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 non-default 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
processed_date
date readonly
Date transaction was processed
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: authorized processing processed declined voided rejected
status_code
string readonly: function
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 credit chargeback chargeback_reversal

Webhook Logs

https://api.payload.co/webhook_logs

Nested Objects

https://api.payload.co/webhook_logs/{id}/webhook

Example

{
  "id": "1ca16KSs78AnGQFh28a3sT9cL",
  "object": "webhook_log",
  "attrs": {},
  "created_at": "2020-09-20 18:34:50",
  "http_status": 814.32,
  "modified_at": "2020-09-20 18:34:50",
  "oauth_status": 702.6,
  "trigger": "bank_account_reject",
  "url": "string",
  "webhook_id": "RHCpa9b9UMl4EQjQVGWbmbTT",
  "triggered_on": {
    "id": "1ZpWBUT2sYgQ4CNMK5PEFOUvh",
    "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
number required
HTTP status response from OAuth Request
modified_at
datetime readonly
Timestamp object was last updated
oauth_status
number non-default
HTTP status response from OAuth Request
trigger
string required
Values: bank_account_reject refund void chargeback chargeback_reversal automatic_payment payment decline processing_status deposit
url
string required
Triggered URL
webhook_id
id required
ID of the associated Webhook object
triggered_on:  
id
string required
Object ID
object
string required
Object name
 

Webhooks

https://api.payload.co/webhooks

Nested Objects

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

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

Example

{
  "id": "U6Wi03BVbAEYOJ0UNxfpVbvm",
  "object": "webhook",
  "attrs": {},
  "created_at": "2020-09-20 18:34:50",
  "modified_at": "2020-09-20 18:34:50",
  "payment_link_id": "pay_t2VSbBNgf8uYMBB102yHcNPv",
  "reference_object": "string",
  "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
payment_link_id
id
ID of object reference
reference_object
string non-default
Type of object reference
trigger
string required
Values: bank_account_reject refund void chargeback chargeback_reversal automatic_payment payment decline processing_status deposit
url
string required
Triggered URL
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
Indicates the location of the target service or resource