conversion.services.rehive.io Open in urlscan Pro
2606:4700:10::ac43:2857 Public Scan

Back to summary
URL:
https://conversion.services.rehive.io/
Submission: On August 27 via automatic, source certstream-suspicious (August 27th 2024, 10:29:05 am UTC) — Scanned from DE
Form analysis
0 forms found in the DOM

Text Content

 * activate
   * postActivate service
 * admin
   * getRetrieve company
   * putUpdate company
   * patchPartially update company
   * getList conversion pairs
   * postCreate conversion pair
   * getRetrieve conversion pair
   * putUpdate conversion pair
   * patchPartially update conversion pair
   * delDelete conversion pair
   * getList conversions
   * postCreate conversion
   * getRetrieve conversion
   * putUpdate conversion
   * patchPartially update conversion
   * getList currencies
   * postCreate currency
   * getRetrieve currency
   * putUpdate currency
   * patchPartially update currency
   * getList integration
   * postCreate integration
   * getRetrieve integration
   * putUpdate integration
   * patchPartially update integration
   * delDelete integration
   * getList integration webhooks
   * postCreate integration webhook
   * getRetrieve integration webhook
   * putUpdate integration webhook
   * patchPartially update integration webhook
   * delDelete integration webhook
   * getList rate pairs
   * postCreate rate pair
   * getRetrieve rate pair
   * putUpdate rate pair
   * patchPartially update rate pair
   * delDelete rate pair
   * getList users
   * getRetrieve user
   * putUpdate user
   * patchPartially update user
 * deactivate
   * postDeactivate service
 * user
   * getList conversion pairs
   * getRetrieve conversion pair
   * getList conversions
   * postCreate conversion
   * getRetrieve conversion
   * putUpdate conversion
   * patchPartially update conversion
   * getList currencies
   * getRetrieve currency
   * getList rates
   * getRetrieve rate
   * getRetrieve rate snapshot
   * getList rate snapshots
   * getRetrieve user settings
   * putUpdate user settings
   * patchPartially update user settings
 * webhook
   * postReceive Platform webhook

API docs by Redocly



CONVERSION SERVICE API (1 (1))

Download OpenAPI specification:Download

Rehive Support: support@rehive.com URL: https://rehive.com/support/ Terms of
Service


The Conversion Service API is used for currency rates and conversions in Rehive.

Docs portal


ACTIVATE


ACTIVATE SERVICE

AUTHORIZATIONS:

None

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



token
required
string



RESPONSES

200
post/activate/
https://conversion.services.rehive.com/api/activate/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "token": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}


ADMIN


RETRIEVE COMPANY

AUTHORIZATIONS:

apiAuth


RESPONSES

200
get/admin/company/
https://conversion.services.rehive.com/api/admin/company/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
    * "name": "string",
    * "display_currency": "string",
    * "operational_account": "string"
   
   }

}


UPDATE COMPANY

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



display_currency
string

operational_account
string or null



RESPONSES

200
put/admin/company/
https://conversion.services.rehive.com/api/admin/company/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "display_currency": "string",
 * "operational_account": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
    * "name": "string",
    * "display_currency": "string",
    * "operational_account": "string"
   
   }

}


PARTIALLY UPDATE COMPANY

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



display_currency
string

operational_account
string or null



RESPONSES

200
patch/admin/company/
https://conversion.services.rehive.com/api/admin/company/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "display_currency": "string",
 * "operational_account": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
    * "name": "string",
    * "display_currency": "string",
    * "operational_account": "string"
   
   }

}


LIST CONVERSION PAIRS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

id
integer

key
string

key__in
Array of strings

Multiple values may be separated by commas.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.


RESPONSES

200
get/admin/conversion-pairs/
https://conversion.services.rehive.com/api/admin/conversion-pairs/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "key": "string",
          * "path": "string",
          * "rate": "string",
          * "operational_account": "string",
          * "quote_duration": 1,
          * "enabled": true,
          * "created": 0,
          * "updated": 0,
          * "integration": {
             * "id": "string",
             * "slug": "string",
             * "name": "string",
             * "description": "string",
             * "created": 0,
             * "updated": 0,
             * "events": [
                * "conversion.quote"
               
               ]
            
            },
          * "transaction_type": "operational"
         
         }
      
      ]
   
   }

}


