Get started
API Endpoint https://connect1-sandbox.codegotech.com/api
The Codego sandbox API provides programmatic access to cire banking solutions data like provide an authorization, KYC, Accounts,Prepaid cards,Debitcards etc.
To use this API, you need an Client Key,Secret key,Api Key and Whitelabel Key. Please contact us at banking@codegotech.com to get your own API keys.
API Limit : 200 requests per 10 second.
Authentication
# Here is a curl example
curl \
-X POST https://connect1-sandbox.codegotech.com/api/authenticaion \
-H 'clientkey=your_client_key' \
-H 'secretkey=your_secret_key' \
-u 'apikey=your_api_key'\
-u 'whitelabel_id=your_whitelabel_key'
The sandbox API uses Basic Auth to authenticate requests. :
https://connect1-sandbox.codegotech.com/api/authenticaion
Response :
{
status:1,
auth_token:7ac9ffc2-73586415-e2ba6a50-5a1a546a-e5e90de8-cb2dc8df,
expiry:token will be expired in 30 mintue
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
clientkey | String | Your Client key(Header Request). |
secretkey | String | Your Secret key(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
Refresh Token
# Here is a curl example
curl \
-X POST https://connect1-sandbox.codegotech.com/api/refreshtoken \
-H 'authtoken=auth_token' \
-u 'apikey=your_api_key'\
-u 'whitelabel_id=your_whitelabel_key'
The sandbox API to refresh the auth token generated from the authentication API as the token validity is only for 30 mintues:
https://connect1-sandbox.codegotech.com/api/refreshtoken
Response :
{
status:1,
auth_token:b1bfe788-73586415-e2ba6a50-5a1a546a-e5e90de8-cb2dc8df,
expiry:token will be expired in 30 mintue
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
Countries List
# Here is a curl example
curl \
-X POST https://connect1-sandbox.codegotech.com/api/countries_list
-H 'authtoken=auth_token' \
-u 'apikey=your_api_key'\
-u 'whitelabel_id=your_whitelabel_key'
This will return list of all the available countries.This will be used in further API's:
https://connect1-sandbox.codegotech.com/api/countries_list
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"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
Nationality List
# Here is a curl example
curl \
-X POST https://connect1-sandbox.codegotech.com/api/nationality
-H 'authtoken=auth_token' \
-u 'apikey=your_api_key'\
-u 'whitelabel_id=your_whitelabel_key'
This will return list of all the available nationality.This will be used in further API's:
https://connect1-sandbox.codegotech.com/api/nationality
Response :
{
status:1,
countries:
[
{
"id":"106",
"country_code":"AL",
"country_name":"Albania",
"phonecode":"355",
"status":"0",
"is_iban":"0"
},
{
"id":"106",
"country_code":"IT",
"country_name":"Italy",
"phonecode":"39",
"status":"1",
"is_iban":"1"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
Income Source List
# Here is a curl example
curl \
-X POST https://connect1-sandbox.codegotech.com/api/income_source
-H 'authtoken=auth_token' \
-u 'apikey=your_api_key'\
-u 'whitelabel_id=your_whitelabel_key'
This will return list of all the types of income sources.This will be used in further API's:
https://connect1-sandbox.codegotech.com/api/income_source
Response :
{
status:1,
income_source:
[
"Salary",
"Investment",
"Agriculture"
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
KYC Docments List
# Here is a curl example
curl \
-X POST https://connect1-sandbox.codegotech.com/api/documents_list
-H 'authtoken=auth_token' \
-u 'apikey=your_api_key'\
-u 'whitelabel_id=your_whitelabel_key'
This will return list of all documents that are required for KYC verification.This will be used in further API's:
https://connect1-sandbox.codegotech.com/api/documents_list
Response :
{
status:1,
documents:
[
{
"id":"1",
"name":"Id Proof"
},
{
"id":"2",
"name":"Address Proof"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
Customer Signup
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/signup' \
--header 'authtoken: 8bd946d0-755d91f4-1f99062e-75212023-8e7ed266-24153dcb-fc9ffbb3-e3aad315-210642e8-59888812-5813edb5-ce7f3e62-f296a755-338afbf8-e1679a5f-d779736b' \
--header 'Content-Type: application/javascript' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","country_of_residence":99,"name":"John","surname":"De","mobile":"9999640806","email":"users@gmail.com","password":"Aa100508!!!","country_id":99,"dob":"1989-01-02","nationality":25,"address":"#B004/566, Dashmesh Nagar,Kharar, Punjab","city":"Mohali","country":99,"zipcode":140301,"is_same":1,"receive_card_address":"#B004/566, Dashmesh Nagar,Kharar, Punjab","receive_card_capital":"","receive_card_city":"Mohali","receive_card_country":99,"receive_card_zipcode":140301,"work_country":99,"income_soruce":"Salary","political_person":"No","country_pay_tax":99,"tax_personal_number":"134567889","gender":"Male","device_type":"android","device_token":"c6XjksirRN-KsL_WgsUa4S:APA91bF6SpLV3kZERy3cbhQoblhQna9FwwpruoUgWOVhGsC3nX3-rvKQtkvQqVEKcMsJKCtL5qdcrydxpcu7Wc9cV7Zjhqt9MRDlHyUwWH541SbPJe0nCxr2jyEffUgfd6dxHcDpz8oo", "ipaddress": "101.0.49.223","device_model":"iphone 6 plus"}'
This api will create user account by passing all the parameters mentioned below:
https://connect1-sandbox.codegotech.com/api/signup
Response :
{
status:1,
user_id:"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=",
"message":"Registration is completed successfully."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
country_of_residence | Integer | country id (received from country list api) |
name | String | Customer Name |
surname | String | Customer Surname |
mobile | Integer | Customer Contact Number |
String | Customer Email address | |
country_id | Integer | country id (received from country list api) |
dob | string | Customer Date of Birth |
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 |
work_country | Integer | country id (received from country list api) |
income_soruce | string | income source (received from income source list api) |
political_person | string | Yes/No |
country_pay_tax | Integer | country id (received from country list api) |
tax_personal_number | string | Tax Number |
gender | string | Male/Female |
ipaddress | string | IP address |
KYC-Upload ID Proof Image
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/upload_id_proof' \
--header 'authtoken: 8bd946d0-755d91f4-1f99062e-75212023-8e7ed266-24153dcb-fc9ffbb3-e3aad315-210642e8-59888812-5813edb5-ce7f3e62-f296a755-338afbf8-e1679a5f-d779736b' \
--form 'apikey="hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw"' \
--form 'whitelabel_id="aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425"' \
--form 'user_id="O39I2XXEsBtAgb0Cwd0CHUZiI290wmoqkXTcKETz\\/V7uLds3J3OFKgtDzSg="' \
--form 'document_id="1"' \
--form 'document_number="1234568910"' \
--form 'front_proof=@"MLENwW6E9/1669714244scaled_329dd412-1c4c-445a-a5f6-071d042d4c6b1174288402164778279.jpg"' \
--form 'back_proof=@"7fE8bXXkb/1669714244scaled_329dd412-1c4c-445a-a5f6-071d042d4c6b1174288402164778279.jpg"'
This api will be used to upload customer id proof images(front/back) by passing all the parameters mentioned below:
Note : Upload only images png/jpg less than 2 mb
https://connect1-sandbox.codegotech.com/api/upload_id_proof
Response :
{
"status":"1",
"message":"Your document uploaded successfully."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user id return from signup api |
document_id | Integer | document id (received from kyc_document_list api) |
document_number | String | Document Number |
front_proof | Image | Image of id proof from front side |
back_proof | Image | Image of id proof from back side |
KYC-Upload Address Proof Image
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/address_proof' \
--header 'authtoken: 8bd946d0-755d91f4-1f99062e-75212023-8e7ed266-24153dcb-fc9ffbb3-e3aad315-210642e8-59888812-5813edb5-ce7f3e62-f296a755-338afbf8-e1679a5f-d779736b' \
--form 'apikey="hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw"' \
--form 'whitelabel_id="aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425"' \
--form 'user_id="O39I2XXEsBtAgb0Cwd0CHUZiI290wmoqkXTcKETz\\/V7uLds3J3OFKgtDzSg="' \
--form 'document_id="2"' \
--form 'address_proof=@"7fE8bXXkb/1669714244scaled_329dd412-1c4c-445a-a5f6-071d042d4c6b1174288402164778279.jpg"'
This api will be used to upload customer address proof image by passing all the parameters mentioned below:
https://connect1-sandbox.codegotech.com/api/address_proof
Response :
{
status:1,
message:"Address Proof Document Uploaded Successfully."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user id return from signup api |
document_id | Integer | document id (received from kyc_document_list api) |
address_proof | Image | Image of address proof |
Card - Check Remaining Cards
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/check_remaining_card' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f' \
--header 'Content-Type: application/javascript' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/
This api will return the number of cards remaining to order:
https://connect1-sandbox.codegotech.com/api/check_remaining_card
Response :
{
status:1,
remaining_card:"1"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
type | String | prepaid or debitcard |
Card - Shipping cost for cards
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/get_shipping_cost' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","type":"prepaid"}'
This api will return shipping cost for an card(prepaid or debitcard) to order:
https://connect1-sandbox.codegotech.com/api/get_shipping_cost
Response :
{
"status":"1",
"shipping_cost":"1"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
type | String | prepaid or debitcard |
Card - Check KYC Status
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/check_kyc_status' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4="}'
This api will return status of each documents uploaded:
https://connect1-sandbox.codegotech.com/api/check_kyc_status
Note: All the statuses will be notified via Webhooks
Response :
{
status:1,
kyc_status:[
{
"document_name":"Id Proof",
"status":"Pending"
},
{
"document_name":"Address Proof",
"status":"Pending"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
Response
There are only 3 statuses that will be return for each of the KYC document
Pending : This shows the wait process until compilance team verify or reject KYC document.
Verified : In this case document is verifed that enables user to use other services.
Rejected : This will require user to upload the KYC document again.
DebitCard - Order Card
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/debitcard_card_order' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","type":"order","card_type":"plastic","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4="}'
This api let you to order a debitcard by passing following parameters:
https://connect1-sandbox.codegotech.com/api/debitcard_card_order
Note :
1.Debit Card will be order only if the KYC is approved(that you need to check on your end)
2.Check shipping cost before order a Debit card - shipping is only applicable if card is ship by compilance team
Response :
{
status:1,
message:"Your order request has submitted successfully."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
type | String | order |
card_type | String | plastic or metal |
DebitCard - Activate Card
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/debitcard_activate' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0=","card_number":"4341333167816100","cvv":"152","mm":"05","yy":"2026"}'
This api let you to active a debitcard by passing credit card details and other parameters:
https://connect1-sandbox.codegotech.com/api/debitcard_activate
Note :Debit Card will be order only if the KYC is approved(that you need to check on your end)
Response :
{
status:1,
card_pin:"1234",
message:"Your debit card has been successfully activated. "
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_number | String | debit card number received |
cvv | String | card cvv number |
mm | String | card expiry month |
yy | String | card expiry year (last 2 digits) |
DebitCard - Card Details
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/debitcard_details' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0="}
'
This api let you to detailed information the debit card:
https://connect1-sandbox.codegotech.com/api/debitcard_details
Response :
{
status:1,
card_details:
[
{
card_id:"dBZDpscbvQmsHr9rigmlf378ff9Sz",
card_number:"xxxx xxxx xxxx 0000",
expiry_date:"--",
card_status:"Active",
DailyLoadLimit:"0.00",
DailyLoadFrequencyLimit:"0.00",
card_lock:"Lock",
balance:"0.00",
card_image:"https://res.cloudinary.com/hashfort/image/upload/v1666604602/profile/vouvasryxx3t61udzm69.png"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
Response
These statuses that will be return in card details
Already Order:Card order request is already done.
Order Accepted:Card order request is accepted by compliance team.
Shipped:Card is marked shipped if compliance team is handling the card delivery.
Active Card : Card is ready for load and make payments.
Lost Card : In this case if card has been lost somewhere.
Stolen Card : In this case if card has been stolen.
Expired Card :Card has been expired from the validated date.
DebitCard - Update Settings
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/debitcard_settings' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0=","card_id":"oNzaKMw4oIiup0jjUYZZXtFr47Y=","setting_name":"card_lock","setting_value":"1"}
'
This api let you to detailed information the debit card:
https://connect1-sandbox.codegotech.com/api/debitcard_settings
Response :
{
status:1,
message:"Successfully updated"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | debitcard id generated at card details api |
setting_name | String | card_lock |
setting_value | String |
Should always be 0 or 1 Unlocking = 1, Locking = 0 |
DebitCard - Transactions
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/debitcard_trx' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0=","page":0,"type":"refund"}
'
This api returns all the transactions of the debit card:
https://connect1-sandbox.codegotech.com/api/debitcard_trx
Response :
{
status:1,
page_number:"1",
per_page:"10",
num_rows:"10",
data:
[
{
"trx_type":"debit",
"fee":"0.00",
"TxId":"11320175499",
"TransLink":"220610825569018505",
"total_amount":"0.01",
"TxAmount":"0.01",
"De043":"test payment",
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
page | String | for pagination |
type | String | types of transactions (debit,refund,credit) |
Prepaid Card - Order Card
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/prepaid_card_order' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","type":"order","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4="}'
This api let you to order a debitcard by passing following parameters:
https://connect1-sandbox.codegotech.com/api/prepaid_card_order
Note : 1.Prepaid Card will be order only if the KYC is approved(that you need to check on your end)
2.Check shipping cost before order a prepaid card - shipping is only applicable if card is ship by compilance team
Response :
{
status:1,
message:"Your order request has submitted successfully."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
type | String | order |
Prepaid card - Activate Card
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/prepaid_card_activate' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0=","card_number":"4341333167816100","cvv":"152","mm":"05","yy":"2026"}'
This api let you to active a debitcard by passing prepaid card details and other parameters:
https://connect1-sandbox.codegotech.com/api/prepaid_card_activate
Note :Prepaid Card will be order only if the KYC is approved(that you need to check on your end)
Response :
{
status:1,
card_pin:"1234",
message:"Your prepaid card has been successfully activated."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_number | String | debit card number received |
cvv | String | card cvv number |
mm | String | card expiry month |
yy | String | card expiry year (last 2 digits) |
Prepaid card - Card Details
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/prepaid_card_details' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0="}
'
This api let you to detailed information the prepaid card:
https://connect1-sandbox.codegotech.com/api/prepaid_card_details
Response :
{
status:1,
card_details:
[
{
card_id:"dBZDpscbvQmsHr9rigmlf378ff9Sz",
card_number:"xxxx xxxx xxxx 0000",
expiry_date:"--",
card_status:"Active",
DailyLoadLimit:"0.00",
DailyLoadFrequencyLimit:"0.00",
card_lock:"Lock",
balance:"0.00",
card_image:"https://res.cloudinary.com/hashfort/image/upload/v1666604602/profile/vouvasryxx3t61udzm69.png"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
Response
These statuses that will be return in card details
Already Order:Card order request is already done.
Order Accepted:Card order request is accepted by compliance team.
Shipped:Card is marked shipped if compliance team is handling the card delivery.
Active Card : Card is ready for load and make payments.
Lost Card : In this case if card has been lost somewhere.
Stolen Card : In this case if card has been stolen.
Expired Card :Card has been expired from the validated date.
Prepaid card - Update Settings
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/prepaid_card_settings' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0=","card_id":"oNzaKMw4oIiup0jjUYZZXtFr47Y=","setting_name":"card_lock","setting_value":"1"}
'
This api let you to update the settings of prepaid card:
https://connect1-sandbox.codegotech.com/api/prepaid_card_settings
Response :
{
status:1,
message:"Successfully updated"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | debitcard id generated at card details api |
setting_name | String | card_lock |
setting_value | String |
Should always be 0 or 1 Unlocking = 1, Locking = 0 |
Prepaid card - Transactions
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/prepaid_card_transaction' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0=","month":"12","year":"21"}
'
This api returns all the transactions of the prepaid card:
https://connect1-sandbox.codegotech.com/api/prepaid_card_transaction
Response :
{
status:1,
total_page:"10",
previous_page:"1",
next_page:"2",
transaction_history:
[
{
"trx_type":"debit",
"fee":"0.00",
"TxId":"11320175499",
"TransLink":"220610825569018505",
"total_amount":"0.01",
"TxAmount":"0.01",
"De043":"test payment",
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
month | String | for search transactions of specific month |
year | String | for search transactions of specific year |
Prepaid card - Load Card
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/prepaid_load_balance_card' \
--header 'authtoken: 2b41b5b3-74145002-5f846da3-fa74fffb-9fa32024-4076d733-77ac0872-d030ceca-0e0ed9ad-5ea2d00d-9e94945a-5b6d0f22-e165ce30-537fcc11-59e9e69b-6c1f272d' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0=","card_id":"p9zdJtwo49\/4rxuxFMVDAc9\/rrA=","amount":10}
'
This api is used to load balance in prepaid card:
https://connect1-sandbox.codegotech.com/api/prepaid_load_balance_card
Response :
{
"status":"1",
"id":"11211",
"message":"Load card request accepted. Final status updates you via webhook.",
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | prepaid card id |
amount | String | Amount that loaded in prepaid card |
Debitcard card - Reset Pin
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/reset_card_pin' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0=","card_id":"oNzaKMw4oIiup0jjUYZZXtFr47Y="}
'
This api let you to reset the pin of your prepaid or debit card:
https://connect1-sandbox.codegotech.com/api/reset_card_pin
Response :
{
status:1,
card_pin:1234,
message:"Card pin reset successfully"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | debitcard id generated at card details api |
Prepaid card - Reset Pin
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/reset_card_pin' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0=","card_id":"oNzaKMw4oIiup0jjUYZZXtFr47Y="}
'
This api let you to reset the pin of your prepaid or debit card:
https://connect1-sandbox.codegotech.com/api/reset_card_pin
Response :
{
status:1,
card_pin:1234,
message:"Card pin reset successfully"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | debitcard id generated at card details api |
Card Request for Stolen or Replace
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/replace_stolen_card' \
--header 'authtoken: 42bcc071-ab3bbd26-561d16ab-9ec44348-6dc427f7-38429c4a-ce182b7f-6c0c947b-0d398386-835bca3f-009e57db-608c673a-cc0682ae-89ff8ed6-c364b945-7254e046' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"c24f7b7f-b91c3a84-8edeeb5a-a8f6306c-2df29dc6-8ff85c3c-63a35393-b6a08945","user_id":"amcRhjCE8g4WgqFXx4QBCBY4J20zwGpqjS6EZ02rqUf5e9RxIXbBbgoczGY3WIAb\/5oqBZDpscbvQmsHr93igmlf378ff9Sz1QWRfDnpzGdOnVQ1aBHBaPIYST0=","card_id":"oNzaKMw4oIiup0jjUYZZXtFr47Y="}
'
This api let you to raise a request if card is stolen or need to request:
https://connect1-sandbox.codegotech.com/api/replace_stolen_card
Response :
{
status:1,
message:"Your card pin will be sent to your registered email address"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | card id generated at card (debit or prepaid) details api |
Account details
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/account_detail' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4="}'
This api return the data about about account details:
https://connect1-sandbox.codegotech.com/api/account_detail
Response :
{
status:1,
"account":
{
"name":"John",
"surname":"De",
"kyc_status":"Pending",
"account_status":"Unblock"
}
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
Giftcard - Virtual Giftcard Fee
# Here is a curl example
curl --location --request POST curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/virtual_giftcard_fee' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","type":"order","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4="}'
This api return the fees details of gift card that will be used to generate Giftcard:
https://connect1-sandbox.codegotech.com/api/virtual_giftcard_fee
Response :
{
"status":"1",
"issue_virtual_gift_card_fee":"\u20ac10.00",
"loadcard_fee_fixed":"\u20ac1.00",
"loadcard_fee_percentage":"0.65%"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
type | String | order |
Giftcard - Generate Virtual Card
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/generate_virtual_card' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","amount":"10"}'
This api creates an virtual giftcard with a specific amount:
https://connect1-sandbox.codegotech.com/api/generate_virtual_card
Response :
{
"status":"1",
"message":"Giftcard issued successfully. After 1 minute you will get details of card."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
amount | String | Amount of giftcard |
Giftcard - Get Giftcard Detail
You will read the card details and store them to your side. The API will deliver card information for the first time.
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/get_giftcard_detail' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","access_code":"WERD-WEXS-SWAA-ONSW","card_id":"GTBJhMd0S4wSbcJ0Ho6wWzY9cze"}'
This api returns the Giftcard details by passing following parameters:
https://connect1-sandbox.codegotech.com/api/get_giftcard_detail
Response :
{
"status":"1",
"card_number":"XXXX XXXX XXXX 8787",
"balance":"0",
"message":"You will get detail of card after one minute"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
access_code | String | Access code received from generate virtual card api |
card_id | String | card id received from generate virtual card api |
Giftcard - Get Giftcard Transactions (This API will be deprecated on June 12, 2023.)
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/get_giftcard_transaction' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","card_id":"GTBJhMd0S4wSbcJ0Ho6wWzY9cze"}'
This api returns the Giftcard transactions by passing following parameters:
https://connect1-sandbox.codegotech.com/api/get_giftcard_transaction
Response :
{
"status":"1",
"card_number":"XXXX XXXX XXXX 8787",
"BalanceAvail":"0",
"trx":
[
{
"id":"x5c7k5ej02",
"transaction_date":"2022-09-28 19:44:36",
"amount":"0.00","currency":"EUR",
"description":"Card IsLive Updated Activated by Web service, Date - 2022-09-28 19:44:36.993 - mcc: (TxnId: 1199166047) (0EUR)"
},
{
"id":"bqni81dz7p",
"transaction_date":"2022-09-28 19:44:38",
"amount":"50.00",
"currency":"EUR",
"description":"Loaded 50.00 in your: Loaded 50.00 in your mcc: (TxnId: 11946654256) (50EUR)"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | card id received from generate virtual card api |
Giftcard - Block Giftcard
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/block_gift_card' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","card_id":"GTBJhMd0S4wSbcJ0Ho6wWzY9cze"}'
This api enables you to block giftcard by passing following parameters:
https://connect1-sandbox.codegotech.com/api/block_gift_card
Response :
{
"status":"1",
"message":"card blocked."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | card id received from generate virtual card api |
Giftcard - Get All Cards
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/getAllGiftcard' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4="}'
This api you will get giftcard by passing following parameters:
https://connect1-sandbox.codegotech.com/api/getAllGiftcard
Response : {"status":1,"cards":[{"unique_id":"dfvdfvdfv","name":"","loaded_amount":"100.00","fee":"11.65","total_pay":"111.65","description":"Generate virtual gift card costs is €10.00 and Load amount is €100.00. The total fee is €11.65","card_number":"7991783285252296","expiry_date":"05\/2026","balance":"100.00","card_status":"You have read ","created":"2023-06-13 13:16:51"}]}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
Giftcard - Get Cards User Wise
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/getByUserGiftcard' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4="}'
This api you will get giftcard by passing following parameters:
https://connect1-sandbox.codegotech.com/api/getByUserGiftcard
Response : {"status":1,"cards":[{"unique_id":"dfvdfvdfv","name":"","loaded_amount":"100.00","fee":"11.65","total_pay":"111.65","description":"Generate virtual gift card costs is €10.00 and Load amount is €100.00. The total fee is €11.65","card_number":"7991783285252296","expiry_date":"05\/2026","balance":"100.00","card_status":"You have read ","created":"2023-06-13 13:16:51"}]}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
HS Giftcard - High Spend Virtual Giftcard Fee
# Here is a curl example
curl --location --request POST curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/hs_virtual_giftcard_fee' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","type":"order","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4="}'
This api return the fees details of HS gift card that will be used to generate Giftcard:
https://connect1-sandbox.codegotech.com/api/hs_virtual_giftcard_fee
Response :
{
"status":"1",
"issue_virtual_gift_card_fee":"5.00 EUR",
"loadcard_fee_fixed":"1.00 EUR",
"loadcard_fee_percentage":"2.00%"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
type | String | order |
HS Giftcard - Generate High Spend Giftcard
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/hs_generate_virtual_card' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","amount":"10","mobile_number":"39-1234567890"}'
This api creates an virtual HS giftcard with a specific amount:
https://connect1-sandbox.codegotech.com/api/hs_generate_virtual_card
Response :
{
"status":"1",
"access_code":"CJ270GKF6UT4XSMLBWDIAP9YNZR-ZMVB61QPYA3C9KFN-SGXFQP0MA48WRD61J73UCYKZBIV5T-1F0VHL7ESWTZ8NI9YDXOJAUGQ6B4K-51LKBGU0D4MNE28R-IA920S1TV3K4WLUEFZC7YQM6JR85GD-651CX3ZG2TI4YKAM0-QRMETWFAXO9JD2CU37NK8H46S50GB",
"card_id":"123456789",
"message":"Giftcard issued successfully. After 1 minute you will get details of card."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
mobile_number | String | mobile number without space |
HS Giftcard - Get High Spend Giftcard Detail
You will read the card details and store them to your side. The API will deliver card information for the first time.
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/hs_get_giftcard_detail' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","access_code":"WERD-WEXS-SWAA-ONSW","card_id":"GTBJhMd0S4wSbcJ0Ho6wWzY9cze"}'
This api returns the HS Giftcard details by passing following parameters:
https://connect1-sandbox.codegotech.com/api/hs_get_giftcard_detail
Response :
{
"status":"1",
"card_number":"5270584610977485",
"expiry_date":"05\/26",
"cvv":"115",
"balance":"10.00",
"message":"You will get detail of card after one minute"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
access_code | String | Access code received from generate virtual card api |
card_id | String | card id received from generate virtual card api |
HS Giftcard - Block High Spend Giftcard
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/hs_block_gift_card' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","card_id":"GTBJhMd0S4wSbcJ0Ho6wWzY9cze"}'
This api enables you to block HS giftcard by passing following parameters:
https://connect1-sandbox.codegotech.com/api/hs_block_gift_card
Response :
{
"status":"1",
"message":"Card is blocked successfully."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | card id received from generate virtual card api |
HS Giftcard - UnBlock High Spend Giftcard
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/hs_unblock_gift_card' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","card_id":"GTBJhMd0S4wSbcJ0Ho6wWzY9cze"}'
This api enables you to unblock HS giftcard by passing following parameters:
https://connect1-sandbox.codegotech.com/api/hs_unblock_gift_card
Response :
{
"status":"1",
"message":"Card is active successfully."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | card id received from generate virtual card api |
US Giftcard - US Virtual Giftcard Fee
# Here is a curl example
curl --location --request POST curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/us_virtual_giftcard_fee' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","type":"order","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4="}'
This api return the fees details of US gift card that will be used to generate Giftcard:
https://connect1-sandbox.codegotech.com/api/us_virtual_giftcard_fee
Response :
{
"status":"1",
"issue_virtual_gift_card_fee":"5.00 EUR",
"loadcard_fee_fixed":"1.00 EUR",
"loadcard_fee_percentage":"2.00%"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
type | String | order |
US Giftcard - Generate US Giftcard
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/us_generate_virtual_card' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","amount":"10","mobile_number":"39-1234567890"}'
This api creates an virtual US giftcard with a specific amount:
https://connect1-sandbox.codegotech.com/api/us_generate_virtual_card
Response :
{
"status":"1",
"access_code":"CJ270GKF6UT4XSMLBWDIAP9YNZR-ZMVB61QPYA3C9KFN-SGXFQP0MA48WRD61J73UCYKZBIV5T-1F0VHL7ESWTZ8NI9YDXOJAUGQ6B4K-51LKBGU0D4MNE28R-IA920S1TV3K4WLUEFZC7YQM6JR85GD-651CX3ZG2TI4YKAM0-QRMETWFAXO9JD2CU37NK8H46S50GB",
"card_id":"123456789",
"message":"Giftcard issued successfully. After 1 minute you will get details of card."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
mobile_number | String | mobile number without space |
US Giftcard - Get US Giftcard Detail
You will read the card details and store them to your side. The API will deliver card information for the first time.
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/us_get_giftcard_detail' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","access_code":"WERD-WEXS-SWAA-ONSW","card_id":"GTBJhMd0S4wSbcJ0Ho6wWzY9cze"}'
This api returns the US Giftcard details by passing following parameters:
https://connect1-sandbox.codegotech.com/api/us_get_giftcard_detail
Response :
{
"status":"1",
"card_number":"5270584610977485",
"expiry_date":"05\/26",
"cvv":"115",
"balance":"10.00",
"message":"You will get detail of card after one minute"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
access_code | String | Access code received from generate virtual card api |
card_id | String | card id received from generate virtual card api |
US Giftcard - Block US Giftcard
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/us_block_gift_card' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","user_id":"Oj1Xx2DZ8hcS3fIDxYQAHUMhZmdwwD4\/wSbcJ0Ho6wWzY9czeGTBJhMd0S4=","card_id":"GTBJhMd0S4wSbcJ0Ho6wWzY9cze"}'
This api enables you to block US giftcard by passing following parameters:
https://connect1-sandbox.codegotech.com/api/us_block_gift_card
Response :
{
"status":"1",
"message":"Card is blocked successfully."
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api |
card_id | String | card id received from generate virtual card api |
Crypto - Get Coin List
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/crypto_getCoinList' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"3aa7f66c-85c79fbf-f1f0dfe1-d2c0acf1-106d750c-e3a1d711","user_id":""}'
This api you can use if crypto module is enable:
https://connect1-sandbox.codegotech.com/api/crypto_getCoinList
Response : {"status":1,"coin":[{"currency_name":"btc","name":"Bitcoin","image":"https:\/\/res.cloudinary.com\/hashfort\/image\/upload\/v1635337390\/currency\/by0ty0tmmefizmfamxqk.png","eur_price":"23567.33000000","network_type":"fixed","network_fee":"0.00010000","network":"bitcoin"}]}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api (Optional) |
Crypto - Generate Walet Address
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/crypto_generateWaletAddress' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"3aa7f66c-85c79fbf-f1f0dfe1-d2c0acf1-106d750c-e3a1d711","coin":"usdt","network":"trc-20","user_id":""}'
This api you can use if crypto module is enable:
https://connect1-sandbox.codegotech.com/api/crypto_generateWaletAddress
Response : {"status":1,"unique_id":"5sw7qmr8-z18n03aa-wexr585h","wallet_address":"TR4kfg32cb9gieln2g1gd7u7l65zqm5cle","coin":"usdt","network":"trc-20","message":"Wallet
address generated."}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api (Optional) |
coin | String | Only listed coin we accepted. |
network | String | You need to send network in case of token (e.g usdt : erc-20 or trc-20) |
Crypto - Get ALL Wallet Address
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/crypto_getWalletAddress' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw {"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"3aa7f66c-85c79fbf-f1f0dfe1-d2c0acf1-106d750c-e3a1d711","user_id":""}
This api you can use if crypto module is enable. Get aLL your wallet address :
https://connect1-sandbox.codegotech.com/api/crypto_getWalletAddresss
Response : {"status":1,"wallet":[{"unique_id":"5sw7qmr8-z18n03aa-,"coin":"usdt","network":"trc-20","address":"TR4kfg32cb9gieln2g1gd7u7l65zqm5cle","contract":"TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t","datetime":"2023-07-12
12:14:13"},{"unique_id":"1n2wa8wm--mjy94d57","coin":"usdt","network":"trc-20","address":"TRrvd2ega1m52b21ep1ood8iphszyi9x7d","contract":"TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t","datetime":"2023-07-07
07:51:28"}]}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
user_id | String | user_id generated at signup api (Optional) |
Webhook for Crypto Deposit
We will notify you crypto deposit via webhook once you implement these API's will download Webhook pdfs for the implementation.
Webhook for KYC
For webhook responses you need to provide a link where we can send you data. once you implement these API's will provide Webhook pdfs for the implementation.Due to security reasons these pdf's shared on registered email addresss only.
Webhook for Load Card
For webhook responses you need to provide a link where we can send you data. once you implement these API's will provide Webhook pdfs for the implementation.Due to security reasons these pdf's shared on registered email addresss only.
Webhook for Debitcard transactions
For webhook responses you need to provide a link where we can send you data. once you implement these API's will provide Webhook pdfs for the implementation.Due to security reasons these pdf's shared on registered email addresss only.
Webhook - Giftcard
# Here is a endpoint example
curl --location 'https://yourdomain.com' \
--header 'event-request-key: this key we will provide you via email' \
--header 'Content-Type: application/javascript' \
--data '{"status":1,"card_id":"1575826","balance":"250.00","trx":[{"id":"y9gdfcsv4","transaction_date":"2023-04-08 19:34:12","amount":"250.00","currency":"EUR","description":"(250EUR)"},{"id":"wb1sddrgyk","transaction_date":"2023-04-08 19:49:30","amount":"-0.92","currency":"EUR","description":"(6.83DKK)"}]}'
For Giftcard webhook responses you need to provide a endpoint where we will send you data.On this endpoint you will receive latest 5 transactions and updated card balance.
Note : 'event-request-key' will be sent in the webhook request to verify at your end if this request is real(This key will be provided initially by our team)
Click here to download the HS Giftcard webhook document.
Header Request
Field | Type | Description |
---|---|---|
event-request-key | String | This request wil be sent in webhook request(Header Request). |
Request Data
Field | Type | Description |
---|---|---|
card_id | unique card number | On basis of this card_id you can update data at your end |
trx | list of latest transactions | It will return last 5 transactions |
balance | Card Balance | updated balance of giftcard |
Webhook - HS Giftcard
# Here is a endpoint example
curl --location 'https://yourdomain.com' \
--header 'event-request-key: this key we will provide you via email' \
--header 'Content-Type: application/javascript' \
--data '{"status":1,"card_id":"1575826","balance":"250.00","trx":[{"id":"y9gdfcsv4","transaction_date":"2023-04-08 19:34:12","amount":"250.00","currency":"EUR","description":"(250EUR)"},{"id":"wb1sddrgyk","transaction_date":"2023-04-08 19:49:30","amount":"-0.92","currency":"EUR","description":"(6.83DKK)"}]}'
For HS Giftcard webhook responses you need to provide a endpoint where we will send you data.On this endpoint you will receive latest 5 transactions and updated card balance.
Note : 'event-request-key' will be sent in the webhook request to verify at your end if this request is real(This key will be provided initially by our team)
Click here to download the HS Giftcard webhook document.
Header Request
Field | Type | Description |
---|---|---|
event-request-key | String | This request wil be sent in webhook request(Header Request). |
Request Data
Field | Type | Description |
---|---|---|
card_id | unique card number | On basis of this card_id you can update data at your end |
trx | list of latest transactions | It will return last 5 transactions |
balance | Card Balance | updated balance of HS giftcard |
Whitelabel Account - Float Balance
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/admin_float_balance' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425"}'
This api return the float balance of whitelabel account:
https://connect1-sandbox.codegotech.com/api/admin_float_balance
Response :
{
"status":"1",
"float_wallet":"20.00",
"currency":"EUR"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
Whitelabel Account - Float Transactions
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/admin_float_trxs' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425","start_date":"","end_date":""}'
This api return the float transactions of whitelabel account by default all. if not passing start and end date:
https://connect1-sandbox.codegotech.com/api/admin_float_trxs
Response :
{
"status":"1",
"unique_id":"gc-555ssss",
"currency_name":"EUR",
"float_amount":"50.35",
"type":"debit",
"created":"2023-03-13 11:55:51",
"description":"Generate virtual gift card costs is €0.00 and Load amount is €50.00. The total fee is
€0.35",
"domain_name":"ib.xyz.com",
"admin_name":"product@xyz.com",
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
start_date | String | start date should be less than equal to start date (YYYY-mm-dd) |
end_date | String | end date should be greater than equal to start date (YYYY-mm-dd) |
trans_type | String | possible values : all or credit or debit |
Whitelabel Account - Float Transactions This api will be depricated by 1st july 2023
# Here is a curl example
curl --location --request POST 'https://connect1-sandbox.codegotech.com/api/admin_float_trx' \
--header 'authtoken: 4a2d13b2-a9ee26db-c2e10994-cc085246-9889376c-7f42007f-3b7255f9-9dc596f1-51f9616a-50b4a9e6-f978cc29-c651d1c8-2f2927cf-410ba90a-bb13e29b-9f01223f
' \
--header 'Content-Type: application/json' \
--data-raw '{"apikey":"hZWHeHRefjir12fKEXBP7ATWeAOIKw9eQmq8eQOCXSZXoo7DUFVw","whitelabel_id":"aea56e1e-bbb094b8-2dab6640-990c21ec-d6de83f2-d523f8aa-3211da91-27d10425"}'
This api return the float transactions of whitelabel account:
https://connect1-sandbox.codegotech.com/api/admin_float_trx
Response :
{
"status":"1",
"unique_id":"gc-555ssss",
"currency_name":"EUR",
"float_amount":"50.35",
"type":"debit",
"created":"2023-03-13 11:55:51",
"description":"Generate virtual gift card costs is €0.00 and Load amount is €50.00. The total fee is
€0.35",
"domain_name":"ib.xyz.com",
"admin_name":"product@xyz.com",
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
authtoken | String | Auth Token generated from authentication api(Header Request). |
apikey | String | Your API key |
whitelabel_id | String | Your whitelabel key |
month | String | month of transactions(MM) |
year | String | year of transactions (YYYY) |
trans_type | String | possible values : all or credit or debit |
Errors
The Westeros API uses the following error codes:
Error Code | Meaning |
---|---|
200 | Return API Response |
201 | Auth token not existed |
202 | Wrong license key |
203 | clientkey or secretkey is empty |
204 |
Authentication key were missing or incorrect
|
205 |
Authentication key required
|
400 | 400 Bad Request e.g (first_name) cannot be blank or invalid |
401 | Token is invalid |
404 | Could Not found |
502 | Bad Gateway (There was a generic error.) |
503 | Bad Gateway (There was a connection error.) |
0 | Return error in api |
1 | API response success |