Get started
API Endpoint Url: https://connect1-sandbox.codegotech.com/api
e.g curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/configSetting' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic Q29kZWdvUGF5Xzg5Om1rZVRWVWNTWTJCWFJZZWZpV1RQdURMaGF6YTFOWWhwUH' \
The Codego sandbox API provides programmatic access to core banking solutions data like provide an authorization, KYC, IBAN Accounts,Debitcards etc.
To use this API, you need an username,password for Basic auth. The authorization header will be automatically generated when you send the request. Basic authentication involves sending a verified username and password with your request. In the request Authorization tab, select Basic Auth from the Type dropdown list. Enter your API username and password in the Username and Password fields. For extra security, store these in variables. In the request Headers, the Authorization header passes the API a Base64 encoded string representing your username and password values, appended to the text Basic as follows:.
Please contact us at banking@codegotech.com to get your own API keys.
CONFIGURATION SETTINGS
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/configSetting' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel_id"}'
This api is used to get the web configuration settings .e.g. site name , logos , fav icons etc :
https://connect1-sandbox.codegotech.com/api/individualbassapi/configSetting
Response :
{"status":1,"config":{"site_name":"ftx","site_shortname":"","site_email":"","site_color":"#ffffff","contact_email":null,"email":null,"logo":"https:\/\/res.cloudinary.com\/hashfort\/image\/upload\/v1682595042\/logo\/ictgvexi7nnzfe7sweff.png","site_favicon":"https:\/\/res.cloudinary.com\/hashfort\/image\/upload\/v1639061664\/logo\/tnauanyuydyf8lsta9gq.png","copy_right_text":null,"facebooklink":null,"twitterlink":null,"googlelink":null,"youtube":null,"instagram":null,"linkdin":null,"address":null,"phone":null,"dark_logo":"https:\/\/res.cloudinary.com\/durotechindustries-com-au\/image\/upload\/v1704704627\/dw3hempivdyvzbcvdy38.png","support_link":"","tc_link":"","privacy_link":"","android_app_link":"","ios_app_link":"","google_captcha_client":null,"google_captcha_secret":null,"contact_url":""},"links":{"business_website_url":"","personal_website_url":""}}
REQUEST BODY
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
Country List
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/getCountriesList' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel_id"}'
This will return list of all the available countries.This will be used in further API's:
https://connect1-sandbox.codegotech.com/api/individualbassapi/getCountriesList
Response :
{
status:1,
countries:
[
{
"id":"106",
"country_code":"IT",
"country_name":"Italy",
"phonecode":"39",
"iso3":"380",
"status":"1",
"is_iban":"1",
"europe_country":"1",
"solaris_iban":"1",
"shipping_cost":"5"
}
]
}
REQUEST BODY
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
Individual Plans
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/getPlan' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"Your whitelabel id"}'
This will return the individual plans and countries according to the individual plans .e.g. High Plans,
Medium Plans and Low Plans :
https://connect1-sandbox.codegotech.com/api/individualbassapi/getPlan
Response :
{"status":1,"low_plans":[{"unique_id":"045c1dosuyz7htun4s7ur41nr10jfc2k8bpbtxw1qom48bq0qw","id":"25","tag":"tbngd55ycon29jz03403pz","plan_name":"Basic
PLan Low
Risk","eur_plan_price":"0.00","description":"","features":"","sepa_out_fee":"1.00","sepa_in_fee":"1.00","sepa_instant_out_fee":"2.00","sepa_instant_in_fee":"0.25","sepa_out_fee_percentage":"0.00","sepa_in_fee_percentage":"0.00","sepa_instant_out_fee_percentage":"0.00","sepa_instant_in_fee_percentage":"0.00","risk":"low","monthly_account":"0.30"}],"medium_plans":[{"unique_id":"zs6z6zwy9zr4e1kwm5x7dxm1u5sddkay5f7z222e11f9nz4z27","id":"27","tag":"j41pu2k615a3dfg2duxu77","plan_name":"IBAN
MR","eur_plan_price":"900.00","description":"\t","features":"","sepa_out_fee":"1.00","sepa_in_fee":"0.25","sepa_instant_out_fee":"2.00","sepa_instant_in_fee":"1.00","sepa_out_fee_percentage":"0.30","sepa_in_fee_percentage":"0.30","sepa_instant_out_fee_percentage":"0.30","sepa_instant_in_fee_percentage":"0.30","risk":"medium","monthly_account":"0.30"}],"high_plans":[{"unique_id":"5ovr1oyqqq234rfsdbg6lvkd46r0azls8q8121zibshdqy2ax4","id":"29","tag":"vq578tjpkqmippcegzu4n5","plan_name":"IBAN
HR","eur_plan_price":"1800.00","description":"\t","features":"","sepa_out_fee":"0.50","sepa_in_fee":"0.50","sepa_instant_out_fee":"0.50","sepa_instant_in_fee":"0.50","sepa_out_fee_percentage":"0.50","sepa_in_fee_percentage":"0.50","sepa_instant_out_fee_percentage":"0.50","sepa_instant_in_fee_percentage":"0.50","risk":"high","monthly_account":"0.25"}],"countries":[{"id":"3","name":"Albania","risk_level":"1"},{"id":"4","name":"Algeria","risk_level":"1"},{"id":"5","name":"American
Samoa","risk_level":"1"},{"id":"6","name":"Andorra","risk_level":"2"},{"id":"7","name":"Angola","risk_level":"1"},{"id":"8","name":"Anguilla","risk_level":"2"},{"id":"9","name":"Antarctica","risk_level":"1"},{"id":"10","name":"Antigua
and
Barbuda","risk_level":"2"}]}
REQUEST BODY
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
Note:
Plan can be changed based on country risk. If country risk_level is 1 then show High Risk plan, risk_level is 2 then show Medium Risk plan, risk_level is 3 then show low risk plan.
Verify Google Recaptcha
# Here is a curl example
curl --location 'https://sandbox.codegotech.com/Bassapi/verifygooglecaptcha' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel_id","g_recaptcha_response":""}
This api is used to verify the google recaptcha :
https://connect1-sandbox.codegotech.com/api/individualbassapi/verifygooglecaptcha
Response :
{"status":1,"message":"Succesfully verified"}
REQUEST BODY
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
g_recaptcha_response | String | value received after verifying the google recaptcha. |
Open Account: Create an individual onboarding link
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/openAccount' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data-raw '{"whitelabel_id":"your whitelabel_id","email":"your email"}'
This api is used for opening the account. Entering a valid email will send an OTP to your
email and you can verify the email:
https://connect1-sandbox.codegotech.com/api/individualbassapi/openAccount
Response :
{"status":1,"message":"We have sent OTP in your email. Please check your email."}
{"status":0,"message":"Email already exists."}
REQUEST BODY
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
String | your email | |
ipaddress | String | Send user ipaddress |
Signup: Verify Email For Signup
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/verify_email' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{
"whitelabel_id": "your whitelabel_id",
"email": "your email",
"code": "otp sent to your email "
}'
This api is used to verify the email for opening the account. :
https://connect1-sandbox.codegotech.com/api/individualbassapi/verify_email
Response :{"status":1,"message":"Congratulations, Your email address has been verified. "}
REQUEST BODY
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
String | Enter your registered email address | |
code | String | Enter otp code, we have sent your registered emal. |
Note:
Only two attempt allow to verify email account.
Signup: Update an individual onboarding
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/signup' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Q29kZWdvUGF5Xzg5Om1rZVRWVWNTWTJCWFJZZWZpV1RQdURMaGF6YTFOWWhwUHVvZm1wbjU3VXd6QUJMZGNo' \
--data-raw '{"whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945", "name": "", "surname": "", "phonecode": "20", "mobile": "", "email": "", "password": "", "dob": "", "nationality": "99", "address": "", "city": "", "country": 99, "zipcode": "6000", "is_same": "1", "receive_card_address": "via riolo 30", "receive_card_city": "plaermo", "receive_card_country": "106", "receive_card_zipcode": "90141", "gender": "Male", "ipaddress": "127.0.0.1", "user_wallet": "eur", "tax_personal_number": "12345x", "income_source": "Salary", "country_pay_tax": "106", "purpose_account": "shoping online"}'
This api is used to complete the signup process. :
https://connect1-sandbox.codegotech.com/api/individualbassapi/signup
Response :
{"status":1,"user_id":"user_id","message":"Registration
is completed successfully."}
REQUEST BODY
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
name | String | Customer Name |
surname | String | Customer Surname |
phonecode | Integer | Country code phonecode |
mobile | Integer | Customer Contact Number |
String | Customer Email address | |
dob | string | Customer Date of Birth |
gender | string | Male/Female |
nationality | Integer | nationality id (received from nationality list api) |
address | string | Customer complete address |
city | string | |
country | Integer | country id (received from country list api) |
zipcode | string | Customer postal code |
is_same | Integer | is_same=1 if shipping address is same otherwise is_same=0 |
receive_card_address | string | Customer complete shipping address |
receive_card_city | string | shipping city |
receive_card_country | Integer | country id (received from country list api) |
receive_card_zipcode | string | Customer shipping postal code |
ipaddress | string | IP address |
country_pay_tax | Integer | country id (received from country list api) |
tax_personal_number | string | Tax Number |
income_soruce | string |
income source (received from income source list api)
e.g: 'Salary'; Self Employment, Assets/Investing/Trading/Dividends |
purpose_account | string | purpose account (Write about why you want to register an account with us.) |
Login
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/login' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data-raw '{"whitelabel_id":"your whitelabel_id","email":"your registered email","password":"your password"}'
You can authenticate through this api by entering the valid credentials . :
https://connect1-sandbox.codegotech.com/api/individualbassapi/login
Response :
{"status":1,"is_live":0,"company_name":" Company name","unique_id":"unique id","whitelabel_id":"white label id","device_model":"iPhone","device_type":"Apple Phone","user_id":"user id"}
{"status":0,"message":"Wrong email or password."}
REQUEST BODY
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
String | your registered email | |
password | String | Your password |
Note:
if the login verification is successful, you will get the is_live property in the response. is_live:0 means that your account is not verified and you have to complete the verification . If is_live:1 then it means that your account is verified and you can take the user to dashboard.
if is_live == 0 kyc_status == 1 it means the Kyc link is already sent to user email, if you not receive send after 15 minute
if is_live == 0 and kyc_status == 2 customer profile verified
if is_live == 0 and kyc_status == 3 Kyc has been rejected. Please resubmit the link and finish your KYC.
if is_live == 0 and kyc_status == 4 Kyc has been partially-rejected. Please resubmit the link and finish your KYC.
Verify OTP For Login
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/verifyLogin' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel id","user_id":"user_id from the login response","otp":"otp sent to your email"}'
This api is used to verify the user login with OTP. :
https://connect1-sandbox.codegotech.com/api/individualbassapi/verifyLogin
Response :
{company_name:"Company 21", is_live: 0, status:1, user_id:"user id", web_token: "web token", whitelabel_id:"whitelabel id"}
{"status":0,"message":"You have entered wrong otp code"}
REQUEST BODY
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id from the login response |
otp | String | otp sent to your email |
Note
if the login verification is successful, you will get the is_live property in the response. is_live:0 means that your account is not verified and you have to complete the verification . If is_live:1 then it means that your account is verified and you can take the user to dashboard.
if is_live == 0 kyc_status == 1 it means the Kyc link is already sent to user email, if you not receive send after 15 minute
if is_live == 0 and kyc_status == 2 customer profile verified
if is_live == 0 and kyc_status == 3 Kyc has been rejected. Please resubmit the link and finish your KYC.
if is_live == 0 and kyc_status == 4 Kyc has been partially-rejected. Please resubmit the link and finish your KYC.
Check KYC Status
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/checkKycStatus' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel_id id","user_id":"user_id from signup response"}'
This api is used to check the KYC Status:
https://connect1-sandbox.codegotech.com/api/individualbassapi/checkKycStatus
Response :
{"status":1,"kyc_status":2,"message":"Your kyc has been already verified."}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api. |
user_id | String | user id from authentication api. |
whitelabel_id | String | Your whitelabel id |
NOTE
if kyc_status == 1 it means the Kyc link is already sent to user email, if you not receive send after 15 minute
if kyc_status == 2 customer profile verified
if kyc_status == 3 Kyc has been rejected. Please resubmit the link and finish your KYC.
if kyc_status == 4 Kyc has been partially-rejected. Please resubmit the link and finish your KYC.
Resend KYC Link
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/sendkyclink' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel_id id","user_id":"user_id from auth response"}'
This api will resend the kyc link to director email:
https://connect1-sandbox.codegotech.com/api/individualbassapi/sendkyclink
Response :
{"status":1,"message":"This api work only for live."}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api. |
user_id | String | user id from authentication api. |
whitelabel_id | String | Your whitelabel id |
NOTE
you can request to send the kyc link to complete the company director information , if in the api https://connect1-sandbox.codegotech.com/api/individualbassapi/getCompanyStatus response the director_status:1 and resend:1 it means the Kyc link is already sent to director email, if director_status:1 and resend:2 then it means you can request the compliance to send the kyc link to the director email. In Sandbox email is not sent to the director email , but in live mode kyc link will be sent to the director email
Dashboard
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/dashboard' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel_id","web_token":"web_token from the auth response","user_id":"user_id from the auth response"}'
This api will return the group of information , like beneficiaries, latest transactions, ibans , also you can get these all details related to specific iban py passing the iban_id
https://connect1-sandbox.codegotech.com/api/individualbassapi/dashboard
Response :
{"status":1,
beneficiaries:[{account_type: "sepa",beneficiaries_id:"beneficiary id",bic:"bic",date: "2024-02-05 12:26:43",email: "beneficiary email,
iban: "iban",image: "image url",name: "name",risklevel: "low"}],
ibans:[{balance: "00.00",bic: "PAYVBE0000",currency: "EUR",iban: "iban",iban_id: "iban id",label: "iban label"}],
protFolio:'00.00',
userplan:{plan_name:'plan name',no_vc: "0", no_plastic_card: "0", no_vpc: "0"},
transactions:[
{amount:"1.00", beneficiary_name:"name",created:"2024-02-05 14:42:00",currency:"eur", description :"send 1.00 EUR to beneficiary Company ",fees:"1.00",
reason_payment: "reason",status:"Pending",transaction_id:"123456",trx_id,:"trx_id",
type:"debit",unique_id:"unique_id"}]
}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
iban_id | String | iban id of the iban. |
Profile Details
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/profile_details' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel id","web_token":"web_token from the auth response","user_id":"user_id from the auth response"}'
This api is used to get the company profile details
https://connect1-sandbox.codegotech.com/api/individualbassapi/profile_details
Response :
{
"user":{"company_name":"Company Name","email":"email","phone_number":"company phone number","country_of_residence":"id of the country"},
"company":{"id":"00","unique_id":"unique id","company_name":"Company name","date_of_incorporation":"2023-11-23","registration_number":"company registration number","vat_number":"vat number","industry":"company indusrty","website":"company web site","no_employees":"number of employees in company","spending_amount":"0.00","about_company":"purpose of account ","registration_country":"id of country","registration_address1":"company registration address","registration_address2":"","registration_city":"company registration city","registration_region":"company registration region","registration_zip":"company regitration zip code","same_address":"0","actual_country":"country id","actual_address1":"actual address","actual_address2":"","actual_city":"actual city","actual_region":"actual region","actual_zip":"actual zip","created":"0000-00-00 00:00:00","updated":"2023-11-30 14:41:01","profile_status":"1","reject_reason":"","company_type":"0","risk_level":"3","company_country":"0"},
"director":{"id":"0","whitelabel_id":"whitelabel key","company_id":"00","unique_id":"unique id","role":"director role","first_name":"first name of the director","last_name":"last name of the director","dob":"date of birth","country":"id of the country","mobile":"phone number of the director","status":"0","created":"2023-11-29 15:34:51","director_reject_reason":"","address_country":"id of country","address":"address","city":"city","zipcode":"zipcode","kyc_id":"kyc id","gender":"male"}
}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
IBAN List
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel_id,"web_token":"web_token from auth response","user_id":"user_id from auth response"}'
This api is used to create the new iban
https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_list
Response :
{status:1,"ibans":[{
"iban_id": "iban id",
"label": "iban label",
"currency": "EUR",
"balance": "00.00",
"iban": "BE*************",
"bic": "PAY*******"
},]}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api. |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api. |
Add Beneficiary
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/addbeneficary' \
--header 'Authorization: Basic your client key' \
--form 'whitelabel_id="your whitelabel id"' \
--form 'web_token="web_token from the auth response"' \
--form 'user_id="user_id from the auth response"' \
--form 'type="personal"' \
--form 'account="iban account of beneficiary' \
--form 'first_name="first name of beneficiary"' \
--form 'last_name="last name of beneficiary"' \
--form 'company_name="company name"' \
--form 'email="email of the beneficiary"' \
--form 'beneficiary_image=@"image of beneficiary"'
This api is used to add the beneficiary
https://connect1-sandbox.codegotech.com/api/individualbassapi/addbeneficary
Response :
{"status":1,"message":"success."}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
type | String | type of the beneficiary .e.g. personal , business . |
account | String | Iban account of beneficiary. |
first_name | String | First name of beneficiary. |
last_name | String | Last name of beneficiary. |
company_name | String | Company name of beneficiary. |
String | Email of beneficiary. | |
beneficiary_image | File | Image of beneficiary. |
Beneficiaries List
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/beneficiaries_list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel id","web_token":"web_token from the auth response","user_id":"user_id from the auth response"}'
This api is used to get beneficiaries list
https://connect1-sandbox.codegotech.com/api/individualbassapi/beneficiaries_list
Response :
{"status":1,"beneficiary":[{"beneficiaries_id":"beneficiary id","name":"beneficiary name","email":"beneficiary email","iban":"beneficiary iban","bic":"bic","image":"beneficiary image url","account_type":"beneficiary account type","date":"2023-12-05 14:47:03","risklevel":"low"}]}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
Delete Beneficiary
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/beneficiaries_delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel id","web_token":"web_token from the auth response","user_id":"user_id from the auth response","beneficiaries_id":""}'
This api is used delete the beneficiary from beneficiary list
https://connect1-sandbox.codegotech.com/api/individualbassapi/beneficiaries_delete
Response :
{"status":1,message:"beneficiary deleted successfully"}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
beneficiaries_id | String | beneficiary id from the beneficiaries list |
Send Money to Beneficiary
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_sendmoney' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel id","web_token":"web_token from the auth response","user_id":"user_id from the auth response","amount":10,"payment_option":"sepa","reason_payment":"salary november month","iban_id":"iban id from which the payment will be sent","beneficiaries_id":"beneficiary id from the list"}'
This api is used to send the money to the beneficiary, an OTP will be sent to your email that will be verified in the iban_confirmotp
https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_sendmoney
Response :
{"status":1,message:"Please check your email. We have sent One-Time Password (OTP) for this transaction.",unique_id: "unique id"}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
iban_id | String | iban id from the iban list. |
payment_option | String | Payment option e.g. Sepa or Sepa Instant. |
reason_payment | String | Payment reference e.g. Salary. |
beneficiaries_id | String | beneficiary id from the beneficiaries list |
Confirm OTP to send Money
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_confirmotp' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel id","web_token":"web_token from the auth response","user_id":"user_id from the auth response","unique_id":"unique_id from the send money api response","otp":"otp send to your email"}'
This api is used to verify that you want to send money to beneficiary
https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_confirmotp
Response :
{"status":1,"message":"On live we have sent you an email with biometric verification link. Please check your inbox and complete the verification to process this outbound transaction."}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
unique_id | String | unique_id from the responnse of the send money to beneficiary api. |
otp | String | OTP sent to your email. |
IBAN Transaction History
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_transaction' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel id","web_token":"web_token from the auth response","user_id":"user_id from the auth response","order":"desc","page":1,"per_page":10,"status":"","startdate":"2023-12-05","enddate":"2023-12-05","search":"Ranjit",'\''iban_id'\'':""}'
This api is used to get the IBAN transaction history. You can optionally search the POS transactions by passing the startdate, enddate, iban_id to get the specific Iban Transactions
https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_transaction
Response :
{"page_number":3,"per_page":10,"num_rows":21,"total_page":2,
"trx":[
{"is_upload_document":"2","trx_id":"trx id","transaction_id":"0000","beneficiary_name":"ben name",
"reason_payment":"payment ","username":"user name","type":"debit","sign":"db","amount":"10.00","fees":"1.00",
"description":"send 10.00 EUR to beneficiary ","status":"Pending","transaction_date":"2023-12-06 13:16:54","label":"label"}]}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api. |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
iab_id | String | iban_id from iban_list api. |
startdate | String | start date for searching the pos payment |
enddate | String | end date for searching the pos payment |
page | String | page number for getting the pos payment history |
NOTE
If in the transactions list , in any transaction is_upload_document:1 then you have to upload the transaction document.
IBAN Transaction Details
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_transaction_detail' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel id","web_token":"web_token from the auth response","user_id":"user_id from the auth response","unique_id":"unique id"}'
This api is used to get the IBAN transaction Details of Specific transaction.
https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_transaction_detail
Response :
{"status":1,"trx":{"unique_id":"unique id,"transaction_id":"000000","beneficiary_name":"beneficiary name","reason_payment":"payment ","username":"user name","type":"debit","sign":"db","amount":"10.00","fees":"1.00","description":"send 10.00 EUR to beneficiary","status":"Pending","transaction_date":"2023-12-06 13:16:54","label":"label","biometric_approval":"No"}}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
unique_id | String | unique_id of the transaction. |
Upload Transaction Document
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_uploadtrxdoc' \
--header 'Authorization: Basic your client key' \
--form 'whitelabel_id="your whitelabel id"' \
--form 'web_token="web_token from the auth response"' \
--form 'user_id="user_id from the auth response"' \
--form 'trx_document=@"/path/to/file"' \
--form 'trx_id=""'
This api is used to upload the transaction document.
https://connect1-sandbox.codegotech.com/api/individualbassapi/iban_uploadtrxdoc
Response :
{"status":1,"message":"Message successfully sent"}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
trx_id | String | trx_id of the transaction. |
trx_document | File | trx document for the transaction. |
Download Transaction Invoice
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/downloadinvoice' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel id","web_token":"web_token from the auth response","user_id":"user_id from the auth response","trx_id":"trx id"}'
This api is used to download the transaction invoice.
https://connect1-sandbox.codegotech.com/api/individualbassapi/downloadinvoice
Response :
{"status":1,"message":"Message successfully sent"}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
trx_id | String | trx_id of the transaction. |
Download Bank Statement
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/bankstatement' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic Q29kZWdvUGF5Xzg5Om1rZVRWVWNTWTJCWFJZZWZpV1RQdURMaGF6YTFOWWhwUHVvZm1wbjU3VXd6QUJMZGNo' \
--data '{"whitelabel_id":"your whitelabel id",
"web_token":"web_token from the auth response","user_id":"user_id from the auth response",
"iban_id":"iban id","from_date":"2024-01-27","to_date":"2024-11-26"}'
This api is used to download the bank statement. you can optionally download the bank statement of a specfic iban by passing the iban_id, or you can filter with start date and end date.
https://connect1-sandbox.codegotech.com/api/individualbassapi/bankstatement
Response :
{"status":1,"message":"Bank statement has been sent to your registered email."}
{"status":0,"message":"unable to download the bank statement."}
Request Body
Field | Type | Description |
---|---|---|
web_token | String | web_Token generated from authentication api(Header Request). |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
iban_id | String | iban_id from the iban_list. |
startdate | File | start date to filter the transactions. |
enddate | File | end date to filter the transactions. |
Get Selected Plan
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/getSelectPlan' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel id","web_token":"web_token from the auth response","user_id":"user_id from the auth response"}'
This api is used to get the user selected plan
https://connect1-sandbox.codegotech.com/api/individualbassapi/getSelectPlan
Response :
{"status":1,"cardList":[{"card_id":"card id","card_number":"card number","expiry_date":"expiry date","card_status":"Active
Card","card_lock":"Unlock","card_image":"card image url","last_30_days":"00.00","available":"00.00","limit_spent":"00.00","todayspent":"00.00"},{"card_id":"card id","card_number":"last four digits of card number","expiry_date":"expiry date",
"card_status":"Active Card","card_lock":"Unlock","card_image":"card image url","last_30_days":"00.00","available":"00.00","limit_spent":"00.00","todayspent":"00.00"}]}
REQUEST BODY
Field | Type | Description |
---|---|---|
web_token | String | Web Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel id |
user_id | String | user_id generated from authentication api(Header Request). |
Notifications
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/notification' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel_id","web_token":"web_token from auth response","user_id":"user_id from auth response"}'
You can authenticate through this api by entering the valid credentials . :
https://connect1-sandbox.codegotech.com/api/individualbassapi/notification
Response :
{"status":1,"notifications": [
{
"id": "00",
"title": "Security Alert",
"description": "Someone sign-in to you account from ().",
"date": "00-00-0000"
},]}
REQUEST BODY
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
web_token | String | web_token from auth response |
user_id | String | user_id from auth response. |
update live user
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/updateUserLive' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel_id","web_token":"web_token from auth response","user_id":"user_id from auth response"}'
This api is used to verify that the user is live on the app, if not updated after every minute its token will be expired.
https://connect1-sandbox.codegotech.com/api/individualbassapi/updateUserLive
Response :
{"status":1,"message":"updated"}
Request Body
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
web_token | String | web_token from auth response |
user_id | String | user_id from auth response. |
Forget Password
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/forgotpassword' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data-raw '{"whitelabel_id":"your whitelabel id","email":""}'
This api is used to Reset the password , it includes the OTP verification that will be sent to your registered email
https://connect1-sandbox.codegotech.com/api/individualbassapi/forgotpassword
Response :
{"status":1,"name":"Company","unique_id":"unique_id,"user_id":"user_id"}
Request Body
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
String | your registered email |
Reset Password
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/resetpassword' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data-raw '{"whitelabel_id":"your whitelabel_id","password":"your new password","code":"OTP sent to your registered email","unique_id":"unique_id from forgetpassword api","user_id":"user_id from forgetpassword api"}'
This api is used to Contact us (CodeGoPay) for any queries
https://connect1-sandbox.codegotech.com/api/individualbassapi/resetpassword
Response :
{"status":1}
Request Body
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
password | String | your new password |
code | String | OTP sent to your registered email. |
unique_id | String | unique_id from the forgetpassword api response |
user_id | String | user_id from the forgetpassword api response |
Logout
# Here is a curl example
curl --location 'https://connect1-sandbox.codegotech.com/api/individualbassapi/logout' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic your client key' \
--data '{"whitelabel_id":"your whitelabel_id","web_token":"web_token from auth response","user_id":"user_id from auth response"}'
This api is used to Contact us (CodeGoPay) for any queries
https://connect1-sandbox.codegotech.com/api/individualbassapi/logout
Response :
{"status":1}
Request Body
Field | Type | Description |
---|---|---|
whitelabel_id | String | Your whitelabel id |
web_token | String | web_token from auth response |
user_id | String | user_id from auth response. |
Errors
Error Message
Error Code | Description |
---|---|
400 | Bad resuqest |
401 | Not Authorized |
404 | Not Found |
404 | Not Found |
500 | System Error |
201 | wrong credential |
202 | Access disabled by admin |
203 | Module is not active. Please contact the administrator |
0 | General Error |
1 | Succes |