CREATE CONVERSION PAIR

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



key
required
string

path
string or null

rate
string or null <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$

operational_account
string or null

quote_duration
integer >= 1

enabled
boolean

integration
string or null

transaction_type
string
Enum: "operational" "non_operational"
 * operational - Operational
 * non_operational - Non Operational


RESPONSES

201
post/admin/conversion-pairs/
https://conversion.services.rehive.com/api/admin/conversion-pairs/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "key": "string",
 * "path": "string",
 * "rate": "string",
 * "operational_account": "string",
 * "quote_duration": 1,
 * "enabled": true,
 * "integration": "string",
 * "transaction_type": "operational"

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "path": "string",
    * "rate": "string",
    * "operational_account": "string",
    * "quote_duration": 1,
    * "enabled": true,
    * "created": 0,
    * "updated": 0,
    * "integration": {
       * "id": "string",
       * "slug": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0,
       * "events": [
          * "conversion.quote"
         
         ]
      
      },
    * "transaction_type": "operational"
   
   }

}


RETRIEVE CONVERSION PAIR

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/admin/conversion-pairs/{identifier}/
https://conversion.services.rehive.com/api/admin/conversion-pairs/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "path": "string",
    * "rate": "string",
    * "operational_account": "string",
    * "quote_duration": 1,
    * "enabled": true,
    * "created": 0,
    * "updated": 0,
    * "integration": {
       * "id": "string",
       * "slug": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0,
       * "events": [
          * "conversion.quote"
         
         ]
      
      },
    * "transaction_type": "operational"
   
   }

}


UPDATE CONVERSION PAIR

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



path
string or null

rate
string or null <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$

operational_account
string or null

quote_duration
integer >= 1

enabled
boolean

integration
object (AdminIntegration)

A ModelSerializer that takes additional arguments for "fields", "omit" and
"expand" in order to control which fields are displayed, and whether to replace
simple values with complex, nested serializations

transaction_type
string
Enum: "operational" "non_operational"
 * operational - Operational
 * non_operational - Non Operational


RESPONSES

200
put/admin/conversion-pairs/{identifier}/
https://conversion.services.rehive.com/api/admin/conversion-pairs/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
 * "path": "string",
 * "rate": "string",
 * "operational_account": "string",
 * "quote_duration": 1,
 * "enabled": true,
 * "integration": {
    * "slug": "string",
    * "name": "string",
    * "description": "string"
   
   },
 * "transaction_type": "operational"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "path": "string",
    * "rate": "string",
    * "operational_account": "string",
    * "quote_duration": 1,
    * "enabled": true,
    * "created": 0,
    * "updated": 0,
    * "integration": {
       * "id": "string",
       * "slug": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0,
       * "events": [
          * "conversion.quote"
         
         ]
      
      },
    * "transaction_type": "operational"
   
   }

}


PARTIALLY UPDATE CONVERSION PAIR

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



path
string or null

rate
string or null <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$

operational_account
string or null

quote_duration
integer >= 1

enabled
boolean

integration
string or null

transaction_type
string
Enum: "operational" "non_operational"
 * operational - Operational
 * non_operational - Non Operational


RESPONSES

200
patch/admin/conversion-pairs/{identifier}/
https://conversion.services.rehive.com/api/admin/conversion-pairs/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "path": "string",
 * "rate": "string",
 * "operational_account": "string",
 * "quote_duration": 1,
 * "enabled": true,
 * "integration": "string",
 * "transaction_type": "operational"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "path": "string",
    * "rate": "string",
    * "operational_account": "string",
    * "quote_duration": 1,
    * "enabled": true,
    * "created": 0,
    * "updated": 0,
    * "integration": {
       * "id": "string",
       * "slug": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0,
       * "events": [
          * "conversion.quote"
         
         ]
      
      },
    * "transaction_type": "operational"
   
   }

}


DELETE CONVERSION PAIR

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
delete/admin/conversion-pairs/{identifier}/
https://conversion.services.rehive.com/api/admin/conversion-pairs/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "path": "string",
    * "rate": "string",
    * "operational_account": "string",
    * "quote_duration": 1,
    * "enabled": true,
    * "created": 0,
    * "updated": 0,
    * "integration": {
       * "id": "string",
       * "slug": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0,
       * "events": [
          * "conversion.quote"
         
         ]
      
      },
    * "transaction_type": "operational"
   
   }

}


