Transactions

Transaction Data Types

CreateTransactionRequest

Key Value Required Notes
type transactions  
Attributes      
transaction-type credit or debit  
amount Integer Any amount 0 or greater
precision Integer The currency precision as defined by ISO 4217 (number of digits after the decimal separator (eg, currency: “USD”, amount: 3199, precision: 2 is the same as $31.99))
currency String The international 3-letter code as defined by the ISO 4217 standard
memo String A human readable description of the transaction
payment-method PaymentMethod   Required when AccountRelationship is not present
metadata Metadata    
Relationships      
profile ProfileRelationship Profile for the transaction
account AccountRelationship   Account for the transaction, required when payment-method attribute is not present

PaymentMethod

Key Value Required Notes
type cash or bank_transfer or bank_redirect  
options PaymentMethodOptions   Any required options

PaymentMethodOptions

Key Value Required Notes
identifier String    
completion_redirect_url String   URL to send the user to on completion when using redirect methods
error_redirect_url String   URL to send the user to on error using redirect methods.

UpdateTransactionRequest

Key Value Required Notes
type transactions  
Attributes      
metadata Metadata    

TransactionResponse

Key Value Notes
type transactions  
Attributes    
transaction-type credit or debit  
amount Integer  
precision Integer The currency precision as defined by ISO 4217
currency String The international 3-letter code as defined by the ISO 4217 standard
memo String A human readable description of the transaction
status String One of: pending, processing, processed, or processing_failed
payment-method PaymentMethod  
metadata Metadata  
Relationships    
account AccountRelationship  
profile ProfileRelationship  

Table of contents