Transfer Schema
Movement of funds between accounts associated with transactions
The Transfer schema defines the structure and properties of transfer objects in the Payload API. Transfers represent the movement of funds between accounts and are associated with transactions.
Transfer Object Properties
Complete reference for all properties available in the Transfer schema
amountnumber (double)Immutable
The monetary amount of this transfer. Positive amounts represent credits (funds received), while negative amounts represent debits (funds sent). This amount contributes to account balance calculations.
assoc_transaction_id ID of Transactionstring
ID of the associated transaction object. (ID prefix: txn)
Pattern:
^txn_[A-Za-z0-9]+$Required if:
receiver=nullsender=nullattrsobject
Custom attributes for extending the resource with additional key-value pairs. Maximum length is 255 characters when serialized.
created_atstring (date-time)Read-only
Timestamp when the resource was created. Automatically set by the system and immutable.
idstringRead-only
Unique identifier for the resource. Automatically generated upon creation and cannot be modified. (ID prefix: xfer)
Pattern:
^xfer_[A-Za-z0-9]+$modified_atstring (date-time)Read-only
Timestamp when the resource was last modified. Automatically updated whenever any field changes.
objectenum[string]Read-only
String representing the object type for this resource.
Values:
transferprocessed_datestring (date)Read-only
The date when this transfer was processed and settled. If the transfer has not yet been processed, this will default to the creation date. This date is used for reporting and reconciliation purposes.
receiverobject
Information about the receiver party in this transfer. This includes the account to which funds are being sent or credited.
accountAccountobject
The expanded receiver account object. When included, this provides the full details of the customer or processing account that is receiving funds in this transfer.
Visibility: explicit
account_id ID of AccountstringImmutable
ID of the associated account object. (ID prefix: acct)
Pattern:
^acct_[A-Za-z0-9]+$senderobject
Information about the sender party in this transfer. This includes the account from which funds are being sent or debited.
accountAccountobject
The expanded sender account object. When included, this provides the full details of the customer or processing account that is sending funds in this transfer.
Visibility: explicit
account_id ID of AccountstringImmutable
ID of the associated account object. (ID prefix: acct)
Pattern:
^acct_[A-Za-z0-9]+$transaction_id ID of TransactionstringRequired
ID of the transaction object (ID prefix: txn)
Pattern:
^txn_[A-Za-z0-9]+$typestringRead-only
The type of transfer. Possible values include payment, deposit, reversal, refund, reject, adjustment, credit, or transfer. This is automatically determined based on the associated transaction types and amounts.
Max length: 20