LIST CONVERSIONS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

created
string

created__gt
string

created__gte
string

created__lt
string

created__lte
string

id
integer

key
string

key__in
Array of strings

Multiple values may be separated by commas.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

status
string

user
string



RESPONSES

200
get/admin/conversions/
https://conversion.services.rehive.com/api/admin/conversions/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "user": "string",
          * "key": "string",
          * "from_amount": 0,
          * "from_fee": 0,
          * "from_total_amount": 0,
          * "to_amount": 0,
          * "to_fee": 0,
          * "to_total_amount": 0,
          * "rate": "string",
          * "debit_account": "string",
          * "credit_account": "string",
          * "operational_account": "string",
          * "status": "quoted",
          * "collection": "string",
          * "txns": [
             * "string"
            
            ],
          * "metadata": {
             * "property1": null,
             * "property2": null
            
            },
          * "expires": 0,
          * "created": 0,
          * "updated": 0
         
         }
      
      ]
   
   }

}


CREATE CONVERSION

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



key
required
string

user
required
string

from_amount
integer or null

to_amount
integer or null

rate
string or null <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$

debit_account
string or null <= 64 characters

credit_account
string or null <= 64 characters

metadata
object or null

quote_duration
integer or null



RESPONSES

201
post/admin/conversions/
https://conversion.services.rehive.com/api/admin/conversions/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
 * "user": "string",
 * "key": "string",
 * "from_amount": 0,
 * "to_amount": 0,
 * "rate": "string",
 * "debit_account": "string",
 * "credit_account": "string",
 * "metadata": {
    * "property1": null,
    * "property2": null
   
   },
 * "quote_duration": 0

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "user": "string",
    * "key": "string",
    * "from_amount": 0,
    * "from_fee": 0,
    * "from_total_amount": 0,
    * "to_amount": 0,
    * "to_fee": 0,
    * "to_total_amount": 0,
    * "rate": "string",
    * "debit_account": "string",
    * "credit_account": "string",
    * "operational_account": "string",
    * "status": "quoted",
    * "collection": "string",
    * "txns": [
       * "string"
      
      ],
    * "metadata": {
       * "property1": null,
       * "property2": null
      
      },
    * "expires": 0,
    * "created": 0,
    * "updated": 0
   
   }

}


RETRIEVE CONVERSION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/admin/conversions/{identifier}/
https://conversion.services.rehive.com/api/admin/conversions/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "user": "string",
    * "key": "string",
    * "from_amount": 0,
    * "from_fee": 0,
    * "from_total_amount": 0,
    * "to_amount": 0,
    * "to_fee": 0,
    * "to_total_amount": 0,
    * "rate": "string",
    * "debit_account": "string",
    * "credit_account": "string",
    * "operational_account": "string",
    * "status": "quoted",
    * "collection": "string",
    * "txns": [
       * "string"
      
      ],
    * "metadata": {
       * "property1": null,
       * "property2": null
      
      },
    * "expires": 0,
    * "created": 0,
    * "updated": 0
   
   }

}


UPDATE CONVERSION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



status
required
string
Enum: "quoted" "pending" "complete" "failed"
 * quoted - Quoted
 * pending - Pending
 * complete - Complete
 * failed - Failed

rate
string <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$



RESPONSES

200
put/admin/conversions/{identifier}/
https://conversion.services.rehive.com/api/admin/conversions/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "rate": "string",
 * "status": "quoted"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "user": "string",
    * "key": "string",
    * "from_amount": 0,
    * "from_fee": 0,
    * "from_total_amount": 0,
    * "to_amount": 0,
    * "to_fee": 0,
    * "to_total_amount": 0,
    * "rate": "string",
    * "debit_account": "string",
    * "credit_account": "string",
    * "operational_account": "string",
    * "status": "quoted",
    * "collection": "string",
    * "txns": [
       * "string"
      
      ],
    * "metadata": {
       * "property1": null,
       * "property2": null
      
      },
    * "expires": 0,
    * "created": 0,
    * "updated": 0
   
   }

}


PARTIALLY UPDATE CONVERSION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



rate
string <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$

status
string
Enum: "quoted" "pending" "complete" "failed"
 * quoted - Quoted
 * pending - Pending
 * complete - Complete
 * failed - Failed


