Create checkout

POST 
/checkout

Creates a new checkout that can be used to facilitate payment for merchants.

info

x-sideshift-secret is your account's private key.

Request

Header Parameters

x-sideshift-secret stringrequired
x-user-ip stringrequired

end-user IP address for integrations API requests

application/json

Body

settleCoin stringrequired
settleNetwork stringrequired
settleAmount stringrequired
settleAddress stringrequired
settleMemo string

for coins that hasMemo is true

affiliateId stringrequired
successUrl stringrequired
cancelUrl stringrequired

Responses

201

OK

application/json

Schema

Schema

id stringrequired

unique checkout ID

settleCoin stringrequired
settleNetwork stringrequired
settleAddress stringrequired
settleMemo string
settleAmount stringrequired
updatedAt date-timerequired
createdAt date-timerequired
affiliateId stringrequired
successUrl stringrequired
cancelUrl stringrequired

Example

{
  "id": "32e676d3-56c2-4c06-a0cd-551a9d3db89a",
  "settleCoin": "XRP",
  "settleNetwork": "ripple",
  "settleAddress": "rsTAYkk7VQfBdD5btt2WzXYphER6F2BTuN",
  "settleMemo": "109",
  "settleAmount": "15",
  "updatedAt": "2024-09-26T01:52:56.885000000Z",
  "createdAt": "2024-09-26T01:52:56.885000000Z",
  "affiliateId": "YQMi62XMb"
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel"
}

400

Bad request

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Method ETH/bitcoin not found"
  }
}

{
  "error": {
      "message": "Invalid "affiliateId""
  }
}

{
  "error": {
      "message": "Settle amount too high"
  }
}

{
  "error": {
      "message": "Settle amount too low"
  }
}

{
  "error": {
      "message": "Invalid settleAmount"
  }
}

{
  "error": {
      "message": "Invalid url format"
  }
}

401

Unauthorized

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Do not use the example affiliateId and x-sideshift-secret header from the documentation. Use your own from https://sideshift.ai/account"
  }
}

403

Forbidden

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Access denied. See https://sideshift.ai/access-denied"
  }
}

404

Not Found

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Account not found"
  }
}

500

Internal Server Error

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Invalid coin"
  }
}

Loading...