Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments are sent to your liable 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
Close an account
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
{
"type": "object",
"required": [
"accountCode"
],
"properties": {
"accountCode": {
"type": "string",
"description": "The code of account to be closed."
}
}
}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
{
"type": "object",
"properties": {
"accountCode": {
"type": "string",
"description": "The account code of the account that is closed."
},
"invalidFields": {
"type": "array",
"description": "Contains field validation errors that would prevent requests from being processed.",
"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."
}
}
}
}
}
},
"pspReference": {
"type": "string",
"description": "The reference of a request. Can be used to uniquely identify the request."
},
"resultCode": {
"type": "string",
"description": "The result code."
},
"status": {
"type": "string",
"description": "The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.",
"enum": [
"Active",
"Closed",
"Inactive",
"Suspended"
]
}
}
}