POST
/
crypto_return_policies
Create a new crypto return policy
curl --request POST \
  --url https://api.bridge.xyz/v0/crypto_return_policies \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "refund_destination_address": "<string>",
  "refund_destination_blockchain_memo": "<string>",
  "refund_destination_chain": "<string>",
  "refund_destination_currency": "<string>",
  "strategy": "<string>"
}'
{
  "id": "<string>",
  "developer_id": "<string>",
  "refund_destination_address": "<string>",
  "refund_destination_blockchain_memo": "<string>",
  "refund_destination_chain": "<string>",
  "refund_destination_currency": "<string>",
  "strategy": "<string>"
}

Authorizations

​
Api-Key
string
header
required

Headers

​
Idempotency-Key
string
required

Body

application/json

Crypto return policy object to be created

​
refund_destination_address
string

The address to which the refund will be sent. Required if the strategy is static_address, but must be unset if the strategy is refund_to_sender.

​
refund_destination_blockchain_memo
string

The memo to include with the refund transaction. Must be unset if the strategy is refund_to_sender.

​
refund_destination_chain
string

The blockchain on which the refund will be sent. Required if the strategy is static_address, but must be unset if the strategy is refund_to_sender.

​
refund_destination_currency
string

The currency to which the refund will be sent. Required if the strategy is static_address, but must be unset if the strategy is refund_to_sender.

​
strategy
string

The strategy to use for the refund. Can be refund_to_sender or static_address. We only support multiple policies for static_address; different strategies cannot have multiple policies. If multiple static_address policies exist, the policy that matches both the currency and chain will be used first. If no such policy is found, the policy that matches only the currency will be used instead.

Response

Crypto return policy created

​
id
string
​
developer_id
string
​
refund_destination_address
string
​
refund_destination_blockchain_memo
string
​
refund_destination_chain
string
​
refund_destination_currency
string
​
strategy
string