Infinity
  1. Company
Infinity
  • Start your Apidog journey
  • Infinity
    • Pomelo Card
      • [Mobile]
        • Mobile Login
        • Get OTP Activate Pomelo Card
        • Resent OTP Activate Card
        • Verify Activate Pomelo Card
        • Get URL View Card Details
        • Get Otp Set Pin Card
        • Resent Otp Set Pin Card
        • Verify Otp Set Pin Card
      • EkycCardHolder_Update
        • [EKyc]-Create
        • [EKyc]-Get Otp Approval Or Reject
        • [EKyc]-Resent OTP Approval Or Reject
        • [EKyc]-Verify OTP Approval Or Reject
        • [EKyc]-Filter Ekyc
        • [EKyc]-Get Kyc Detail
        • [Card Holder]-Filter Card Holder
        • [Card Holder]-Get Card Holder Detail
        • [CardHolder]-Edit CardHolder
      • [Batch]-Create
      • [Batch]-Resent OTP Create
      • [Batch]-Verify OTP Create
      • [Batch]-Get Pomelo Batch Card With Paging
      • [Batch]-Confirm Receved
      • [Batch]-Get Details
      • [CardHolder]-Get Presign Link
      • [CardHolder]-Create
      • [CardHolder]-Get Otp Approval Or Reject
      • [CardHolder]-Verify OTP Approval Or Reject
      • [CardHolder]-Resent OTP Approval Or Reject
      • [CardHolder]-Get Ekyc With Paging
      • [CardHolder]-Get With Paging
      • [CardHolder]-Get By Company With Paging
      • [CardHolder] - PresignLinkView
      • [Common]-Get Documents Type
      • [Common]-Get Nationalities
      • [Common]-Get Genders
      • [Card]-Get With Paging
      • [Card]-Get Details
      • [Card]-Get Details By CardID
      • [Card]-Get OTP Action
      • [Card]-Resent OTP Action
      • [Card]-Verify OTP
      • [Card]-Get Balance
      • [Card]-Confirm Received Card
      • [CardHolder]-Search
      • [Card]-GetTransactionHistory
      • [Account]-Get Account Details
      • [Card]-Get Cards By Batch
      • [Account]-Get Statement
      • [Card Holder] - Get Card Holder Detail
      • [Card]-Search Pomelo Card
      • [CardHolder]-Edit
    • Users
      • User Blacklist
        • [User Blacklist]- List User Black List
      • User Blacklist History
        • [User Blacklist History]- List User Blacklist History
      • [User]-Create
      • [User]-Login
      • [User]-Create User Type
      • [User]-Change Password
      • [User]-List
      • [User]-Forgot Password
      • [User]-Update Avatar
      • [User]-Update Info
      • [User]-Update Language
      • [User]-Update Token
      • [User]-Set Read Notification
      • [User]-Get Notifications
      • [User]-Update Device token
      • [User]-User Detail
      • [User]-Count Notification Unread
      • [User]-Verify OTP Forgot Password
      • [User]-Resent OTP Forgot Password
      • [User]-Get Iv
      • [User]-Login With 2Fa
    • Company
      • Company Blacklist
        • [Company]- List Company Black List
      • Company Blacklist History Copy
        • [Company]- List Company Blacklist History
      • [Company]-New Star
        POST
      • [Company]-New Satellite
        POST
      • [Company]-New Star Config
        POST
      • [Company]-Get Relationships
        POST
      • [Company]-Star By User
        POST
      • [Company]-Get Satellites
        POST
      • [Company]-Satellite Under Star
        POST
      • [Company]-Get Presign Link
        POST
      • [Company]-Set Bank Account
        POST
      • [Company]-Get Star Details
        POST
      • [Company]-Get Satellite Details
        POST
      • [Company]-Edit Star
        POST
      • [Company]-Edit Satellite
        POST
      • [Company]-Move Satellite
        POST
      • [Company]-Get OTP
        POST
      • [Company]-Resent OTP
        POST
      • [Company]-Verity OTP
        POST
      • [Company]-Get Overnight Money
        POST
      • [Company]-Save Overnight Money
        POST
      • [Company]-Get Request Open Company
        POST
      • [Company]-Set Status Request Open Account
        POST
      • [Company]-Get Docs By Type
        POST
      • [Company]-Add Special Clabe
        POST
      • [Company]-Get OTP Block Company
        POST
      • [Company]-Resent OTP Block Company
        POST
      • [Company]-Verify OTP Block Company
        POST
      • [Company]-Get Banks
        POST
      • [Company]-Get Galaxy
        POST
      • [Company]-Get Galaxy By User
        POST
      • [Company]-Pre-Sign Link Upload Blacklist Review Doc
        POST
      • [Company]-Pre-Sign Link Read Blacklist Review Doc
        POST
    • Group
      • [Group]-Get Channels
      • [Group]-Create Group
      • [Group]-Get Group By Star
      • [Group]-Get Details
      • [Group]-Get Details By DocID
      • [Group]-Edit Group
    • Transaction
      • [Transaction]-Get Transactions By Company V2
      • [Transaction]-Get Transactions By Company
      • [Transaction]-Get Pending Transactions
      • [Transaction]-Get Pending Transaction V2
      • [Transaction]-Get Details Pending Transaction
      • [Transaction]-Get Schedule Transaction
      • [Transaction]-Get Schedule Transaction V2
      • [Transaction]-Get Transaction Details
      • [Transaction]-Get Transaction Status
      • [Transactio] - Transfer Money
      • [Transactio] - Verify OTP
    • [External]Pomelo
      • request token
      • request batch of card
      • create user
      • create digital account
      • create user token
      • link card
      • deposit account
      • search card by shipment ID
      • search card by shipment ID Copy
      • get shipment
      • get card details
      • get account details
      • get card details full - test usage only
      • url activate card
    • External
      • Event Activated Card
      • Event Account Activity
    • ClientWeb
      • Login
      • Login 2Fa
  1. Company