RESPONSES

200
patch/admin/conversions/{identifier}/
https://conversion.services.rehive.com/api/admin/conversions/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "rate": "string",
 * "status": "quoted"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "user": "string",
    * "key": "string",
    * "from_amount": 0,
    * "from_fee": 0,
    * "from_total_amount": 0,
    * "to_amount": 0,
    * "to_fee": 0,
    * "to_total_amount": 0,
    * "rate": "string",
    * "debit_account": "string",
    * "credit_account": "string",
    * "operational_account": "string",
    * "status": "quoted",
    * "collection": "string",
    * "txns": [
       * "string"
      
      ],
    * "metadata": {
       * "property1": null,
       * "property2": null
      
      },
    * "expires": 0,
    * "created": 0,
    * "updated": 0
   
   }

}


LIST CURRENCIES

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

code
string

code__in
Array of strings

Multiple values may be separated by commas.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

unit
string



RESPONSES

200
get/admin/currencies/
https://conversion.services.rehive.com/api/admin/currencies/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "code": "string",
          * "display_code": "string",
          * "description": "string",
          * "symbol": "string",
          * "unit": "string",
          * "divisibility": -2147483648,
          * "archived": true
         
         }
      
      ]
   
   }

}


CREATE CURRENCY

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



code
required
string <= 30 characters

display_code
string or null <= 12 characters

description
string or null <= 255 characters

symbol
string or null <= 30 characters

unit
string or null <= 30 characters

divisibility
integer [ -2147483648 .. 2147483647 ]

archived
boolean



RESPONSES

201
post/admin/currencies/
https://conversion.services.rehive.com/api/admin/currencies/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "code": "string",
 * "display_code": "string",
 * "description": "string",
 * "symbol": "string",
 * "unit": "string",
 * "divisibility": -2147483648,
 * "archived": true

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "code": "string",
    * "display_code": "string",
    * "description": "string",
    * "symbol": "string",
    * "unit": "string",
    * "divisibility": -2147483648,
    * "archived": true
   
   }

}


RETRIEVE CURRENCY

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

code
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/admin/currencies/{code}/
https://conversion.services.rehive.com/api/admin/currencies/{code}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "code": "string",
    * "display_code": "string",
    * "description": "string",
    * "symbol": "string",
    * "unit": "string",
    * "divisibility": -2147483648,
    * "archived": true
   
   }

}


UPDATE CURRENCY

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

code
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



code
required
string <= 30 characters

display_code
string or null <= 12 characters

description
string or null <= 255 characters

symbol
string or null <= 30 characters

unit
string or null <= 30 characters

divisibility
integer [ -2147483648 .. 2147483647 ]

archived
boolean



RESPONSES

200
put/admin/currencies/{code}/
https://conversion.services.rehive.com/api/admin/currencies/{code}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "code": "string",
 * "display_code": "string",
 * "description": "string",
 * "symbol": "string",
 * "unit": "string",
 * "divisibility": -2147483648,
 * "archived": true

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "code": "string",
    * "display_code": "string",
    * "description": "string",
    * "symbol": "string",
    * "unit": "string",
    * "divisibility": -2147483648,
    * "archived": true
   
   }

}


PARTIALLY UPDATE CURRENCY

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

code
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



code
string <= 30 characters

display_code
string or null <= 12 characters

description
string or null <= 255 characters

symbol
string or null <= 30 characters

unit
string or null <= 30 characters

divisibility
integer [ -2147483648 .. 2147483647 ]

archived
boolean



RESPONSES

200
patch/admin/currencies/{code}/
https://conversion.services.rehive.com/api/admin/currencies/{code}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "code": "string",
 * "display_code": "string",
 * "description": "string",
 * "symbol": "string",
 * "unit": "string",
 * "divisibility": -2147483648,
 * "archived": true

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "code": "string",
    * "display_code": "string",
    * "description": "string",
    * "symbol": "string",
    * "unit": "string",
    * "divisibility": -2147483648,
    * "archived": true
   
   }

}


LIST INTEGRATION

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.


RESPONSES

200
get/admin/integrations/
https://conversion.services.rehive.com/api/admin/integrations/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "slug": "string",
          * "name": "string",
          * "description": "string",
          * "created": 0,
          * "updated": 0,
          * "events": [
             * "conversion.quote"
            
            ]
         
         }
      
      ]
   
   }

}


