Accounts

Account Data Types

AccountRequest

Key Value Required Notes
type accounts  
Attributes      
nickname String  
details BankAccountParams or CreditCardParams or VaultedAccountParams or ChinaBankAccountParams  
Relationships      
owner OwnerRelationship  

UpdateAccountRequest

Key Value Required Notes
type accounts  
id UUID  
Attributes      
nickname String    
details UpdateCreditCardParams    
metadata Metadata    

AccountResponse

Key Value Notes
type accounts  
Attributes    
nickname String  
status new or active or invalid  
details BankAccount or CreditCard or VaultedAccount or ChinaBankAccount  
metadata Metadata  
Relationships    
owner OwnerRelationship  

BankAccountParams

Key Value Required Notes
type bank-accounts  
routing-number String  
account-number String  
account-holder-type personal or business  
account-category checking or savings  

BankAccount

Key Value Notes
type bank-accounts  
routing-number String  
account-holder-type personal or business  
account-category checking or savings  

ChinaBankAccountParams

Key Value Required Notes
type china-bank-accounts  
account String  
bank String    
bank-branch String    

NOTE: Either bank or bank-branch must be provided.

ChinaBankAccount

Key Value Notes
type china-bank-accounts  
description String  
bank String  
bank-branch String  

CreditCardParams

Key Vaslue Required Notes
type credit-cards  
card-number String  
cardholder-name String  
billing-address-id UUID  
expiration-date String MMYY format
cvv String    

UpdateCreditCardParams

Key Vaslue Required Notes
type credit-cards  
cardholder-name String    
billing-address-id UUID    
cvv String    

CreditCard

Key Value Required Notes
type credit-cards  
card-holder-name String    
billing-address BillingAddress    
expiration-date String MMYY format  

BillingAddress

Key Value Notes
id UUID  
street1 String  
street2 String  
zipcode String  
locality String  
sub-locality String  
region String  
country String  

VaultedAccountParams

Key Value Required Notes
type vaulted-accounts  
vault-provider String  
vault-identifier String  
account-info Object   Provider specific info used to identify the payment method when necessary

VaultedAccount

Key Value Notes
type vaulted-accounts  
vault-provider String  
vault-identifier String  
account-info Object Provider specific info that is returned for the payment method

Table of contents