Skip to main content
PATCH
/
api
/
v2
/
payout-destination
/
{payoutDestinationId}
Update payout destination
curl --request PATCH \
  --url https://demo.api.loopcrypto.xyz/api/v2/payout-destination/{payoutDestinationId} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --header 'entity-id: <api-key>' \
  --data '{
  "isDefault": true
}'
{
  "payoutDestinationId": "1234567890abcdef",
  "merchantId": "1234567890abcdef",
  "networkId": 1,
  "settlementType": "Crypto",
  "fiatSettlementAccount": {
    "provider": "Fern",
    "kycStatus": "pending",
    "kycLink": "https://www.google.com",
    "bankAccountStatus": "Pending",
    "bankAccountFormLink": "https://www.google.com"
  },
  "walletAddress": "0x1234567890abcdef",
  "isDefault": true,
  "isArchived": true,
  "dateCreated": 1716211200
}

Authorizations

​
api-key
string
header
required
​
entity-id
string
header
required

Path Parameters

​
payoutDestinationId
string
required

The unique identifier of the payout destination to update

Body

application/json
​
isDefault
boolean

Allows a non default payout destination to be promoted to the default payout destination. The existing default payout destination will be demoted to second place.

Note: There always has to be at least 1 default payout destination so you cannot demote the current default - this is why true is the only valid value here.

Example:

true

Response

Ok

​
payoutDestinationId
string
required

The unique identifier for the payout destination

Example:

"1234567890abcdef"

​
merchantId
string
required

The merchant ID associated with this payout destination

Example:

"1234567890abcdef"

​
networkId
number
required

The blockchain network ID the payout destination is associated with

Example:

1

​
settlementType
enum<string>
required

The settlement type of the payout destination

Available options:
Crypto,
Fiat
Example:

"Crypto"

​
fiatSettlementAccount
object
required

The fiat settlement settings for the payout destination if the settlement type is fiat

​
walletAddress
string
required

The blockchain wallet address where payments will be sent. Must be a valid address for the specified network.

Example:

"0x1234567890abcdef"

​
isDefault
boolean
required

Whether the payout destination is the default payout destination for the merchant.

Example:

true

​
isArchived
boolean
required

Whether the payout destination is archived or not. Archived payout destination cannot be used for payments.

Example:

true

​
dateCreated
number
required

The date the payout destination record was created, represented as a Unix timestamp in seconds.

Example:

1716211200

⌘I