Sebak Client API

Payment transaction

POST/api/v1/transactions

• You can refer this link to make transaction through sebakpy-util.

• Data Body consist of 3 parts, ; T, H, B

  • T : ‘transaction’

  • H : H means Header. it consists of version, hash, signature & created.

    • Version means to transaction version. At the moment 1.

    • Hash means transaction hash.

    • signature is signed data from client.

      • How can you make signature?

      Please check this link first.

      You need 3 variables to make signature; RLPdata which is hashing, network id and source’s secret seed.

      You can see that Which kinds of variables necessary.

      You can use [JavaScript SDK] to make signature or [Python SDK]. Please check above SDKs.

    • created means to transcation created time.

  • B : B means Body. It is RLP data. so you have to encode B data to RLP format. It contains; source , fee, sequence id, and operations.

    • source; means that public address which will BOScoin withdraw .

    • fee : data type is String.

    • sequence id

      • How can you get sequence id?

      When you finished account creation, you can access http(or https)😕/{IP that you set up sebak node}/api/v1/accounts/{Public address that account you created}.

      Then you can see sequence_id in response.

    • operations: It is json array consist of H & B. H include type, which means operation type. B include target & amount.

    • H : type ( type should be set ‘payment’ )

    • B : target ( Public address you want to send.) , amount ( amount data type is String .)

Example URI

Content-Type: application/json

{
  "T": "transaction",
  "H": {
    "version": "1",
    "created": "2018-01-01T00:00:00.000000000Z",
    "signature": "4ty1Pv7Phc3CEeGLCP8mjZfEC259VR1MBgyVHzQXTcWjuSiwxVQ2AQKxy2HjGTCDrmdE29z8ZNZ6GxuDyEay2p9M"
  },
  "B": {
    "source": "GDIRF4UWPACXPPI4GW7CMTACTCNDIKJEHZK44RITZB4TD3YUM6CCVNGJ",
    "fee": "10000",
    "sequence_id": "0",
    "operations": [
      {
        "H": {
          "type": "payment"
        },
        "B": {
          "target": "GDTEPFWEITKFHSUO44NQABY2XHRBBH2UBVGJ2ZJPDREIOL2F6RAEBJE4",
          "amount": "1000000000000"
        }
      }
    ]
  }
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "T": {
      "type": "string"
    },
    "H": {
      "type": "object",
      "properties": {
        "version": {
          "type": "string",
          "description": "Transaction version"
        },
        "created": {
          "type": "string",
          "description": "Created time of the transaction."
        },
        "signature": {
          "type": "string",
          "description": "Signature signed by source account"
        }
      }
    },
    "B": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string",
          "description": "Source account"
        },
        "fee": {
          "type": "string",
          "description": "The fee paid by the source account for this transaction. Minimum is 10000 GON"
        },
        "sequence_id": {
          "type": "string",
          "description": "The last sequence number of the source account"
        },
        "operations": {
          "type": "array"
        }
      }
    }
  }
}

Content-Type: application/json; charset=utf-8

{
  "_links": {
    "history": {
      "href": "/api/v1/transactions/7mRUj4cnUPaTrpByojPsT3xoRRdwG6Q9z2eLyCMapQm6/history"
    },
    "self": {
      "href": "/api/v1/transactions"
    }
  },
  "hash": "7mRUj4cnUPaTrpByojPsT3xoRRdwG6Q9z2eLyCMapQm6",
  "message": {
    "source": "GDIRF4UWPACXPPI4GW7CMTACTCNDIKJEHZK44RITZB4TD3YUM6CCVNGJ",
    "fee": "10000",
    "sequence_id": "0",
    "operations": [
      {
        "H": {
          "type": "create-account"
        },
        "B": {
          "target": "GDTEPFWEITKFHSUO44NQABY2XHRBBH2UBVGJ2ZJPDREIOL2F6RAEBJE4",
          "amount": "1000000000000"
        }
      }
    ]
  },
  "status": "submitted"
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_links": {
      "type": "object",
      "properties": {
        "history": {
          "type": "object",
          "properties": {
            "href": {
              "type": "string"
            }
          }
        },
        "self": {
          "type": "object",
          "properties": {
            "href": {
              "type": "string"
            }
          }
        }
      }
    },
    "hash": {
      "type": "string",
      "description": "Hash of transaction."
    },
    "message": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string",
          "description": "Source account"
        },
        "fee": {
          "type": "string",
          "description": "The fee paid by the source account for this transaction. Minimum is 10000 GON"
        },
        "sequence_id": {
          "type": "string",
          "description": "The last sequence number of the source account"
        },
        "operations": {
          "type": "array"
        }
      }
    },
    "status": {
      "type": "string",
      "description": "three categories of status; submitted, confirmed, rejected"
    }
  }
}

Content-Type: application/problem+json; charset=utf-8

{
  "status": 500,
  "title": "problem error message",
  "type": "https://boscoin.io/sebak/error/{error_code}"
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  }
}