CREATE INTEGRATION

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



name
required
string <= 50 characters

slug
required
string <= 50 characters

description
string or null <= 255 characters



RESPONSES

201
post/admin/integrations/
https://conversion.services.rehive.com/api/admin/integrations/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "slug": "string",
 * "name": "string",
 * "description": "string"

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "slug": "string",
    * "name": "string",
    * "description": "string",
    * "created": 0,
    * "updated": 0,
    * "events": [
       * "conversion.quote"
      
      ]
   
   }

}


RETRIEVE INTEGRATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/admin/integrations/{identifier}/
https://conversion.services.rehive.com/api/admin/integrations/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "slug": "string",
    * "name": "string",
    * "description": "string",
    * "created": 0,
    * "updated": 0,
    * "events": [
       * "conversion.quote"
      
      ]
   
   }

}


UPDATE INTEGRATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



name
required
string <= 50 characters

slug
required
string <= 50 characters

description
string or null <= 255 characters



RESPONSES

200
put/admin/integrations/{identifier}/
https://conversion.services.rehive.com/api/admin/integrations/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "slug": "string",
 * "name": "string",
 * "description": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "slug": "string",
    * "name": "string",
    * "description": "string",
    * "created": 0,
    * "updated": 0,
    * "events": [
       * "conversion.quote"
      
      ]
   
   }

}


PARTIALLY UPDATE INTEGRATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



slug
string <= 50 characters

name
string <= 50 characters

description
string or null <= 255 characters



RESPONSES

200
patch/admin/integrations/{identifier}/
https://conversion.services.rehive.com/api/admin/integrations/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "slug": "string",
 * "name": "string",
 * "description": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "slug": "string",
    * "name": "string",
    * "description": "string",
    * "created": 0,
    * "updated": 0,
    * "events": [
       * "conversion.quote"
      
      ]
   
   }

}


DELETE INTEGRATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
delete/admin/integrations/{identifier}/
https://conversion.services.rehive.com/api/admin/integrations/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "slug": "string",
    * "name": "string",
    * "description": "string",
    * "created": 0,
    * "updated": 0,
    * "events": [
       * "conversion.quote"
      
      ]
   
   }

}


LIST INTEGRATION WEBHOOKS

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


QUERY PARAMETERS

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.


RESPONSES

200
get/admin/integrations/{identifier}/webhooks/
https://conversion.services.rehive.com/api/admin/integrations/{identifier}/webhooks/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "url": "http://example.com",
          * "event": "conversion.quote",
          * "secret": "string",
          * "created": 0,
          * "updated": 0
         
         }
      
      ]
   
   }

}


CREATE INTEGRATION WEBHOOK

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



event
required
string
Enum: "conversion.quote" "conversion.execute"
 * conversion.quote - conversion.quote
 * conversion.execute - conversion.execute

url
required
string <uri>

secret
string <= 250 characters



RESPONSES

201
post/admin/integrations/{identifier}/webhooks/
https://conversion.services.rehive.com/api/admin/integrations/{identifier}/webhooks/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "url": "http://example.com",
 * "event": "conversion.quote",
 * "secret": "string"

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "url": "http://example.com",
    * "event": "conversion.quote",
    * "secret": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


RETRIEVE INTEGRATION WEBHOOK

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

integration_id
required
string^([a-zA-Z0-9\_\-]+)$

webhook_id
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/admin/integrations/{integration_id}/webhooks/{webhook_id}/
https://conversion.services.rehive.com/api/admin/integrations/{integration_id}/webhooks/{webhook_id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "url": "http://example.com",
    * "event": "conversion.quote",
    * "secret": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


UPDATE INTEGRATION WEBHOOK

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

integration_id
required
string^([a-zA-Z0-9\_\-]+)$

webhook_id
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



event
required
string
Enum: "conversion.quote" "conversion.execute"
 * conversion.quote - conversion.quote
 * conversion.execute - conversion.execute

url
required
string <uri>

secret
string <= 250 characters



RESPONSES

