Skip to main content
POST
/
order
/
create
Create an exchange order
curl --request POST \
  --url https://api.privataswap.com/partner/v1/order/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "quote_id": "<string>",
  "address": "<string>",
  "extra_id": "<string>",
  "refund_address": "<string>",
  "refund_extra_id": "<string>",
  "refund_preference": {
    "default": "return_to_refund_address",
    "fallback_if_refund_address_missing": "manual_review"
  },
  "partner_order_ref": "<string>"
}
'
{
  "order_id": "prv-9f0e...",
  "provider_order_id": "<string>",
  "from": "<string>",
  "to": "<string>",
  "amount_from": "<string>",
  "amount_to_expected": "<string>",
  "amount_to_actual": "<string>",
  "deposit_address": "<string>",
  "deposit_extra_id": "<string>",
  "payout_address": "<string>",
  "failed_reason_message": "<string>",
  "refund_window_hours": 123,
  "refund_sla_hours": 123,
  "tx_in_hash": "<string>",
  "tx_out_hash": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "tracking_url": "<string>",
  "timeline": [
    {
      "status": "<string>",
      "at": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.privataswap.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Partner API key issued in the dashboard. Use pk_live_... in production, pk_test_... against sandbox.

Body

application/json
​
quote_id
string
required
​
address
string
required

Payout address.

​
extra_id
string | null

Memo for XRP/XLM/TON.

​
refund_address
string | null
​
refund_extra_id
string | null
​
refund_preference
object
​
partner_order_ref
string

Your internal id. Returned back in webhooks. Used for logical-dupe detection.

Response

Created

​
order_id
string
Example:

"prv-9f0e..."

​
provider_order_id
string
​
from
string
​
to
string
​
amount_from
string
​
amount_to_expected
string
​
amount_to_actual
string | null
​
deposit_address
string
​
deposit_extra_id
string | null
​
payout_address
string
​
status
enum<string>
Available options:
waiting_deposit,
confirming,
exchanging,
sending,
completed,
failed,
expired,
refund_required,
refunded,
manual_review
​
failed_reason_code
enum<string> | null
Available options:
kyt_block,
amount_out_of_range,
rate_changed,
provider_timeout,
provider_internal,
underpayment,
overpayment,
network_congestion,
unknown
​
failed_reason_message
string | null
​
refund_capability
enum<string>
Available options:
programmatic,
ticket,
none
​
refund_window_hours
integer | null
​
refund_sla_hours
integer | null
​
tx_in_hash
string | null
​
tx_out_hash
string | null
​
expires_at
string<date-time>
​
created_at
string<date-time>
​
tracking_url
string<uri>

Signed URL with embedded HMAC token. Do not modify.

​
timeline
object[]