To access the SwapSpace API you need to register by the link:https://swapspace.co/affiliate. Our new partners will be permitted to execute a limited number of requests by default. To remove the restriction and get into the white list, leave an application by e-mail partners@swapspace.co. Each API method is to be signed with the API key. In all requests, the API key will be passed to the Authorization header.
1. The first thing to do is to implement the List of currencies endpoint since it contains the required data about supported currencies that is essential for Estimated exchange amounts and Create new exchange endpoints. You can find examples for all the mentioned endpoints in the Example response section.
2. Next, implement the List of partners endpoint that returns data about the partners that provide the exchange options. Without partner data, you can’t use the Estimated exchange amounts and Create new exchange endpoints.
3. To get the list of current amounts for a specific exchange pair, provided by partners, use the Estimated exchange amounts endpoint. Note that this endpoint has five required and three optional parameters. If you use only five required parameters, namely fromCurrency, fromNetwork, toCurrency, toNetwork, and amount, you will get the list of all the available amounts for all the partners. Add the partner parameter to get the amounts for a specific partner (max. two amounts: for fixed and floating exchange rates). Adding the parameter fixed with the value true to the request will return the amounts only for fixed rate exchanges. The float parameter behaves the same way as fixed. Pay attention to the min and max fields. You can’t create the exchange in case the value is not in the valid range between min and max. Value 0 in min or max fields means that there is no such range limit. For some amounts, it returns the value id, which is valid for 2 minutes and is necessary for successful exchange creation.
4. Next, you need to implement the exchange creation via the Create new exchange endpoint. All the fields mentioned in body are required.
Field extraId is required only if the currency you want to receive has hasExtraId: true property (you get this info via the List of currencies endpoint). If hasExtraId: false, use empty string in the extraId field. Fill in the rateId field with the id field value of the required amount from the list of amounts of the Estimated exchange amounts endpoint. If the id field of the Estimated exchange amounts is empty, fill in rateId with an empty string. Fill in the userIp field with the user’s IP in IPv4 or IPv6 formats. Refund field is required if fixed: true and reqFixedRefund: true for relevant partner and float: true and reqFloatRefund: true for relevant partner (look List of partners example response). But we strongly recommend that you specify refund when creating an exchange, even if it is not required (if a refund is not required or you cannot specify it, then it is permissible to use a refund: '').
5. Use the Exchange status endpoint to get the current exchange status. As a request data, use path parameter id, which is to be filled in with exchange id you get with the other data for the successful Create new exchange request.