NoRamp Docs
Search
⌃K

Apps

ENDPOINTS
GET /apps
POST /apps/:app_id
GET /apps/:app_id/kycs/:kyc_id
PATCH /apps/:app_id/
DELETE /apps/:app_id/
​

Create App

POST /apps/:app_id
cURL
Node
Python
1 curl -X POST https://api.noramp.io/apps \
2 -u API_KEY: \
3 -H 'Content-Type: application/json' \
4 -d '{"name":"App Name","type":"individual","app_fee":100,"use_explorer":true}'
--------------------------------------------------------------------------------------------------------------
JSON Response:
​
{
"data": {
"id": "app_6Up9GoHjp9tiObHtWW9b8s",
"name": "App Name",
"type": "individual",
"status": "active",
"use_explorer": true,
"created_at": "2022-08-03T17:13:36.275Z",
"updated_at": "2022-08-27T20:06:22.000Z",
"kyc_return_url": "https://myapp.com/settings/kyc",
"app_fee": 0
}
}
1 const data = {
2 "name": "App Name",
3 "type": "individual",
4 "app_fee": 100,
5 "use_explorer": true
6 };
7
8 const response = await fetch('https://api.noramp.io/apps', {
9 method: "POST",
10 headers: {
11 'content-type': 'application/json',
12 'authorization': 'Bearer {API_KEY}',
13 },
14 body: JSON.stringify(data)
15 })
16
17 console.log('response', await response.json());
--------------------------------------------------------------------------------------------------------------
JSON Response:
​
{
"data": {
"id": "app_6Up9GoHjp9tiObHtWW9b8s",
"name": "App Name",
"type": "individual",
"status": "active",
"use_explorer": true,
"created_at": "2022-08-03T17:13:36.275Z",
"updated_at": "2022-08-27T20:06:22.000Z",
"kyc_return_url": "https://myapp.com/settings/kyc",
"app_fee": 0
}
}
1 import requests
2 import json
3
4 url = "https://api.noramp.io/apps"
5
6 headers = {
7 'Content-Type': 'application/json',
8 'Authorization': 'Bearer {API_KEY}',
9 }
10
11 payload = json.dumps({
12 "name": "App Name",
13 "type": "individual",
14 "app_fee": 100,
15 "use_explorer": true
16 })
17
18 response = requests.request("POST", url, headers=headers, data=payload)
19
20 print(response.text)
--------------------------------------------------------------------------------------------
JSON Response:
​
{
"data": {
"id": "app_6Up9GoHjp9tiObHtWW9b8s",
"name": "App Name",
"type": "individual",
"status": "active",
"use_explorer": true,
"created_at": "2022-08-03T17:13:36.275Z",
"updated_at": "2022-08-27T20:06:22.000Z",
"kyc_return_url": "https://myapp.com/settings/kyc",
"app_fee": 0
}
}

Get App

GET /apps/:app_id/kycs/:kyc_id
cURL
Node
Python
1 curl -X GET https://api.noramp.io/apps/{app_id} \
2 -u API_KEY: \
3 -H 'Content-Type: application/json'
------------------------------------------------------------------------------------------------------------------------------
JSON Response:
​
{
"data": {
"id": "app_6Up9GoHjp9tiObHtWW9b8s",
"name": "App Name",
"type": "individual",
"status": "active",
"use_explorer": true,
"created_at": "2022-08-03T17:13:36.275Z",
"updated_at": "2022-08-27T20:06:22.000Z",
"kyc_return_url": "https://myapp.com/settings/kyc",
"app_fee": 0
}
}
1 const response = await fetch('https://api.noramp.io/apps/{app_id}', {
2 method: "GET",
3 headers: {
4 'content-type': 'application/json',
5 'authorization': 'Bearer {API_KEY}',
6 },
7 })
8
9 console.log('response', await response.json());
--------------------------------------------------------------------------------------------------------------
JSON Response:
​
{
"data": {
"id": "app_6Up9GoHjp9tiObHtWW9b8s",
"name": "App Name",
"type": "individual",
"status": "active",
"use_explorer": true,
"created_at": "2022-08-03T17:13:36.275Z",
"updated_at": "2022-08-27T20:06:22.000Z",
"kyc_return_url": "https://myapp.com/settings/kyc",
"app_fee": 0
}
}
1 import requests
2 import json
3
4 url = "https://api.noramp.io/apps/{app_id}"
5
6 headers = {
7 'Content-Type': 'application/json',
8 'Authorization': 'Bearer {API_KEY}',
9 }
10
11
12 response = requests.request("GET", url, headers=headers, data=payload)
13
14 print(response.text)
------------------------------------------------------------------------------------------------------------
JSON Response:
​
{
"data": {
"id": "app_6Up9GoHjp9tiObHtWW9b8s",
"name": "App Name",
"type": "individual",
"status": "active",
"use_explorer": true,
"created_at": "2022-08-03T17:13:36.275Z",
"updated_at": "2022-08-27T20:06:22.000Z",
"kyc_return_url": "https://myapp.com/settings/kyc",
"app_fee": 0
}
}