200
put/admin/integrations/{integration_id}/webhooks/{webhook_id}/
https://conversion.services.rehive.com/api/admin/integrations/{integration_id}/webhooks/{webhook_id}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "url": "http://example.com",
 * "event": "conversion.quote",
 * "secret": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "url": "http://example.com",
    * "event": "conversion.quote",
    * "secret": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


PARTIALLY UPDATE INTEGRATION WEBHOOK

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

integration_id
required
string^([a-zA-Z0-9\_\-]+)$

webhook_id
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



url
string <uri>

event
string
Enum: "conversion.quote" "conversion.execute"
 * conversion.quote - conversion.quote
 * conversion.execute - conversion.execute

secret
string <= 250 characters



RESPONSES

200
patch/admin/integrations/{integration_id}/webhooks/{webhook_id}/
https://conversion.services.rehive.com/api/admin/integrations/{integration_id}/webhooks/{webhook_id}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "url": "http://example.com",
 * "event": "conversion.quote",
 * "secret": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "url": "http://example.com",
    * "event": "conversion.quote",
    * "secret": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


DELETE INTEGRATION WEBHOOK

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

integration_id
required
string^([a-zA-Z0-9\_\-]+)$

webhook_id
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
delete/admin/integrations/{integration_id}/webhooks/{webhook_id}/
https://conversion.services.rehive.com/api/admin/integrations/{integration_id}/webhooks/{webhook_id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "url": "http://example.com",
    * "event": "conversion.quote",
    * "secret": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


LIST RATE PAIRS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

id
integer

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.


RESPONSES

200
get/admin/rate-pairs/
https://conversion.services.rehive.com/api/admin/rate-pairs/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "key": "string",
          * "path": "string",
          * "rate": "string",
          * "created": 0,
          * "updated": 0
         
         }
      
      ]
   
   }

}


CREATE RATE PAIR

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



key
required
string

path
string or null

rate
string or null <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$



RESPONSES

201
post/admin/rate-pairs/
https://conversion.services.rehive.com/api/admin/rate-pairs/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "key": "string",
 * "path": "string",
 * "rate": "string"

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "path": "string",
    * "rate": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


RETRIEVE RATE PAIR

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/admin/rate-pairs/{identifier}/
https://conversion.services.rehive.com/api/admin/rate-pairs/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "path": "string",
    * "rate": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


UPDATE RATE PAIR

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



path
string or null

rate
string or null <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$



RESPONSES

200
put/admin/rate-pairs/{identifier}/
https://conversion.services.rehive.com/api/admin/rate-pairs/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "path": "string",
 * "rate": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "path": "string",
    * "rate": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


PARTIALLY UPDATE RATE PAIR

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



path
string or null

rate
string or null <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$



RESPONSES

200
patch/admin/rate-pairs/{identifier}/
https://conversion.services.rehive.com/api/admin/rate-pairs/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "path": "string",
 * "rate": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "path": "string",
    * "rate": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


DELETE RATE PAIR

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
delete/admin/rate-pairs/{identifier}/
https://conversion.services.rehive.com/api/admin/rate-pairs/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "path": "string",
    * "rate": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


LIST USERS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

display_currency
string

display_currency__in
Array of strings

Multiple values may be separated by commas.

id
integer

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.


RESPONSES

200
get/admin/users/
https://conversion.services.rehive.com/api/admin/users/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "display_currency": "string"
         
         }
      
      ]
   
   }

}


RETRIEVE USER

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/admin/users/{identifier}/
https://conversion.services.rehive.com/api/admin/users/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "display_currency": "string"
   
   }

}


UPDATE USER

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



display_currency
string or null <= 12 characters



RESPONSES

200
put/admin/users/{identifier}/
https://conversion.services.rehive.com/api/admin/users/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "display_currency": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "display_currency": "string"
   
   }

}


PARTIALLY UPDATE USER

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



display_currency
string or null <= 12 characters



RESPONSES

200
patch/admin/users/{identifier}/
https://conversion.services.rehive.com/api/admin/users/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "display_currency": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "display_currency": "string"
   
   }

}


DEACTIVATE


DEACTIVATE SERVICE

AUTHORIZATIONS:

None

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



token
required
string

purge
boolean
Default: false



RESPONSES

200
post/deactivate/
https://conversion.services.rehive.com/api/deactivate/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "token": "string",
 * "purge": false

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}


USER


LIST CONVERSION PAIRS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

id
integer

key
string

