Balance Transaction

A movement of money in or out of the merchant balance, including signed gross, fees, net and the source resource.

id*string

object*"balance_transaction"

Value in

"balance_transaction"

amount*number

Signed gross amount in smallest currency units

availableOn*|

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Formatdate-time

createdAt*string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Formatdate-time

currency*string

Value in

"EGP"
"USD"
"EUR"
"GBP"
"SAR"
"AED"
"QAR"
"KWD"
"JOD"
"OMR"
"BHD"
"LYD"
"AUD"
"CAD"
"CNY"

description*string|null

fee*number

net*number

feeDetails*array<>

Merchant fee breakdown, excluding processor costs

status*string

Value in

"AVAILABLE"
"PENDING"

type*string

Value in

"CHARGE"
"PAYMENT"
"PAYMENT_FAILURE_REFUND"
"PAYMENT_REFUND"
"PAYMENT_REVERSAL"
"REFUND"
"REFUND_FAILURE"
"ADJUSTMENT"
"ADVANCE"
"ADVANCE_FUNDING"
"PAYOUT"
"PAYOUT_CANCEL"
"PAYOUT_FAILURE"
"PAYOUT_MINIMUM_BALANCE_HOLD"
"PAYOUT_MINIMUM_BALANCE_RELEASE"
"RESERVED_FUNDS"
"RESERVE_HOLD"
"RESERVE_RELEASE"
"RECOVERY_FROM_FUTURE_FUNDS"
"XPAY_FEE"
"XPAY_FX_FEE"
"TAX_FEE"
"TOPUP"
"TOPUP_REVERSAL"

reportingCategory*string

exchangeRate*number|null

source*string

Source resource ID

payoutBatch*|null

paymentIntentId*string|null

merchantId*string

{  "id": "string",  "object": "balance_transaction",  "amount": 0,  "availableOn": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "currency": "EGP",  "description": "string",  "fee": 0,  "net": 0,  "feeDetails": [    {      "amount": 0,      "currency": "EGP",      "description": "string",      "type": "string",      "application": "string"    }  ],  "status": "AVAILABLE",  "type": "CHARGE",  "reportingCategory": "string",  "exchangeRate": 0,  "source": "string",  "payoutBatch": {    "id": "string",    "object": "payout_batch",    "amount": 0,    "currency": "EGP",    "status": "open",    "arrivalDate": "2019-08-24",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "paymentIntentId": "string",  "merchantId": "string"}