Updates the description or payout schedule of an account.
643 matches
18 actions
Account
18 actions
- Close an accountPOSTv1.0.0
- Close an account holderPOSTv1.0.0
- Close storesPOSTv1.0.0
- Create an accountPOSTv1.0.0
- Create an account holderPOSTv1.0.0
- Delete bank accountsPOSTv1.0.0
- Delete legal arrangementsPOSTv1.0.0
- Delete payout methodsPOSTv1.0.0
- Delete shareholdersPOSTv1.0.0
- Delete signatoriesPOSTv1.0.0
- Get a tax formPOSTv1.0.0
- Get an account holderPOSTv1.0.0
- Suspend an account holderPOSTv1.0.0
- Trigger verificationPOSTv1.0.0
- Unsuspend an account holderPOSTv1.0.0
- Update an accountPOSTv1.0.0
- Update an account holderPOSTv1.0.0
- Update payout or processing statePOSTv1.0.0
Other/Account
Update an account
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
- 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
{
"type": "object",
"required": [
"accountCode"
],
"properties": {
"accountCode": {
"type": "string",
"description": "The code of the account to update."
},
"bankAccountUUID": {
"type": "string",
"description": "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder."
},
"description": {
"type": "string",
"description": "A description of the account, maximum 256 characters.You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`."
},
"metadata": {
"type": "object",
"description": "A set of key and value pairs for general use by the merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs."
},
"payoutMethodCode": {
"type": "string",
"description": "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code."
},
"payoutSchedule": {
"type": "object",
"description": "The details of the payout schedule, to which the account should be updated.",
"required": [
"schedule"
],
"properties": {
"action": {
"type": "string",
"description": "Direction on how to handle any payouts that have already been scheduled.\nPermitted values:\n* `CLOSE` will close the existing batch of payouts.\n* `UPDATE` will reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**) will allow the payout to proceed.",
"enum": [
"CLOSE",
"NOTHING",
"UPDATE"
]
},
"reason": {
"type": "string",
"description": "The reason for the payout schedule update.\n> This field is required when the `schedule` parameter is set to `HOLD`."
},
"schedule": {
"type": "string",
"description": "The payout schedule to which the account is to be updated.\nPermitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n`HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.",
"enum": [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
"DAILY_AU",
"DAILY_EU",
"DAILY_SG",
"DAILY_US",
"HOLD",
"MONTHLY",
"WEEKLY",
"WEEKLY_MON_TO_FRI_AU",
"WEEKLY_MON_TO_FRI_EU",
"WEEKLY_MON_TO_FRI_US",
"WEEKLY_ON_TUE_FRI_MIDNIGHT",
"WEEKLY_SUN_TO_THU_AU",
"WEEKLY_SUN_TO_THU_US"
]
}
}
},
"payoutSpeed": {
"type": "string",
"description": "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"enum": [
"INSTANT",
"SAME_DAY",
"STANDARD"
]
}
}
}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
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
{
"type": "object",
"required": [
"accountCode"
],
"properties": {
"accountCode": {
"type": "string",
"description": "The code of the account."
},
"bankAccountUUID": {
"type": "string",
"description": "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder."
},
"description": {
"type": "string",
"description": "The description of the account."
},
"invalidFields": {
"type": "array",
"description": "A list of fields that caused the `/updateAccount` request to fail.",
"items": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"format": "int32",
"description": "The validation error code."
},
"errorDescription": {
"type": "string",
"description": "A description of the validation error."
},
"fieldType": {
"type": "object",
"description": "The type of error field.",
"properties": {
"field": {
"type": "string",
"description": "The full name of the property."
},
"fieldName": {
"type": "string",
"description": "The type of the field.",
"enum": [
"accountCode",
"accountHolderCode",
"accountHolderDetails",
"accountNumber",
"accountStateType",
"accountStatus",
"accountType",
"address",
"balanceAccount",
"balanceAccountActive",
"balanceAccountCode",
"balanceAccountId",
"bankAccount",
"bankAccountCode",
"bankAccountName",
"bankAccountUUID",
"bankBicSwift",
"bankCity",
"bankCode",
"bankName",
"bankStatement",
"branchCode",
"businessContact",
"cardToken",
"checkCode",
"city",
"companyRegistration",
"constitutionalDocument",
"controller",
"country",
"countryCode",
"currency",
"currencyCode",
"dateOfBirth",
"description",
"destinationAccountCode",
"document",
"documentContent",
"documentExpirationDate",
"documentIssuerCountry",
"documentIssuerState",
"documentName",
"documentNumber",
"documentType",
"doingBusinessAs",
"drivingLicence",
"drivingLicenceBack",
"drivingLicenceFront",
"drivingLicense",
"email",
"firstName",
"formType",
"fullPhoneNumber",
"gender",
"hopWebserviceUser",
"houseNumberOrName",
"iban",
"idCard",
"idCardBack",
"idCardFront",
"idNumber",
"identityDocument",
"individualDetails",
"infix",
"jobTitle",
"lastName",
"lastReviewDate",
"legalArrangement",
"legalArrangementCode",
"legalArrangementEntity",
"legalArrangementEntityCode",
"legalArrangementLegalForm",
"legalArrangementMember",
"legalArrangementMembers",
"legalArrangementName",
"legalArrangementReference",
"legalArrangementRegistrationNumber",
"legalArrangementTaxNumber",
"legalArrangementType",
"legalBusinessName",
"legalEntity",
"legalEntityType",
"logo",
"merchantAccount",
"merchantCategoryCode",
"merchantHouseNumber",
"merchantReference",
"microDeposit",
"name",
"nationality",
"originalReference",
"ownerCity",
"ownerCountryCode",
"ownerDateOfBirth",
"ownerHouseNumberOrName",
"ownerName",
"ownerPostalCode",
"ownerState",
"ownerStreet",
"passport",
"passportNumber",
"payoutMethodCode",
"payoutSchedule",
"pciSelfAssessment",
"personalData",
"phoneCountryCode",
"phoneNumber",
"postalCode",
"primaryCurrency",
"reason",
"registrationNumber",
"returnUrl",
"schedule",
"shareholder",
"shareholderCode",
"shareholderCodeAndSignatoryCode",
"shareholderCodeOrSignatoryCode",
"shareholderType",
"shareholderTypes",
"shopperInteraction",
"signatory",
"signatoryCode",
"socialSecurityNumber",
"sourceAccountCode",
"splitAccount",
"splitConfigurationUUID",
"splitCurrency",
"splitValue",
"splits",
"stateOrProvince",
"status",
"stockExchange",
"stockNumber",
"stockTicker",
"store",
"storeDetail",
"storeName",
"storeReference",
"street",
"taxId",
"tier",
"tierNumber",
"transferCode",
"ultimateParentCompany",
"ultimateParentCompanyAddressDetails",
"ultimateParentCompanyAddressDetailsCountry",
"ultimateParentCompanyBusinessDetails",
"ultimateParentCompanyBusinessDetailsLegalBusinessName",
"ultimateParentCompanyBusinessDetailsRegistrationNumber",
"ultimateParentCompanyCode",
"ultimateParentCompanyStockExchange",
"ultimateParentCompanyStockNumber",
"ultimateParentCompanyStockNumberOrStockTicker",
"ultimateParentCompanyStockTicker",
"unknown",
"value",
"verificationType",
"virtualAccount",
"visaNumber",
"webAddress",
"year"
]
},
"shareholderCode": {
"type": "string",
"description": "The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder."
}
}
}
}
}
},
"metadata": {
"type": "object",
"description": "A set of key and value pairs containing metadata."
},
"payoutMethodCode": {
"type": "string",
"description": "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code."
},
"payoutSchedule": {
"type": "object",
"description": "The payout schedule of the account.",
"properties": {
"nextScheduledPayout": {
"type": "string",
"format": "date-time",
"description": "The date of the next scheduled payout."
},
"schedule": {
"type": "string",
"description": "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.",
"enum": [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
"DAILY_AU",
"DAILY_EU",
"DAILY_SG",
"DAILY_US",
"HOLD",
"MONTHLY",
"WEEKLY",
"WEEKLY_MON_TO_FRI_AU",
"WEEKLY_MON_TO_FRI_EU",
"WEEKLY_MON_TO_FRI_US",
"WEEKLY_ON_TUE_FRI_MIDNIGHT",
"WEEKLY_SUN_TO_THU_AU",
"WEEKLY_SUN_TO_THU_US"
]
}
}
},
"payoutSpeed": {
"type": "string",
"description": "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"enum": [
"INSTANT",
"SAME_DAY",
"STANDARD"
]
},
"pspReference": {
"type": "string",
"description": "The reference of a request. Can be used to uniquely identify the request."
},
"resultCode": {
"type": "string",
"description": "The result code."
}
}
}