key__in
Array of strings

Multiple values may be separated by commas.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.


RESPONSES

200
get/user/conversion-pairs/
https://conversion.services.rehive.com/api/user/conversion-pairs/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "key": "string",
          * "created": 0,
          * "updated": 0
         
         }
      
      ]
   
   }

}


RETRIEVE CONVERSION PAIR

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/user/conversion-pairs/{identifier}/
https://conversion.services.rehive.com/api/user/conversion-pairs/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


LIST CONVERSIONS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

created
string

created__gt
string

created__gte
string

created__lt
string

created__lte
string

id
integer

key
string

key__in
Array of strings

Multiple values may be separated by commas.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

status
string



RESPONSES

200
get/user/conversions/
https://conversion.services.rehive.com/api/user/conversions/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "key": "string",
          * "from_amount": 0,
          * "from_fee": 0,
          * "from_total_amount": 0,
          * "to_amount": 0,
          * "to_fee": 0,
          * "to_total_amount": 0,
          * "rate": "string",
          * "debit_account": "string",
          * "credit_account": "string",
          * "status": "quoted",
          * "collection": "string",
          * "txns": [
             * "string"
            
            ],
          * "metadata": {
             * "property1": null,
             * "property2": null
            
            },
          * "expires": 0,
          * "created": 0,
          * "updated": 0
         
         }
      
      ]
   
   }

}


CREATE CONVERSION

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



key
required
string

from_amount
integer or null

to_amount
integer or null

debit_account
string or null <= 64 characters

credit_account
string or null <= 64 characters

metadata
object or null



RESPONSES

201
post/user/conversions/
https://conversion.services.rehive.com/api/user/conversions/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
 * "key": "string",
 * "from_amount": 0,
 * "to_amount": 0,
 * "debit_account": "string",
 * "credit_account": "string",
 * "metadata": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "from_amount": 0,
    * "from_fee": 0,
    * "from_total_amount": 0,
    * "to_amount": 0,
    * "to_fee": 0,
    * "to_total_amount": 0,
    * "rate": "string",
    * "debit_account": "string",
    * "credit_account": "string",
    * "status": "quoted",
    * "collection": "string",
    * "txns": [
       * "string"
      
      ],
    * "metadata": {
       * "property1": null,
       * "property2": null
      
      },
    * "expires": 0,
    * "created": 0,
    * "updated": 0
   
   }

}


RETRIEVE CONVERSION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/user/conversions/{identifier}/
https://conversion.services.rehive.com/api/user/conversions/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "from_amount": 0,
    * "from_fee": 0,
    * "from_total_amount": 0,
    * "to_amount": 0,
    * "to_fee": 0,
    * "to_total_amount": 0,
    * "rate": "string",
    * "debit_account": "string",
    * "credit_account": "string",
    * "status": "quoted",
    * "collection": "string",
    * "txns": [
       * "string"
      
      ],
    * "metadata": {
       * "property1": null,
       * "property2": null
      
      },
    * "expires": 0,
    * "created": 0,
    * "updated": 0
   
   }

}


UPDATE CONVERSION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



status
required
string
Enum: "quoted" "pending" "complete" "failed"
 * quoted - Quoted
 * pending - Pending
 * complete - Complete
 * failed - Failed


RESPONSES

200
put/user/conversions/{identifier}/
https://conversion.services.rehive.com/api/user/conversions/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "status": "quoted"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "from_amount": 0,
    * "from_fee": 0,
    * "from_total_amount": 0,
    * "to_amount": 0,
    * "to_fee": 0,
    * "to_total_amount": 0,
    * "rate": "string",
    * "debit_account": "string",
    * "credit_account": "string",
    * "status": "quoted",
    * "collection": "string",
    * "txns": [
       * "string"
      
      ],
    * "metadata": {
       * "property1": null,
       * "property2": null
      
      },
    * "expires": 0,
    * "created": 0,
    * "updated": 0
   
   }

}


PARTIALLY UPDATE CONVERSION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



status
string
Enum: "quoted" "pending" "complete" "failed"
 * quoted - Quoted
 * pending - Pending
 * complete - Complete
 * failed - Failed


RESPONSES