[Company]-Get Star Details

Developing
POST
/api=getStarDetails

Request

None

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api=getStarDetails'

Responses

🟢200Success
application/json
Body
code
integer 
required
message
string 
required
reqId
string 
required
payload
object 
required
dateIncorporation
string <date-time>
required
transaction
object 
required
groups
object 
required
legallyRepresentative
object 
required
companyAddress
object 
required
alias
string 
required
phone
string 
required
balance
string 
required
accountTypeCode
string 
required
docId
string 
required
rfcNumber
string 
required
idVal
string 
required
groupScheme
string 
required
groupDocId
string 
required
accountNumber
string 
required
commissionAccount
string 
required
parentId
string 
required
currency
string 
required
id
string 
required
sourceFund
string 
required
companyEmail
string 
required
name
string 
required
clabe
string 
required
mainActivity
string 
required
requiredInfos
array [object {3}] 
required
adminUsers
array [object {5}] 
required
docs
array [object {3}] 
required
sharedHolders
array [object {5}] 
required
treasurers
array [object {5}] 
required
beneficiaries
array [object {7}] 
required
interateRate
number 
required
enableCashout
boolean 
required
isBlock
boolean 
required
starType
string 
required
refClabe
string 
required
Example
{
    "code": 0,
    "message": "string",
    "reqId": "string",
    "payload": {
        "dateIncorporation": "2019-08-24T14:15:22Z",
        "transaction": {
            "approximateMonthly": 0,
            "maxAmount": 0,
            "minAmount": 0
        },
        "groups": {
            "createdTime": "2019-08-24T14:15:22Z",
            "docId": "string",
            "starId": "string",
            "alias": "string",
            "channel": [
                {
                    "name": "string",
                    "display": "string",
                    "code": "string",
                    "level": "string",
                    "productList": [
                        {
                            "code": "string",
                            "name": "string",
                            "title": {
                                "key": "string"
                            },
                            "pricing": {
                                "type": "string",
                                "value": 0,
                                "paymentMethodList": [
                                    {
                                        "code": "string",
                                        "name": "string",
                                        "isEnable": true
                                    }
                                ]
                            },
                            "cash": {
                                "resetTypes": {
                                    "code": "string",
                                    "name": "string",
                                    "display": {
                                        "key": "string"
                                    }
                                },
                                "startTime": "string",
                                "endTime": "string",
                                "operationDayList": [
                                    {
                                        "code": "string",
                                        "name": "string",
                                        "isEnable": true
                                    }
                                ],
                                "maxDailyAmount": 0,
                                "maxMonthlyAmount": 0,
                                "maxTransactionAmount": 0,
                                "maxTransactionNumber": 0
                            },
                            "commission": {
                                "businessPercent": 0,
                                "referPercent": 0
                            },
                            "level": "string"
                        }
                    ]
                }
            ],
            "assignList": [
                {
                    "name": "string",
                    "avatar": "string",
                    "docId": "string",
                    "roleName": {
                        "key": "string"
                    },
                    "id": 0
                }
            ],
            "id": 0,
            "companyNumber": "string",
            "isStarGroup": "string",
            "coffee": {
                "clabe": "string",
                "value": "string",
                "beneficaryName": "string"
            }
        },
        "legallyRepresentative": {
            "fullName": "string",
            "address": {
                "postCode": "string",
                "roadName": "string",
                "exteriorNumber": "string",
                "interiorNumber": "string",
                "neighborhoodName": "string",
                "localityName": "string",
                "municipalityName": "string",
                "federalName": "string",
                "streetBetween": "string"
            },
            "firstName": "string",
            "lastName": "string",
            "secondLastName": "string"
        },
        "companyAddress": {
            "postCode": "string",
            "roadName": "string",
            "exteriorNumber": "string",
            "interiorNumber": "string",
            "neighborhoodName": "string",
            "localityName": "string",
            "municipalityName": "string",
            "federalName": "string",
            "streetBetween": "string"
        },
        "alias": "string",
        "phone": "string",
        "balance": "string",
        "accountTypeCode": "string",
        "docId": "string",
        "rfcNumber": "string",
        "idVal": "string",
        "groupScheme": "string",
        "groupDocId": "string",
        "accountNumber": "string",
        "commissionAccount": "string",
        "parentId": "string",
        "currency": "string",
        "id": "string",
        "sourceFund": "string",
        "companyEmail": "string",
        "name": "string",
        "clabe": "string",
        "mainActivity": "string",
        "requiredInfos": [
            {
                "code": "string",
                "description": "string",
                "answer": "string"
            }
        ],
        "adminUsers": [
            {
                "name": "string",
                "avatar": "string",
                "docId": "string",
                "roleName": {
                    "key": "string"
                },
                "id": 0
            }
        ],
        "docs": [
            {
                "code": "string",
                "fileName": "string",
                "docId": "string"
            }
        ],
        "sharedHolders": [
            {
                "fullName": "string",
                "percentage": 1,
                "firstName": "string",
                "lastName": "string",
                "secondLastName": "string"
            }
        ],
        "treasurers": [
            {
                "fullName": "string",
                "email": "string",
                "firstName": "string",
                "lastName": "string",
                "secondLastName": "string"
            }
        ],
        "beneficiaries": [
            {
                "name": "string",
                "fatherName": "string",
                "motherName": "string",
                "email": "string",
                "phone": "string",
                "dateOfBirth": "2019-08-24T14:15:22Z",
                "relationship": "string"
            }
        ],
        "interateRate": 0,
        "enableCashout": true,
        "isBlock": true,
        "starType": "string",
        "refClabe": "string"
    }
}
Modified at 2025-03-05 17:57:00
Previous
[Company]-Set Bank Account
Next
[Company]-Get Satellite Details
Built with