Get the details of an order

Please note the following:

• If the amount paid is not exactly the input amount, we can be required to cancel the order, or the output amount will be adjusted and extra fees could be charged.
• If it is sent in multiple transactions, we can be required to cancel the order and extra processing fees could be charged.

Minimal details

When the request does not include sufficient credentials, only minimal information is returned. If you are unexpectedly receiving only minimal details, please double check which security scheme you are using and used to place the order. When no security scheme is used, please make sure you are making all the requests to the correct URLs and that cookies are accepted and handled according to RFC 6265. Most user agents handle that for you but cookies must not be disabled and you may have to request the user-agent to include credentials in the request.

The full information is returned when one of the following is true:

• No security scheme is used and the order was placed while unauthenticated, in the same session.
• The bity_account_oauth or bity_account_oauth_client security scheme are used, the scope includes https://auth.bity.com/scopes/exchange.place or https://auth.bity.com/scopes/exchange.history, and the OAuth client is the client having placed the order.
• The bity_account_oauth or bity_account_oauth_client security scheme are used and the scope includes https://auth.bity.com/scopes/exchange.audit.
• The client_oauth security scheme is used and the OAuth client is the client having placed the order.

Output address signature

When the customer is not authenticated or has not gone through the KYC process, crypto-to-crypto and fiat-to-crypto orders require the signature of a message by the output address for the order to become executable. When such a signature is required "message_to_sign" is included in the response. The price will not be fixed and the payment details will not be provided before the signature of the message is submitted.

Input and output objects

The input type and output type can be one of "crypto_address" or "bank_account".

• In case it is "crypto_address" the object additionally contains "crypto_address".
• In case it is "bank_account" the object additionally contains "iban".

Whenever the input object contains iban or crypto_address, the input must be paid from the corresponding object. If this is not the case, we can be required to cancel the order and perform a refund uppon reception of the funds and extra fees can be charged.

Payment details

This object describes how to pay the input amount.

There are two different possible types of payment details: "crypto_address" and "bank_account". Both types are described bellow. The amount and the associated currency is found in the input object.

Crypto-address

When the payment must be made to a crypto-address, the type is "crypto_address" and the address to use as a destination address is found in the "crypto_address" attribute. If the payment details contain a "memo", the cryptocurrency transaction must include it.

Bank account

When the payment must be made to a bank account, the type is "bank_account".

In most cases the banks involved in sending, transmitting and receiving the payment will require the IBAN, SWIFT code and the bank account owner name and address to process the payment. This is reflected by the information provided in the response:

• "iban": The IBAN to which the payment must be made.
• "owner": An object containing information about the owner of the bank account. It can contain the following properties: "name", "address", "address_complement", "zip", "city", "state", "country". The country is formatted as a two-letter country code.
• "swift_bic" The SWIFT code (also known as BIC) of the bank account at which the bank account is located.

Amounts

When timestamp_price_guaranteed is not present or has elapsed, the amounts (input, output and price breakdown) are an estimation of the amounts that would have been used should the order have been executed at the time the order details were retrieved.

When timestamp_price_guaranteed is present and has not elapsed, the amounts correspond to the amounts that will be used provided that the exact input amount is received before timestamp_price_guaranteed elapses.

{
  "id": "209a6210-4ea3-43e4-ba92-73aac60fb10c",
  "input": {
    "amount": "0.5",
    "crypto_address": "0x24305d091f79ee490a34de080b0db5773be5bef4",
    "currency": "ETH",
    "type": "crypto_address"
  },
  "output": {
    "amount": "104.95",
    "bic_swift": "BCNNCH22",
    "currency": "CHF",
    "iban": "CH3600000000000000000",
    "owner": {
      "address": "Rue des Fahrys 2",
      "city": "Neuchatel",
      "country": "CH",
      "name": "John Doe"
    },
    "type": "bank_account"
  },
  "payment_details": {
    "crypto_address": "0xf35074bbd0a9aee46f4ea137971feec024ab7048",
    "type": "crypto_address"
  },
  "timestamp_cancelled": "2019-01-25T01:06:11.632Z",
  "timestamp_created": "2019-01-24T13:14:07.368Z"
}