200
patch/user/conversions/{identifier}/
https://conversion.services.rehive.com/api/user/conversions/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "status": "quoted"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "from_amount": 0,
    * "from_fee": 0,
    * "from_total_amount": 0,
    * "to_amount": 0,
    * "to_fee": 0,
    * "to_total_amount": 0,
    * "rate": "string",
    * "debit_account": "string",
    * "credit_account": "string",
    * "status": "quoted",
    * "collection": "string",
    * "txns": [
       * "string"
      
      ],
    * "metadata": {
       * "property1": null,
       * "property2": null
      
      },
    * "expires": 0,
    * "created": 0,
    * "updated": 0
   
   }

}


LIST CURRENCIES

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

code
string

code__in
Array of strings

Multiple values may be separated by commas.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

unit
string



RESPONSES

200
get/user/currencies/
https://conversion.services.rehive.com/api/user/currencies/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "code": "string",
          * "display_code": "string",
          * "description": "string",
          * "symbol": "string",
          * "unit": "string",
          * "divisibility": -2147483648
         
         }
      
      ]
   
   }

}


RETRIEVE CURRENCY

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

code
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/user/currencies/{code}/
https://conversion.services.rehive.com/api/user/currencies/{code}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "code": "string",
    * "display_code": "string",
    * "description": "string",
    * "symbol": "string",
    * "unit": "string",
    * "divisibility": -2147483648
   
   }

}


LIST RATES

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

created
string

created__gt
string

created__gte
string

created__lt
string

created__lte
string

id
integer

key
string

key__in
Array of strings

Multiple values may be separated by commas.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.


RESPONSES

200
get/user/rates/
https://conversion.services.rehive.com/api/user/rates/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "key": "string",
          * "rate": "string",
          * "created": 0
         
         }
      
      ]
   
   }

}


RETRIEVE RATE

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^\w+$



RESPONSES

200
get/user/rates/{identifier}/
https://conversion.services.rehive.com/api/user/rates/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "key": "string",
    * "rate": "string",
    * "created": 0
   
   }

}


RETRIEVE RATE SNAPSHOT

AUTHORIZATIONS:

apiAuth


RESPONSES

200
get/user/rates/snapshot/
https://conversion.services.rehive.com/api/user/rates/snapshot/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "rates": {
       * "property1": {
          * "rate": "string",
          * "created": 0
         
         },
       * "property2": {
          * "rate": "string",
          * "created": 0
         
         }
      
      }
   
   }

}


LIST RATE SNAPSHOTS

AUTHORIZATIONS:

apiAuth


RESPONSES

200
get/user/rates/snapshots/
https://conversion.services.rehive.com/api/user/rates/snapshots/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": [
    * {
       * "key": "string",
       * "date": 0,
       * "rate": {
          * "id": "string",
          * "key": "string",
          * "rate": "string",
          * "created": 0
         
         }
      
      }
   
   ]

}


RETRIEVE USER SETTINGS

AUTHORIZATIONS:

apiAuth


RESPONSES

200
get/user/settings/
https://conversion.services.rehive.com/api/user/settings/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "display_currency": "string"
   
   }

}


UPDATE USER SETTINGS

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



display_currency
string or null



RESPONSES

200
put/user/settings/
https://conversion.services.rehive.com/api/user/settings/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "display_currency": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "display_currency": "string"
   
   }

}


PARTIALLY UPDATE USER SETTINGS

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



display_currency
string or null



RESPONSES

200
patch/user/settings/
https://conversion.services.rehive.com/api/user/settings/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "display_currency": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "display_currency": "string"
   
   }

}


WEBHOOK


RECEIVE PLATFORM WEBHOOK

AUTHORIZATIONS:

None

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



company
required
string

data
required
object

event
required
string
Enum: "currency.create" "currency.update" "transaction.execute"
 * currency.create - currency.create
 * currency.update - currency.update
 * transaction.execute - transaction.execute

id
required
string



RESPONSES

200
post/webhook/
https://conversion.services.rehive.com/api/webhook/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
 * "id": "string",
 * "event": "currency.create",
 * "company": "string",
 * "data": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}
conversion.services.rehive.io Open in urlscan Pro 2606:4700:10::ac43:2857 Public Scan

Form analysis 0 forms found in the DOM

Text Content

conversion.services.rehive.io Open in urlscan Pro
2606:4700:10::ac43:2857 Public Scan

Form analysis
0 forms found in the DOM
