Get asset contribution by ID

GET 
https://api.sandbox.magfi.net/api/asset-contribution/:id

Retrieve a specific asset contribution by its ID

Request

Path Parameters

id uuidrequired

Asset contribution ID

Responses

200

Asset contribution retrieved successfully

application/json

Schema

Schema

iduuid
accountIduuid
ID of the account making the contribution
assetIduuid
ID of the asset being contributed
assetTransferMethodIduuid
ID of the transfer method used for the contribution
acquisitionOndate-time
Date and time when the asset was acquired
costBasisstring
Cost basis units of the contribution. Example: 1000 = 10.00
Example: 100000
currencyTypestring
Type of currency used for the cost basis. USD is in cents, BTC is in sats
Possible values: <= 50 characters
Example: USD
unitCountstring
Number of units contributed
Example: 15
unitCountExpectedstring
Expected number of units to be contributed
Example: 1
createdAtdate-time
updatedAtdate-time

Example (auto)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetTransferMethodId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "acquisitionOn": "2024-07-29T15:51:28.071Z",
  "costBasis": "100000",
  "currencyType": "USD",
  "unitCount": "15",
  "unitCountExpected": "1",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}

400

Bad Request - Invalid input data

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Invalid input data",
  "description": "The request data did not pass validation",
  "code": "INVALID_INPUT"
}

401

Unauthorized - Invalid or missing authentication token

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Unauthorized",
  "description": "Invalid, expired or missing bearer token",
  "code": "UNAUTHORIZED"
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Forbidden",
  "description": "You don't have permission to access this resource",
  "code": "FORBIDDEN"
}

404

Not Found - Resource not found

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Resource not found",
  "description": "The requested resource could not be found",
  "code": "NOT_FOUND"
}

409

Conflict - Resource already exists or state conflict

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Resource conflict",
  "description": "The resource already exists or is in an invalid state",
  "code": "CONFLICT"
}

422

Unprocessable Entity - Validation error

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Validation error",
  "description": "The request data failed validation rules",
  "code": "VALIDATION_ERROR"
}

• javascript
• python
• curl
• rust
• go
• java
• ruby

• FETCH
• JQUERY
• XHR

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://api.sandbox.magfi.net/api/asset-contribution/:id", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Request Collapse all

Base URL

https://api.sandbox.magfi.net/api

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!