Skip to main content
{
	"amount": 6.9,
	"created_at": "2023-12-01T05:00:00.401Z",
	"currency": "usd",
	"destination": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"typename": "User",
		"username": "johndoe42"
	},
	"destination_ledger_account_id": "ldgr_xxxxxxxxxxxxx",
	"fee_amount": 6.9,
	"id": "ctt_xxxxxxxxxxxxxx",
	"metadata": {},
	"notes": "Monthly revenue share payout",
	"origin": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"typename": "User",
		"username": "johndoe42"
	},
	"origin_ledger_account_id": "ldgr_xxxxxxxxxxxxx"
}
​
amount
number
required
The transfer amount in the currency specified by the currency field. For example, 10.43 represents $10.43 USD.Example: 6.9
​
created_at
string<date-time>
required
The datetime the credit transaction transfer was created.Example: 2023-12-01T05:00:00.401Z
​
currency
Currencies
required
The currency in which this transfer amount is denominated.Available options: usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xau
​
destination
User or Company | null
required
The entity receiving the transferred funds.
​
destination_ledger_account_id
string
required
The unique identifier of the ledger account receiving the funds.Example: ldgr_xxxxxxxxxxxxx
​
fee_amount
number | null
required
The flat fee amount deducted from this transfer, in the transfer’s currency. Null if no flat fee was applied.Example: 6.9
​
id
string
required
The unique identifier for the credit transaction transfer.Example: ctt_xxxxxxxxxxxxxx
​
metadata
object | null
required
Custom key-value pairs attached to this transfer. Maximum 50 keys, 500 characters per key, 5000 characters per value.
​
notes
string | null
required
A free-text note attached to this transfer by the sender. Null if no note was provided.Example: Monthly revenue share payout
​
origin
User or Company | null
required
The entity that sent the transferred funds.
​
origin_ledger_account_id
string
required
The unique identifier of the ledger account that sent the funds.Example: ldgr_xxxxxxxxxxxxx