Skip to main content
POST
/
api
/
private
/
wallet
/
{asset}
/
deposits
/
{deposit_id}
/
travel-rule
/
Submit Deposit Travel Rule
curl --request POST \
  --url https://app.digitalsurge.com.au/api/private/wallet/{asset}/deposits/{deposit_id}/travel-rule/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "wallet_provider": "<string>",
  "wallet_provider_other_name": "<string>",
  "exchange": "<string>",
  "exchange_other_name": "<string>",
  "beneficiary_full_name": "<string>",
  "beneficiary_country": "<string>",
  "beneficiary_region": "<string>",
  "beneficiary_organisation_name": "<string>",
  "beneficiary_organisation_country": "<string>",
  "beneficiary_organisation_region": "<string>"
}

Authorizations

​
Authorization
string
header
required

Personal API key, created in the Digital Surge app under Account Settings → API Keys. Send it with every request as Authorization: Bearer <your-api-key>.

Path Parameters

​
asset
string
required
Pattern: ^\w{1,10}$
​
deposit_id
string
required
Pattern: ^\d+$

Body

Serializer for submitting travel rule data for a specific deposit.

​
destination_type
enum<string>
required

Where the funds are going: 'personal_wallet' or 'exchange_account'.

  • personal_wallet - Personal Wallet
  • exchange_account - Exchange Account
Available options:
personal_wallet,
exchange_account
​
ownership
enum<string>
required

Who owns the destination: 'self' or 'other'.

  • self - Self (Own Account)
  • other - Other
Available options:
self,
other
​
beneficiary_type

Required when ownership is 'other': 'individual' or 'organisation'.

  • individual - Individual
  • organisation - Organisation
Available options:
individual,
organisation
​
wallet_provider
string

Required when destination_type is 'personal_wallet'. See /reference-data/ for values.

Maximum string length: 50
​
wallet_provider_other_name
string

Name of the wallet provider when wallet_provider is 'other'.

Maximum string length: 100
​
exchange
string

Required when destination_type is 'exchange_account'. See /reference-data/ for values.

Maximum string length: 50
​
exchange_other_name
string

Name of the exchange when exchange is 'other'.

Maximum string length: 100
​
beneficiary_full_name
string

Required when beneficiary_type is 'individual'.

Maximum string length: 200
​
beneficiary_country
string

ISO 3166-1 alpha-2 country code. Required when beneficiary_type is 'individual'.

Maximum string length: 2
​
beneficiary_region
string

Beneficiary's state, province or region (e.g. an Australian state). Optional.

Maximum string length: 100
​
beneficiary_organisation_name
string

Required when beneficiary_type is 'organisation'.

Maximum string length: 200
​
beneficiary_organisation_country
string

ISO 3166-1 alpha-2 country code. Required when beneficiary_type is 'organisation'.

Maximum string length: 2
​
beneficiary_organisation_region
string

Beneficiary organisation's state, province or region. Optional.

Maximum string length: 100

Response

201 - application/json

Serializer for submitting travel rule data for a specific deposit.

​
destination_type
enum<string>
required

Where the funds are going: 'personal_wallet' or 'exchange_account'.

  • personal_wallet - Personal Wallet
  • exchange_account - Exchange Account
Available options:
personal_wallet,
exchange_account
​
ownership
enum<string>
required

Who owns the destination: 'self' or 'other'.

  • self - Self (Own Account)
  • other - Other
Available options:
self,
other
​
beneficiary_type

Required when ownership is 'other': 'individual' or 'organisation'.

  • individual - Individual
  • organisation - Organisation
Available options:
individual,
organisation
​
wallet_provider
string

Required when destination_type is 'personal_wallet'. See /reference-data/ for values.

Maximum string length: 50
​
wallet_provider_other_name
string

Name of the wallet provider when wallet_provider is 'other'.

Maximum string length: 100
​
exchange
string

Required when destination_type is 'exchange_account'. See /reference-data/ for values.

Maximum string length: 50
​
exchange_other_name
string

Name of the exchange when exchange is 'other'.

Maximum string length: 100
​
beneficiary_full_name
string

Required when beneficiary_type is 'individual'.

Maximum string length: 200
​
beneficiary_country
string

ISO 3166-1 alpha-2 country code. Required when beneficiary_type is 'individual'.

Maximum string length: 2
​
beneficiary_region
string

Beneficiary's state, province or region (e.g. an Australian state). Optional.

Maximum string length: 100
​
beneficiary_organisation_name
string

Required when beneficiary_type is 'organisation'.

Maximum string length: 200
​
beneficiary_organisation_country
string

ISO 3166-1 alpha-2 country code. Required when beneficiary_type is 'organisation'.

Maximum string length: 2
​
beneficiary_organisation_region
string

Beneficiary organisation's state, province or region. Optional.

Maximum string length: 100