Transfer

Get transfer by ID

get

Returns a specific transfer by ID.

Authorizations

Detached-JWS-SignatureGNAP

Path parameters

transferIdstringrequired

Header parameters

x-client-idstringrequired

x-connection-idstringrequired

The provider connection through which the resource is accessed

Authorizationstringoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://auth.armory.narval.xyz/v1/provider/transfers/{transferId}' \
  --header 'detached-jws: YOUR_API_KEY' \
  --header 'x-client-id: text' \
  --header 'x-connection-id: text'

200

400

401

403

404

409

422

500

502

200

{
  "data": {
    "assetExternalId": "text",
    "assetId": "text",
    "clientId": "text",
    "connectionId": "text",
    "createdAt": null,
    "customerRefId": "text",
    "destination": {
      "id": "text",
      "type": "wallet"
    },
    "externalId": "text",
    "externalStatus": "text",
    "grossAmount": "text",
    "idempotenceId": "text",
    "memo": "text",
    "networkFeeAttribution": "on_top",
    "provider": "anchorage",
    "providerSpecific": null,
    "source": {
      "id": "text",
      "type": "wallet"
    },
    "status": "pendingApproval",
    "transferId": "text"
  }
}

The transfer details were successfully retrieved.

Create transfer

post

Creates a new transfer request and sends it to the provider.

Authorizations

Detached-JWS-SignatureGNAP

Header parameters

x-client-idstringrequired

x-connection-idstringrequired

The provider connection through which the resource is accessed

Authorizationstringoptional

Body

sourceobjectrequired

destinationone ofrequired

amountstringrequired

assetIdstringoptional

@deprecated use asset instead

assetobjectrequired

The asset being transferred

networkFeeAttributionstring · enumoptional

Controls how network fees are charged. Example: a request to transfer 1 ETH with networkFeeAttribution=ON_TOP would result in exactly 1 ETH received to the destination and just over 1 ETH spent by the source. Note: This property is optional and its default always depend on the underlying provider.

Available options:

customerRefIdstringoptional

idempotenceIdstringrequired

memostringoptional

providerstring · enumoptionalAvailable options:

providerSpecificanyoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://auth.armory.narval.xyz/v1/provider/transfers' \
  --header 'detached-jws: YOUR_API_KEY' \
  --header 'x-client-id: text' \
  --header 'x-connection-id: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "source": {
      "id": "text",
      "type": "wallet"
    },
    "destination": {
      "id": "text",
      "type": "wallet"
    },
    "amount": "text",
    "assetId": "text",
    "asset": {
      "assetId": "text",
      "externalAssetId": "text",
      "address": "text",
      "networkId": "text"
    },
    "networkFeeAttribution": "on_top",
    "customerRefId": "text",
    "idempotenceId": "text",
    "memo": "text",
    "provider": "anchorage",
    "providerSpecific": null
  }'

201

400

401

403

404

409

422

500

502

201

{
  "data": {
    "assetExternalId": "text",
    "assetId": "text",
    "clientId": "text",
    "connectionId": "text",
    "createdAt": null,
    "customerRefId": "text",
    "destination": {
      "id": "text",
      "type": "wallet"
    },
    "externalId": "text",
    "externalStatus": "text",
    "grossAmount": "text",
    "idempotenceId": "text",
    "memo": "text",
    "networkFeeAttribution": "on_top",
    "provider": "anchorage",
    "providerSpecific": null,
    "source": {
      "id": "text",
      "type": "wallet"
    },
    "status": "pendingApproval",
    "transferId": "text"
  }
}

The transfer was successfully sent.