Get Balances by Account ID
643 matches
19 actions
Account and Transaction API Specification - UK
19 actions
- Create Account Access ConsentsPOSTv1.0.0
- Create SandboxPOSTv1.0.0
- Delete Account Access ConsentsDELETEv1.0.0
- Delete SandboxDELETEv1.0.0
- Get Account Access ConsentsGETv1.0.0
- Get AccountsGETv1.0.0
- Get AccountsGETv1.0.0
- Get BalancesGETv1.0.0
- Get BeneficiariesGETv1.0.0
- Get PartiesGETv1.0.0
- Get PartyGETv1.0.0
- Get PartyGETv1.0.0
- Get Scheduled PaymentsGETv1.0.0
- Get Standing OrdersGETv1.0.0
- Get StatementsGETv1.0.0
- Get StatementsGETv1.0.0
- Get StatementsGETv1.0.0
- Get TransactionsGETv1.0.0
- Get TransactionsGETv1.0.0
Finance/Account and Transaction API Specification - UK
Get Balances
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "AccountId"
},
"sandbox-id": {
"type": "string"
},
"x-customer-user-agent": {
"type": "string"
},
"x-fapi-auth-date": {
"type": "string"
},
"x-fapi-customer-ip-address": {
"type": "string"
},
"x-fapi-interaction-id": {
"type": "string"
}
},
"required": [
"accountId",
"sandbox-id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
{
"type": "object",
"required": [
"Data",
"Links",
"Meta"
],
"properties": {
"Data": {
"type": "object",
"required": [
"Balance"
],
"properties": {
"Balance": {
"type": "array",
"description": "Set of elements used to define the balance details.",
"items": {
"type": "object",
"description": "Set of elements used to define the balance details.",
"required": [
"AccountId",
"Amount",
"CreditDebitIndicator",
"DateTime",
"Type"
],
"properties": {
"AccountId": {
"type": "string",
"description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner."
},
"Amount": {
"type": "object",
"required": [
"Amount",
"Currency"
],
"properties": {
"Amount": {
"type": "string",
"description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217."
},
"Currency": {
"type": "string",
"description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\"."
}
},
"additionalProperties": false
},
"CreditDebitIndicator": {
"type": "string",
"enum": [
"Credit",
"Debit"
]
},
"CreditLine": {
"type": "array",
"description": "Set of elements used to provide details on the credit line.",
"items": {
"type": "object",
"required": [
"Included"
],
"properties": {
"Amount": {
"type": "object",
"required": [
"Amount",
"Currency"
],
"properties": {
"Amount": {
"type": "string",
"description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217."
},
"Currency": {
"type": "string",
"description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\"."
}
},
"additionalProperties": false
},
"Included": {
"type": "boolean",
"description": "Indicates whether or not the credit line is included in the balance of the account.\r\nUsage: If not present, credit line is not included in the balance amount of the account."
},
"Type": {
"type": "string",
"enum": [
"Available",
"Credit",
"Emergency",
"Pre-Agreed",
"Temporary"
]
}
},
"additionalProperties": false
}
},
"DateTime": {
"type": "string",
"format": "date-time",
"description": "Indicates the date (and time) of the balance.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00"
},
"Type": {
"type": "string",
"enum": [
"ClosingAvailable",
"ClosingBooked",
"ClosingCleared",
"Expected",
"ForwardAvailable",
"Information",
"InterimAvailable",
"InterimBooked",
"InterimCleared",
"OpeningAvailable",
"OpeningBooked",
"OpeningCleared",
"PreviouslyClosedBooked"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"Links": {
"type": "object",
"description": "Links relevant to the payload",
"required": [
"Self"
],
"properties": {
"First": {
"type": "string"
},
"Last": {
"type": "string"
},
"Next": {
"type": "string"
},
"Prev": {
"type": "string"
},
"Self": {
"type": "string"
}
},
"additionalProperties": false
},
"Meta": {
"type": "object",
"description": "Meta Data relevant to the payload",
"properties": {
"FirstAvailableDateTime": {
"type": "string",
"description": "All dates in the JSON payloads are represented in ISO 8601 date-time format.\r\nAll date-time fields in responses must include the timezone.An example is below:\r\n2017-04-05T10:43:07+00:00"
},
"LastAvailableDateTime": {
"type": "string",
"description": "All dates in the JSON payloads are represented in ISO 8601 date-time format.\r\nAll date-time fields in responses must include the timezone.An example is below:\r\n2017-04-05T10:43:07+00:00"
},
"TotalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}