Update App

PATCH /apps/:app_id/
cURL
Node
Python
1 curl -X PATCH https://api.noramp.io/apps \
2 -u API_KEY: \
3 -H 'Content-Type: application/json' \
4 -d '{"name":"App Name","app_fee":100,"use_explorer":true}'
-------------------------------------------------------------------------------------------
JSON Response:
​
{
"data": {
"id": "app_6Up9GoHjp9tiObHtWW9b8s",
"name": "App Name",
"type": "individual",
"status": "active",
"use_explorer": true,
"created_at": "2022-08-03T17:13:36.275Z",
"updated_at": "2022-08-27T20:06:22.000Z",
"kyc_return_url": "https://myapp.com/settings/kyc",
"app_fee": 0
}
}
1 const data = {
2 "name": "App Name",
3 "app_fee": 100,
4 "use_explorer": true
5 };
6
7 const response = await fetch('https://api.noramp.io/apps', {
8 method: "PATCH",
9 headers: {
10 'content-type': 'application/json',
11 'authorization': 'Bearer {API_KEY}',
12 },
13 body: JSON.stringify(data)
14 })
15
16 console.log('response', await response.json());
--------------------------------------------------------------------------------------------------------------
JSON Response:
​
{
"data": {
"id": "app_6Up9GoHjp9tiObHtWW9b8s",
"name": "App Name",
"type": "individual",
"status": "active",
"use_explorer": true,
"created_at": "2022-08-03T17:13:36.275Z",
"updated_at": "2022-08-27T20:06:22.000Z",
"kyc_return_url": "https://myapp.com/settings/kyc",
"app_fee": 0
}
}
1 import requests
2 import json
3
4 url = "https://api.noramp.io/apps"
5
6 headers = {
7 'Content-Type': 'application/json',
8 'Authorization': 'Bearer {API_KEY}',
9 }
10
11 payload = json.dumps({
12 "name": "App Name",
13 "app_fee": 100,
14 "use_explorer": true
15 })
16
17 response = requests.request("PATCH", url, headers=headers, data=payload)
18
19 print(response.text)
-------------------------------------------------------------------------------------------------------------------
JSON Response:
​
{
"data": {
"id": "app_6Up9GoHjp9tiObHtWW9b8s",
"name": "App Name",
"type": "individual",
"status": "active",
"use_explorer": true,
"created_at": "2022-08-03T17:13:36.275Z",
"updated_at": "2022-08-27T20:06:22.000Z",
"kyc_return_url": "https://myapp.com/settings/kyc",
"app_fee": 0
}
}

Delete App

DELETE /apps/:app_id/
cURL
Node
Python
1 curl -X DELETE https://api.noramp.io/apps/{app_id} \
2 -u API_KEY: \
3 -H 'Content-Type: application/json'
1 const response = await fetch('https://api.noramp.io/apps/{app_id}', {
2 method: "DELETE",
3 headers: {
4 'content-type': 'application/json',
5 'authorization': 'Bearer {API_KEY}',
6 },
7 })
8
9 console.log('response', await response.json());
1 import requests
2 import json
3
4 url = "https://api.noramp.io/apps/{app_id}"
5
6 headers = {
7 'Content-Type': 'application/json',
8 'Authorization': 'Bearer {API_KEY}',
9 }
10
11
12 response = requests.request("DELETE", url, headers=headers, data=payload)
13
14 print(response.text)
API Reference - Previous
Payments
Next - API Reference
Wallets
Last modified 16d ago