C2F Docs v0

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: v0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Registration

Trade

Registration

Up 
post /c2f/register/company
Registers a new company (c2fRegisterCompanyPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RegisterCompanyRequest (optional)
Body Parameter —

Return type

RegisterCompanyResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

RegisterCompanyResponse
Up 
post /c2f/register/device
Registers a new device (c2fRegisterDevicePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RegisterDeviceRequest (optional)
Body Parameter —

Return type

RegisterDeviceResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

RegisterDeviceResponse

Trade

Up 
post /c2f/trade/cancel
Cancel a trade by tradeId (c2fTradeCancelPost)
<p>Depending on the state you are in the trade may move to:</p> <ul> <li>Cancelled</li> <li>NeedsRefund</li> </ul>

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CancelTradeRequest (optional)
Body Parameter —

Return type

CancelTradeResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success CancelTradeResponse
Up 
post /c2f/trade/crypto-buyer-approve
Approve trade as Crypto Buyer (Receiving) (c2fTradeCryptoBuyerApprovePost)
Mores TradeStatus to NeedsSellerApproval

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CryptoBuyerApproveRequest (optional)
Body Parameter —

Return type

ApproveTradeResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success ApproveTradeResponse
Up 
post /c2f/trade/crypto-seller-approve
Approve trade as Crypto Seller (Sending) (c2fTradeCryptoSellerApprovePost)
Mores TradeStatus to NeedsDepositAddress

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CryptoSellerApproveRequest (optional)
Body Parameter —

Return type

ApproveTradeResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success ApproveTradeResponse
Up 
post /c2f/trade/deposit
Get the deposit information for an escrow (c2fTradeDepositPost)
Crypto Seller ONLY endpoint Using a tradeId, request the deposit info to escrow the cryptocurrency

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DepositRequest (optional)
Body Parameter —

Return type

DepositResponse

Example data

Content-Type: application/json
{
  "address" : "address",
  "redeemScript" : "redeemScript",
  "amountCrypto" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success DepositResponse
Up 
post /c2f/trade/info
Retrieves the full state of a trade by tradeId (c2fTradeInfoPost)
This is a huge json

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body TradeInfoRequest (optional)
Body Parameter —

Return type

TradeInfoResponse

Example data

Content-Type: application/json
{
  "requiredConfirmations" : 6,
  "cryptoBuyerAccountId" : "1000951337",
  "closingTxId" : "925b9cfa5de749add9b42293e76337d1dba0ab2d211cce5a8e385433ba4135be",
  "escrowAddress" : "2N8vikwuSsozsQLe8nPKXpEdcM4ZU3RGUW2",
  "initiatingAccountId" : "1000951337",
  "amountFiat" : "",
  "refundAddresses" : [ null, null ],
  "cryptoSellerAccountId" : "1085441256",
  "escrowRedeemScript" : "7454876352876352210268975a7ee5baa780697bab56769f0389c85450d20bffddb8d6ed249066ccd1f5210317107bb4a9766eba2667e9e272eceab4efca20a6665780dda1ff72a24eff0eca52ae67522103f2d14d7d04241e2399d5c05fbe2ee442d9ebdc8249f514454963701cbb8399962103b6a96f51f1dbf430c3fcef25e90ec579a9e566cfdb60ca4c42f4060d74876d1252ae686721022705dd4970b5da96a077615bd70ec330c4998e7b8b05d7514fa82426b1cf4c76ac0462b1455eb168",
  "tradeDeadline" : 1595442022,
  "escrowConfirmations" : 4,
  "amountCrypto" : "",
  "timeWithdrawalSigned" : 1595442022,
  "escrowDeadline" : 1595442022,
  "receivingAddresses" : [ {
    "amount" : 0.5,
    "address" : "tb1q7dmslhumu9hk96ukee44da7807w82ue4kud58w"
  }, {
    "amount" : 0.5,
    "address" : "tb1q7dmslhumu9hk96ukee44da7807w82ue4kud58w"
  } ],
  "cryptoBuyerPubkey" : "cryptoBuyerPubkey",
  "escrowTxId" : "7f827d4a3ae3b6e408fa1737f12f9dbfa2bb8fd79e0e3e63256a6e78310790a4",
  "tradeStatus" : "",
  "closingConfirmations" : 3,
  "closingType" : "",
  "timeCreated" : 1595442022,
  "approvalDeadline" : 1595442022,
  "escrowIndex" : 0,
  "cryptoSellerPubkey" : "cryptoSellerPubkey"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success TradeInfoResponse
Up 
post /c2f/trade/list-trades
Search for trades that satisfy the filter settings (c2fTradeListTradesPost)
Returns metadata of trades that satisfy the filer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ListTradesRequest (optional)
Body Parameter —

Return type

ListTradesResponse

Example data

Content-Type: application/json
{
  "trades" : [ {
    "cryptoBuyerAccountId" : "cryptoBuyerAccountId",
    "amountFiat" : "",
    "cryptoSellerAccountId" : "cryptoSellerAccountId",
    "timeCreated" : 1595442022,
    "tradeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status" : "",
    "amountCrypto" : ""
  }, {
    "cryptoBuyerAccountId" : "cryptoBuyerAccountId",
    "amountFiat" : "",
    "cryptoSellerAccountId" : "cryptoSellerAccountId",
    "timeCreated" : 1595442022,
    "tradeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status" : "",
    "amountCrypto" : ""
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Trades Found ListTradesResponse
Up 
post /c2f/trade/new-crypto-buy-trade
New Trade - Receive Bitcoin (c2fTradeNewCryptoBuyTradePost)
Request a new trade to be started where you are receiving cryptocurrency Moves state of trade to NeedsSellerApproval

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CryptoBuyerNewTradeRequest (optional)
Body Parameter —

Return type

NewTradeResponse

Example data

Content-Type: application/json
{
  "tradeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success NewTradeResponse
Up 
post /c2f/trade/new-crypto-sell-trade
New Trade - Send Bitcoin (c2fTradeNewCryptoSellTradePost)
Request a new trade to be started where you are sending cryptocurrency Moves state of trade to NeedsBuyerApproval

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CryptoSellerNewTradeRequest (optional)
Body Parameter —

Return type

NewTradeResponse

Example data

Content-Type: application/json
{
  "tradeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success NewTradeResponse
Up 
post /c2f/trade/post-refund
Send signature to refund from escrow (c2fTradePostRefundPost)
Crypto Seller ONLY endpoint

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PostRefundRequest (optional)
Body Parameter —

Responses

200

Success
Up 
post /c2f/trade/post-withdraw
Send signature to withdraw from escrow (c2fTradePostWithdrawPost)
Crypto Buyer ONLY endpoint

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PostWithdrawRequest (optional)
Body Parameter —

Return type

PostWithdrawResponse

Example data

Content-Type: application/json
{
  "txId" : "txId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success PostWithdrawResponse
Up 
post /c2f/trade/start-refund
Request refund transaction information to sign (c2fTradeStartRefundPost)
Crypto Seller ONLY endpoint

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body StartRefundRequest (optional)
Body Parameter —

Return type

StartRefundResponse

Example data

Content-Type: application/json
{
  "escrowOutput" : 0,
  "escrowRedeemScript" : "7454876352876352210268975a7ee5baa780697bab56769f0389c85450d20bffddb8d6ed249066ccd1f5210317107bb4a9766eba2667e9e272eceab4efca20a6665780dda1ff72a24eff0eca52ae67522103f2d14d7d04241e2399d5c05fbe2ee442d9ebdc8249f514454963701cbb8399962103b6a96f51f1dbf430c3fcef25e90ec579a9e566cfdb60ca4c42f4060d74876d1252ae686721022705dd4970b5da96a077615bd70ec330c4998e7b8b05d7514fa82426b1cf4c76ac0462b1455eb168",
  "txnRefund" : "01000000000101e9b0b215e3287c1e840d50b21a65bde6d980feb4baef0a6672bf5133c98c2f07000000002322002038b0c01d109aa6ee1abc25e7c3b5631125d34441e00f46eec173cd3752d8378700000000018096980000000000160014f3770fdf9be16f62eb96ce6b56f7c77f9c7573350500490000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000049000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000102c27454876352876352210268975a7ee5baa780697bab56769f0389c85450d20bffddb8d6ed249066ccd1f521020180953818971d774f72cb0da2d48519902a0aedd708d76650b4ed585faffdfa52ae67522103f2d14d7d04241e2399d5c05fbe2ee442d9ebdc8249f514454963701cbb8399962103585ebcd616ebea1e6bf39ac9926ba4b609d3a65a534a3b222df42f769923121f52ae686721022705dd4970b5da96a077615bd70ec330c4998e7b8b05d7514fa82426b1cf4c76ac045cb0455eb16800000000",
  "escrowTxn" : "0200000001f65983bc08054052a58382327b8a1868da27a55ba49f4c5c6df5ee39454dfb660100000000fdffffff02689a98000000000017a914a6bb7a5f1b2d83aa8c0bcf33171806ca4f6abdc2871e102c0400000000160014c80f067849c7eb35daec886916da89ecbafa26dc7b651900"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success StartRefundResponse
Up 
post /c2f/trade/start-withdraw
Request withdraw transaction information to sign (c2fTradeStartWithdrawPost)
Crypto Buyer ONLY endpoint

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body StartWithdrawRequest (optional)
Body Parameter —

Return type

StartWithdrawResponse

Example data

Content-Type: application/json
{
  "escrowOutput" : 0,
  "escrowRedeemScript" : "7454876352876352210268975a7ee5baa780697bab56769f0389c85450d20bffddb8d6ed249066ccd1f5210317107bb4a9766eba2667e9e272eceab4efca20a6665780dda1ff72a24eff0eca52ae67522103f2d14d7d04241e2399d5c05fbe2ee442d9ebdc8249f514454963701cbb8399962103b6a96f51f1dbf430c3fcef25e90ec579a9e566cfdb60ca4c42f4060d74876d1252ae686721022705dd4970b5da96a077615bd70ec330c4998e7b8b05d7514fa82426b1cf4c76ac0462b1455eb168",
  "txnSpend" : "01000000000101e9b0b215e3287c1e840d50b21a65bde6d980feb4baef0a6672bf5133c98c2f07000000002322002038b0c01d109aa6ee1abc25e7c3b5631125d34441e00f46eec173cd3752d8378700000000018096980000000000160014f3770fdf9be16f62eb96ce6b56f7c77f9c7573350500490000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000049000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000102c27454876352876352210268975a7ee5baa780697bab56769f0389c85450d20bffddb8d6ed249066ccd1f521020180953818971d774f72cb0da2d48519902a0aedd708d76650b4ed585faffdfa52ae67522103f2d14d7d04241e2399d5c05fbe2ee442d9ebdc8249f514454963701cbb8399962103585ebcd616ebea1e6bf39ac9926ba4b609d3a65a534a3b222df42f769923121f52ae686721022705dd4970b5da96a077615bd70ec330c4998e7b8b05d7514fa82426b1cf4c76ac045cb0455eb16800000000",
  "escrowTxn" : "0200000001f65983bc08054052a58382327b8a1868da27a55ba49f4c5c6df5ee39454dfb660100000000fdffffff02689a98000000000017a914a6bb7a5f1b2d83aa8c0bcf33171806ca4f6abdc2871e102c0400000000160014c80f067849c7eb35daec886916da89ecbafa26dc7b651900"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success StartWithdrawResponse

Models

[ Jump to Methods ]

Table of Contents

  1. ApproveTradeResponse
  2. BigInteger
  3. Blockchain
  4. CancelTradeRequest
  5. CancelTradeResponse
  6. Coin
  7. CoinAmount
  8. CryptoBuyerApproveRequest
  9. CryptoBuyerNewTradeRequest
  10. CryptoSellerApproveRequest
  11. CryptoSellerNewTradeRequest
  12. DepositRequest
  13. DepositResponse
  14. FiatAmount
  15. FiatType
  16. ListTradesRequest
  17. ListTradesResponse
  18. NewTradeResponse
  19. PostRefundRequest
  20. PostWithdrawRequest
  21. PostWithdrawResponse
  22. ReceivingAddressInfo
  23. RegisterCompanyRequest
  24. RegisterCompanyResponse
  25. RegisterDeviceRequest
  26. RegisterDeviceResponse
  27. StartRefundRequest
  28. StartRefundResponse
  29. StartWithdrawRequest
  30. StartWithdrawResponse
  31. TimeFilter
  32. TradeDetails
  33. TradeInfoRequest
  34. TradeInfoResponse
  35. TradeStatus
  36. TransactionType

ApproveTradeResponse Up

BigInteger Up

isPowerOfTwo (optional)
Boolean
isZero (optional)
Boolean
isOne (optional)
Boolean
isEven (optional)
Boolean
sign (optional)
Integer format: int32

Blockchain Up

CancelTradeRequest Up

tradeId (optional)
UUID TradeId of the request in question, look up accountIds in the AccountIdDBFilter. format: uuid

CancelTradeResponse Up

Coin Up

CoinAmount Up

value (optional)
Float Decimal format: float
example: 0.5
coin (optional)
String Coin Enum
Enum:
BTC
LTC
BCH
ETH
USDC
example: BTC

CryptoBuyerApproveRequest Up

receivingAddresses (optional)
array[ReceivingAddressInfo] List of Bob's receiving addresses where crypto will be sent if trade executes
pubkey (optional)
String Requester's pubkey
example: AmiXWn7luqeAaXurVnafA4nIVFDSC//duNbtJJBmzNH1
tradeId (optional)
UUID TradeId of the request in question, look up accountIds in the AccountIdDBFilter. format: uuid

CryptoBuyerNewTradeRequest Up

receivingAddresses (optional)
array[ReceivingAddressInfo] List of Bob's receiving addresses where crypto will be sent if trade executes
pubkey (optional)
String Bob's pubkey
example: AmiXWn7luqeAaXurVnafA4nIVFDSC//duNbtJJBmzNH1
accountId
String Initiator's Account ID. This account id will be validated against the api key's account ids.
example: 1000951337
counterPartyAccountId
String Account ID of counter party
example: 1085441256
amountCrypto
Amount of crypto to trade
amountFiat
Amount of fiat to trade
approvalDeadline (optional)
Long Absolute time after which if the counterparty has not approved the deal the trade will be aborted. format: int64
example: 1595442022
escrowDeadline (optional)
Long Absolute time after which if the escrow has not been submitted to the mempool by Alice the trade will be aborted. format: int64
example: 1595442022
tradeDeadline (optional)
Long Absolute time after which if Bob has not signed a withdrawal the trade will be aborted. format: int64
example: 1595442022
requiredNumberOfConfirmations (optional)
Integer Number of confirmations on the withdrawal transaction to consider the transaction finalized format: int32
example: 6

CryptoSellerApproveRequest Up

pubkey (optional)
String Requester's pubkey
example: AmiXWn7luqeAaXurVnafA4nIVFDSC//duNbtJJBmzNH1
tradeId (optional)
UUID TradeId of the request in question, look up accountIds in the AccountIdDBFilter. format: uuid

CryptoSellerNewTradeRequest Up

accountId
String Initiator's Account ID. This account id will be validated against the api key's account ids.
example: 1000951337
counterPartyAccountId
String Account ID of counter party
example: 1085441256
amountCrypto
Amount of crypto to trade
amountFiat
Amount of fiat to trade
approvalDeadline (optional)
Long Absolute time after which if the counterparty has not approved the deal the trade will be aborted. format: int64
example: 1595442022
escrowDeadline (optional)
Long Absolute time after which if the escrow has not been submitted to the mempool by Alice the trade will be aborted. format: int64
example: 1595442022
tradeDeadline (optional)
Long Absolute time after which if Bob has not signed a withdrawal the trade will be aborted. format: int64
example: 1595442022
requiredNumberOfConfirmations (optional)
Integer Number of confirmations on the withdrawal transaction to consider the transaction finalized format: int32
example: 6

DepositRequest Up

tradeId (optional)
UUID TradeId of the request in question, look up accountIds in the AccountIdDBFilter. format: uuid

DepositResponse Up

redeemScript (optional)
String Redeem script of escrow
address (optional)
String P2SH address of the escrow
amountCrypto (optional)
Amount to send

FiatAmount Up

amount (optional)
Float Decimal format: float
example: 10000
fiat (optional)
String FiatType Enum
Enum:
USD
example: USD

FiatType Up

ListTradesRequest Up

A set of filters that returns trades that satisfy the filter
filterOnCreationTime (optional)
Filter on the creation time of a trade
filterOnStatus (optional)
array[TradeStatus] Filter trades which are in a particular set of statuses
filterOnAccountId (optional)
String Filter trades which involve a particular account id

ListTradesResponse Up

trades (optional)
array[TradeDetails]

NewTradeResponse Up

tradeId (optional)
UUID format: uuid

PostRefundRequest Up

signature (optional)
String Signature on TxnRefund Transaction
example: MEQCIBGmpKtQNR34L4Ew/x693QET2cqaznpXdKlglAMFyZDUAiAkO6xTtC3C8hGfImcutb3gKoKYT6F6CrRcoQnLGj1IbgE=
tradeId (optional)
UUID TradeId of the request in question, look up accountIds in the AccountIdDBFilter. format: uuid

PostWithdrawRequest Up

signature (optional)
String Signature on TxnSpend Transaction
example: MEQCIBGmpKtQNR34L4Ew/x693QET2cqaznpXdKlglAMFyZDUAiAkO6xTtC3C8hGfImcutb3gKoKYT6F6CrRcoQnLGj1IbgE=
tradeId (optional)
UUID TradeId of the request in question, look up accountIds in the AccountIdDBFilter. format: uuid

PostWithdrawResponse Up

txId (optional)
String

ReceivingAddressInfo Up

amount (optional)
Float Decimal format: float
example: 0.5
address (optional)
String Cryptocurrency Address
example: tb1q7dmslhumu9hk96ukee44da7807w82ue4kud58w

RegisterCompanyRequest Up

Registers a particular company with C2F
email
String The company's email address for updates and notifications. format: email
companyName
String The company's name.
regToken
String Hashed registration token for the company generated by the client.
companyId
String Unique identifier for a particular company generated by the bank.
authToken
String Authentication token for a given request provided by the bank through the client.

RegisterCompanyResponse Up

RegisterDeviceRequest Up

Registers a particular device with C2F
deviceId
String A unique identifier for the particular device.
deviceName
String The user's name for the device.
regToken
String Hashed registration token for the company generated by the client.
companyId
String Unique identifier for a particular company generated by the bank.
authToken
String Authentication token for a given request provided by the bank through the client.

RegisterDeviceResponse Up

StartRefundRequest Up

refundAddresses (optional)
array[ReceivingAddressInfo] List of addresses/amounts to use as outputs to the refund transaction
tradeId (optional)
UUID TradeId of the request in question, look up accountIds in the AccountIdDBFilter. format: uuid

StartRefundResponse Up

escrowTxn (optional)
String Hex-encoded EscrowTransaction object
example: 0200000001f65983bc08054052a58382327b8a1868da27a55ba49f4c5c6df5ee39454dfb660100000000fdffffff02689a98000000000017a914a6bb7a5f1b2d83aa8c0bcf33171806ca4f6abdc2871e102c0400000000160014c80f067849c7eb35daec886916da89ecbafa26dc7b651900
escrowOutput (optional)
Integer The output index of the escrow in the EscrowTransaction format: int32
example: 0
escrowRedeemScript (optional)
String Hex-encoded redeem script of the escrow
example: 7454876352876352210268975a7ee5baa780697bab56769f0389c85450d20bffddb8d6ed249066ccd1f5210317107bb4a9766eba2667e9e272eceab4efca20a6665780dda1ff72a24eff0eca52ae67522103f2d14d7d04241e2399d5c05fbe2ee442d9ebdc8249f514454963701cbb8399962103b6a96f51f1dbf430c3fcef25e90ec579a9e566cfdb60ca4c42f4060d74876d1252ae686721022705dd4970b5da96a077615bd70ec330c4998e7b8b05d7514fa82426b1cf4c76ac0462b1455eb168
txnRefund (optional)
String Hex-encoded RefundTransaction for the refunder to sign
example: 01000000000101e9b0b215e3287c1e840d50b21a65bde6d980feb4baef0a6672bf5133c98c2f07000000002322002038b0c01d109aa6ee1abc25e7c3b5631125d34441e00f46eec173cd3752d8378700000000018096980000000000160014f3770fdf9be16f62eb96ce6b56f7c77f9c7573350500490000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000049000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000102c27454876352876352210268975a7ee5baa780697bab56769f0389c85450d20bffddb8d6ed249066ccd1f521020180953818971d774f72cb0da2d48519902a0aedd708d76650b4ed585faffdfa52ae67522103f2d14d7d04241e2399d5c05fbe2ee442d9ebdc8249f514454963701cbb8399962103585ebcd616ebea1e6bf39ac9926ba4b609d3a65a534a3b222df42f769923121f52ae686721022705dd4970b5da96a077615bd70ec330c4998e7b8b05d7514fa82426b1cf4c76ac045cb0455eb16800000000

StartWithdrawRequest Up

tradeId (optional)
UUID TradeId of the request in question, look up accountIds in the AccountIdDBFilter. format: uuid

StartWithdrawResponse Up

escrowTxn (optional)
String Hex-encoded EscrowTransaction object
example: 0200000001f65983bc08054052a58382327b8a1868da27a55ba49f4c5c6df5ee39454dfb660100000000fdffffff02689a98000000000017a914a6bb7a5f1b2d83aa8c0bcf33171806ca4f6abdc2871e102c0400000000160014c80f067849c7eb35daec886916da89ecbafa26dc7b651900
escrowOutput (optional)
Integer The output index of the escrow in the EscrowTransaction format: int32
example: 0
escrowRedeemScript (optional)
String Hex-encoded redeem script of the escrow
example: 7454876352876352210268975a7ee5baa780697bab56769f0389c85450d20bffddb8d6ed249066ccd1f5210317107bb4a9766eba2667e9e272eceab4efca20a6665780dda1ff72a24eff0eca52ae67522103f2d14d7d04241e2399d5c05fbe2ee442d9ebdc8249f514454963701cbb8399962103b6a96f51f1dbf430c3fcef25e90ec579a9e566cfdb60ca4c42f4060d74876d1252ae686721022705dd4970b5da96a077615bd70ec330c4998e7b8b05d7514fa82426b1cf4c76ac0462b1455eb168
txnSpend (optional)
String Hex-encoded SpendTransaction for the withdrawer to sign
example: 01000000000101e9b0b215e3287c1e840d50b21a65bde6d980feb4baef0a6672bf5133c98c2f07000000002322002038b0c01d109aa6ee1abc25e7c3b5631125d34441e00f46eec173cd3752d8378700000000018096980000000000160014f3770fdf9be16f62eb96ce6b56f7c77f9c7573350500490000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000049000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000102c27454876352876352210268975a7ee5baa780697bab56769f0389c85450d20bffddb8d6ed249066ccd1f521020180953818971d774f72cb0da2d48519902a0aedd708d76650b4ed585faffdfa52ae67522103f2d14d7d04241e2399d5c05fbe2ee442d9ebdc8249f514454963701cbb8399962103585ebcd616ebea1e6bf39ac9926ba4b609d3a65a534a3b222df42f769923121f52ae686721022705dd4970b5da96a077615bd70ec330c4998e7b8b05d7514fa82426b1cf4c76ac045cb0455eb16800000000

TimeFilter Up

Allows specifying a time filter between [<code>Begin</code>, <code>End</code>] where <code>Begin</code> and <code>End</code> are both Time in seconds from the epoch
begin (optional)
Long format: int64
end (optional)
Long format: int64

TradeDetails Up

tradeId (optional)
UUID format: uuid
status (optional)
amountCrypto (optional)
amountFiat (optional)
cryptoSellerAccountId (optional)
String
cryptoBuyerAccountId (optional)
String
timeCreated (optional)
Long Epoch Time format: int64
example: 1595442022

TradeInfoRequest Up

Enables a user or a partner to query information about the trade with the specified Trade ID.
tradeId (optional)
UUID TradeId of the request in question, look up accountIds in the AccountIdDBFilter. format: uuid

TradeInfoResponse Up

tradeStatus (optional)
Current status of the trade.
cryptoBuyerAccountId (optional)
String Account ID of the party selling fiat
example: 1000951337
cryptoSellerAccountId (optional)
String Account ID of the party selling crypto
example: 1085441256
initiatingAccountId (optional)
String Account id of the party that initiated the trade
example: 1000951337
amountCrypto (optional)
Amount of crypto being traded
amountFiat (optional)
Amount of fiat being traded
timeCreated (optional)
Long Date-time when this trade was created i.e. initiated and then approved by the initiator format: int64
example: 1595442022
approvalDeadline (optional)
Long Date-time after which if the trade is not withdrawing the trade will be aborted. In seconds after the epoch format: int64
example: 1595442022
escrowDeadline (optional)
Long The timelock of the the escrow after which the escape hatch can be used format: int64
example: 1595442022
tradeDeadline (optional)
Long Date-time after which if the trade is not withdrawing the trade will be aborted. In seconds after the epoch format: int64
example: 1595442022
timeWithdrawalSigned (optional)
Long Date-time after which the withdrawal was signed by Bob. In seconds after the epoch format: int64
example: 1595442022
requiredConfirmations (optional)
Long Number of confirmations on the withdrawal transaction to consider the transaction finalized format: int64
example: 6
cryptoBuyerPubkey (optional)
String Bob's Pubkey for spending the escrow to Bob
cryptoSellerPubkey (optional)
String Alice's Pubkey for refunding the escrow back to Alice
receivingAddresses (optional)
array[ReceivingAddressInfo] These are addresses where is the trade is settled Bob receives his funds at
refundAddresses (optional)
array[ReceivingAddressInfo] These are addresses where is the trade is refunded Alice receives her funds at
escrowTxId (optional)
String The TXID of the transaction that creates the escrow output
example: 7f827d4a3ae3b6e408fa1737f12f9dbfa2bb8fd79e0e3e63256a6e78310790a4
escrowIndex (optional)
Integer The output index of the escrow output. Together with the TXID the index uniquely defines an output format: int32
example: 0
escrowConfirmations (optional)
Long Number of confirmations the escrow transaction currently has format: int64
example: 4
closingTxId (optional)
String The TXID of the transaction that spends the escrow output to Bob
example: 925b9cfa5de749add9b42293e76337d1dba0ab2d211cce5a8e385433ba4135be
closingConfirmations (optional)
Long Number of confirmations the spent transaction currently has format: int64
example: 3
closingType (optional)
The type of the closing transaction
escrowAddress (optional)
String P2SH escrow address
example: 2N8vikwuSsozsQLe8nPKXpEdcM4ZU3RGUW2
escrowRedeemScript (optional)
String Redeem script for escrow output, hex encoded
example: 7454876352876352210268975a7ee5baa780697bab56769f0389c85450d20bffddb8d6ed249066ccd1f5210317107bb4a9766eba2667e9e272eceab4efca20a6665780dda1ff72a24eff0eca52ae67522103f2d14d7d04241e2399d5c05fbe2ee442d9ebdc8249f514454963701cbb8399962103b6a96f51f1dbf430c3fcef25e90ec579a9e566cfdb60ca4c42f4060d74876d1252ae686721022705dd4970b5da96a077615bd70ec330c4998e7b8b05d7514fa82426b1cf4c76ac0462b1455eb168

TradeStatus Up

TransactionType Up