Beneficiary /   Update Beneficiary

v1/Accounts/UpdateBeneficiary

 

API parameters
Required

 

Name In Type Description Default
Bearer Token Authorization string Authentication token.
X-Request-Id Path string Unique Id.
ClientId Json Data string Client UUId.
BeneficiaryId Json Data string BeneficiaryId.
Country Json Data string Two letter code for the country in which the beneficiary's bank account is held.
Currency Json Data string Currency in which money is held in the beneficiary's bank account. Three digit currency code.
BeneType Json Data string Legal entity. I,C
Account Name Json Data string Account Name
AccountNumber Json Data string Bank account number.
RoutingCodeType Json Data string Local payment routing system. Sort Code,aba,bsb
RoutingCodeValue Json Data string Routing code for routing code type.
BeneficiaryId Json Data string BeneficiaryId
Status Json Data string Beneficiary status. Active,Inactive

 

Optional

 

Name In Type Description Default
CustomerId Parameter string CustomerId.
MiddleName Json Data string Required if beneficiary entity type is individual.
Email Json Data string Email address.
ISDCode Json Data string Different Countries use different ISD Code.
ContactNumber Json Data string ContactNumber.
Reference Json Data string Beneficiary external reference.
FirstName Json Data string Required if beneficiary entity type is individual(Optional in GBP only)
LastName Json Data string Required if beneficiary entity type is individual(Optional in GBP only)
CompanyName Json Data string Required if beneficiary entity type is company(Optional in GBP only)
Address Json Data string First line of address(Optional in GBP only)
City Json Data string City(Optional in GBP only)
PostCode Json Data string Postal code(Optional in GBP only)
Country Json Data string Two-letter country code If the beneficiary is a company the country in which the company is registered If the beneficiary is an individual a country in which the beneficiary holds nationality(Optional in GBP only)
BankName Json Data string Bank name(Optional in GBP only)
IBAN Json Data string IBAN code(Optional in GBP only)
SWIFTCode Json Data string BIC/SWIFT code(Optional in GBP only)
RoutingCodeType2 Json Data string Local payment routing system(Optional in GBP only) Sort Code,aba,bsb
RoutingCodeValue2 Json Data string Routing code for routing code type2(Optional in GBP only)

 

Request

 

{
     "BeneficiaryDetails": [{    
     "BeneficiaryId": "C04941C9-05BE-4460-9869",
     "PaymentInformation": {
     "Country": "DE",
     "Currency": "EUR",
     "BeneType": "C"
     },
     "BeneDetails": {
     "AccountName": "Test XYZ",
     "FirstName": "",
     "MiddleName": "",
     "LastName": "",
     "CompanyName": "Test XYZ",
     "Address": "London",
     "City": "London",
     "PostCode": "HA98UE",
     "Country": "GB",
     "Email": "Will@test.com",
     "ISDCode": "",
     "ContactNumber": ""
     },
     "BeneBankDetails":{
     "BankName": "Test Bank",
     "AccountNumber": "",
     "IBAN": "DE96BARC202015300934591",
     "SWIFTCode": "TGREDE58479",
     "RoutingCodeType": "",
     "RoutingCodeValue": "",
     "RoutingCodeType2": "",
     "RoutingCodeValue2": "",
     "Reference": "Test898588"
    }
  ]}
 
}

 

Response

 

{

     "message": "Beneficiary updated successfully!!!"
 
}

 

Error Codes

 

HTTP Status Code Description
401 Invalid Credentials Authentication failed with the supplied credentials
401 Invalid credentials Invalid credentials
404 Invalid beneficiaryid Invalid beneficiaryid
404 Invalid currency Currency should we ISO format
400 Invalid JSON body Invalid JSON body
106 RequestId already in use RequestId already in use
107 Invalid client id Invalid client id
404 Invalid beneficiary type Invalid beneficiary type
404 Invalid country Invalid country
116 Client id required Client id required
121 Request id required Request id required
400 Beneficiary account number required Beneficiary account number required
400 Beneficiary IBAN required Beneficiary IBAN required
400 Account number can not be greater than its defined length Account number can not be greater than its defined length
400 Account number can not be less than its defined length Account number can not be less than its defined length
400 IBAN can not be greater than its defined length IBAN can not be greater than its defined length
400 IBAN can not be less than its defined length IBAN can not be less than its defined length
404 Invalid IBAN Invalid IBAN
400 Routing value required Routing value required
400 Routing code value can not be greater than its defined value Routing code value can not be greater than its defined value
400 Routing code value can not be less than its defined value Routing code value can not be less than its defined value
400 Beneficiary SWIFT code required Beneficiary SWIFT code required
400 SWIFT code can not be greater than 11 digits SWIFT code can not be greater than 11 digits
400 SWIFT code can not be less than 8 digits SWIFT code can not be less than 8 digits
404 Invalid SWIFT code Invalid SWIFT code
400 Beneficiary bank name required Beneficiary bank name required
400 Beneficiary bank country required Beneficiary bank country required
400 Beneficiary currency required Beneficiary currency required
400 Beneficiary type required Beneficiary type required
400 Beneficiary first name required Beneficiary first name required
400 Beneficiary last name required Beneficiary last name required
400 Company name required Company name required
400 Beneficiary address required Beneficiary address required
400 Beneficiary city required Beneficiary city required
400 Beneficiary postcode required Beneficiary postcode required
400 Beneficiary country required Beneficiary country required
400 Beneficiary routing type required Beneficiary routing type required
404 Invalid status Invalid status
401 Invalid Credentials Authentication failed with the supplied credentials