Investor

post

Store investor payment

Authorizations
Body
investorAddressstringRequired

The address of the investor. Required.

Example: 0x198ae62CAD1b9ecf58FfFaA36c0c85E6A84748B0Pattern: ^(0x)[0-9a-fA-F]{40}$
tokenAddressstringRequired

The address of the security token. Required.

Example: 0xb720f93879de10B7c080834464C4bA289E7Aa35EPattern: ^(0x)[0-9a-fA-F]{40}$
hashstringOptional

Transaction hash. Optional.

Example: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdefPattern: ^(0x)[0-9a-fA-F]{64}$
datestring · date-timeOptional

Date of the transaction. Optional.

Example: 2024-08-20T14:30:00Z
statusstring · enumOptional

Status of the transaction. Optional.

Example: PAIDPossible values:
amountnumberOptional

Amount of the transaction. Optional.

Example: 1000
seriestring · enumOptional

Series type. Optional.

Example: SENIORPossible values:
typestring · enumOptional

Type of the transaction. Optional.

Example: JUROSPossible values:
Responses
200

Successful response indicating the result of the operation.

application/json
post
/investor
POST /investor HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "investorAddress": "0x198ae62CAD1b9ecf58FfFaA36c0c85E6A84748B0",
  "tokenAddress": "0xb720f93879de10B7c080834464C4bA289E7Aa35E",
  "hash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "date": "2024-08-20T14:30:00Z",
  "status": "PAID",
  "amount": 1000,
  "serie": "SENIOR",
  "type": "JUROS"
}
{
  "status": "success",
  "message": "Investor payment stored successfully."
}
get

Get investor payment by token

Authorizations
Path parameters
addressstringRequired

Investor's wallet address.

Example: 0x1234567890abcdef1234567890abcdef12345678Pattern: ^(0x)[0-9a-fA-F]{40}$
tokenAddressstringRequired

Investor's tokenAddress address.

Example: 0x1234567890abcdef1234567890abcdef12345678Pattern: ^(0x)[0-9a-fA-F]{40}$
Responses
400

Error

application/json
get
/investor/{address}/{tokenAddress}
GET /investor/{address}/{tokenAddress} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
400

Error

{
  "statusCode": "text",
  "error": "text",
  "message": "text"
}
put

Update investor payment

Authorizations
Path parameters
addressstringRequired

Investor's wallet address.

Example: 0x1234567890abcdef1234567890abcdef12345678Pattern: ^(0x)[0-9a-fA-F]{40}$
idnumberRequired
Body
hashstringRequired

Transaction hash. Optional.

Example: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdefPattern: ^(0x)[0-9a-fA-F]{64}$
datestring · date-timeRequired

Date of the transaction. Optional.

Example: 2024-08-20T14:30:00Z
statusstring · enumRequired

Status of the transaction. Optional.

Example: PAIDPossible values:
amountnumberRequired

Amount of the transaction. Optional.

Example: 1000
Responses
200

Successful operation response.

application/json
put
/investor/{address}/{id}
PUT /investor/{address}/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "hash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "date": "2024-08-20T14:30:00Z",
  "status": "PAID",
  "amount": 1000
}
{
  "status": "success",
  "message": "Investor payment updated successfully."
}
PreviousInvestmentsNextBuy shares

Was this helpful?