API Explorer

Add Asset To A Fund

Add an Asset to an existing fund

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund/{fund_id}/asset"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "wallets":["string"]
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_FundAsset567 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_fund_FUND_ID_asset, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_fund_FUND_ID_asset Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Add Fund

Create a Fund that serves as a wallet containing assets, addresses, and custody policies. Custody policies for both deposits and withdrawals must exist for a fund. Policies can include multiple custodians, or a single user that self-manages custody. For an individual fund, you can also add whitelisted withdrawal addresses.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "custodygroup_tx":"string",
  "custodygroup_withdraw":"string",
  "fund_id":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_Fund114 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_fund, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_fund Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Add To Liquidity Hub

Add an existing swap to the liquidity hub.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/liquidityhub"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_AddToLiquidityHub876 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_liquidityhub, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_liquidityhub Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Add Trusted Party

Add a Trusted Party for the Company. A Trusted Party is a user that can be added as a custodian of a wallet or member of a fund. Qredo network as a Company or User.
When adding a user, they must approve this via their Qredo Signing App.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/trustedparty"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "code":1,
  "msg":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_TrustedPartyNew113 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_trustedparty, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_trustedparty Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Add Wallet To A Fund

Add a new Wallet to an existing fund. If Custody groups are blank the default fund cutosdy policy will be used

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund/{fund_id}/wallet"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "wallets":["string"]
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_FundWallet103 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_fund_FUND_ID_wallet, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_fund_FUND_ID_wallet Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Add Whitelist Address

An address needs to be Whitelisted to ensure it is approved for a withdrawal transaction.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund/{fund_id}/whitelist"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_AddFundWhitelist602 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_fund_FUND_ID_whitelist, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_fund_FUND_ID_whitelist Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Approve Action

Approve a specific action

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/coreclient/{client_id}/action/{action_id}"
    },
    {
        "key":"http_method",
        "value":"PUT"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "expireTime":1,
  "id":"string",
  "status":"pending",
  "timestamp":1,
  "type":"ApproveWithdraw"
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateDynamicEndpoint_ActionDetails604 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_PUT_coreclient_CLIENT_ID_action_ACTION_ID, operation_id: OBPv4.0.0-dynamicEndpoint_PUT_coreclient_CLIENT_ID_action_ACTION_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Calculate Fees

Calculate fees for specific assets and transaction types for any company on the network.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/fees"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "amountToSend":1.2,
  "fees":1.2,
  "netAmount":1.2
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_FeesRequest465 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_fees, operation_id: OBPv4.0.0-dynamicEndpoint_POST_fees Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Cancel Atomic Swap

Cancel atomic swap

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/atomicswap/make/{tx_id}"
    },
    {
        "key":"http_method",
        "value":"DELETE"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "code":1,
  "msg":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanDeleteDynamicEndpoint_OkResponse531 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_DELETE_company_COMPANY_ID_atomicswap_make_TX_ID, operation_id: OBPv4.0.0-dynamicEndpoint_DELETE_company_COMPANY_ID_atomicswap_make_TX_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Create A New Core Client

Create a new Core Client

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/coreclient"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "feed":"string",
  "id":"string",
  "name":"string",
  "timestamp":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_NewCoreClient398 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_coreclient, operation_id: OBPv4.0.0-dynamicEndpoint_POST_coreclient Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Create Atomic Swap Quote

Initiate an Atomic Swap Quote and set parameters for the transaction.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/atomicswap/make"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "status":"new",
  "tx_id":"string",
  "tx_url":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_AtomicSwapMake101 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_atomicswap_make, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_atomicswap_make Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Create Company

Create a Company on behalf of a customer account to include all managed network entities
i.e. Trusted Parties, Holdings, Funds, Custody Policies and those for the movement of assets (deposits, transfers, and withdrawals).

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "company_id":"string",
  "ref":""
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_Company125 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Del Trusted Party

Delete a Trusted Party from the trusted network.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/trustedparty/{trustedparty_id}"
    },
    {
        "key":"http_method",
        "value":"DELETE"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "code":1,
  "msg":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanDeleteDynamicEndpoint_OkResponse141 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_DELETE_company_COMPANY_ID_trustedparty_TRUSTEDPARTY_ID, operation_id: OBPv4.0.0-dynamicEndpoint_DELETE_company_COMPANY_ID_trustedparty_TRUSTEDPARTY_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Details Of An Action

Returns the details of an action including Type, Status, Timestamp and Expiry Time.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/coreclient/{client_id}/action/{action_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "expireTime":1,
  "id":"string",
  "status":"pending",
  "timestamp":1,
  "type":"ApproveWithdraw"
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_ActionDetails604 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_coreclient_CLIENT_ID_action_ACTION_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_coreclient_CLIENT_ID_action_ACTION_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get A List Of All Registered Core Clients

Get a list of all registered Core Clients

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/coreclient"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "clients":[{
    "feed":"string",
    "id":"string",
    "name":"string",
    "timestamp":"string"
  }],
  "count":1
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_CoreClientsInfo398 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_coreclient, operation_id: OBPv4.0.0-dynamicEndpoint_GET_coreclient Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Atomic Swap Taker Status

Obtain details on an atomic swap

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/atomicswap/take/{tx_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									"Successful Response"

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_AtomicSwapTakerStatus143 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_atomicswap_take_TX_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_atomicswap_take_TX_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Atomic Swaps Quote Details

Obtain details on an atomic swap

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/atomicswap/make/{tx_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									"Successful Response"

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_AtomicSwapsQuoteDetails531 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_atomicswap_make_TX_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_atomicswap_make_TX_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Company

Returns details of a Company from the Company ID.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "city":"string",
  "company_id":"string",
  "country":"string",
  "domain":"string",
  "name":"string",
  "ref":""
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_Company109 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Connected Wallets

Obtain details on connected wallets and wallets pending approval

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/coreclient/{client_id}/wallets"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "wallets":[{
    "action_id":"string",
    "expires":1,
    "status":"pending",
    "wallet_id":"string"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_ConnectedWallets238 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_coreclient_CLIENT_ID_wallets, operation_id: OBPv4.0.0-dynamicEndpoint_GET_coreclient_CLIENT_ID_wallets Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Fund

Returns basic information on the Fund including the custody groups for withdrawal and transfers. There are also details on fund members who are part of each custody group.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund/{fund_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "assets":["string"],
  "custodygroup_tx":"string",
  "custodygroup_withdraw":"string",
  "description":"string",
  "fund_id":"string",
  "members":[{
    "entity":{
      "accountCode":"string",
      "company":{
        "name":"string"
      },
      "core-client":{
        "name":"string"
      },
      "id":"string",
      "initials":"string",
      "name":"string",
      "type":"user",
      "user":{
        "email":"string",
        "firstName":"string",
        "lastName":"string",
        "userName":"string"
      }
    },
    "permissions":{
      "admin":true,
      "swap":true,
      "transfer":true,
      "withdraw":true
    }
  }],
  "name":"string",
  "policy_tx":{
    "id":"string",
    "members":[{
      "accountCode":"string",
      "company":{
        "name":"string"
      },
      "core-client":{
        
      },
      "id":"string",
      "initials":"string",
      "name":"string",
      "type":"user",
      "user":{
        "email":"string",
        "firstName":"string",
        "lastName":"string",
        "userName":"string"
      }
    }],
    "name":"string",
    "threshold":1
  },
  "policy_withdraw":{
    "id":"string",
    "members":[{
      "accountCode":"string",
      "company":{
        
      },
      "core-client":{
        
      },
      "id":"string",
      "initials":"string",
      "name":"string",
      "type":"user",
      "user":{
        "email":"string",
        "firstName":"string",
        "lastName":"string",
        "userName":"string"
      }
    }],
    "name":"string",
    "threshold":1
  },
  "wallets":[{
    "address":"string",
    "address_type":"string",
    "asset":"string",
    "balance":1.2,
    "connected":[{
      "client_id":"string",
      "counterparty_id":"string",
      "name":"string",
      "status":"string"
    }],
    "custodygroup_tx":"string",
    "custodygroup_withdraw":"string",
    "name":"string",
    "policy_tx":{
      "id":"string",
      "members":[{
        
      }],
      "name":"string",
      "threshold":1
    },
    "policy_withdraw":{
      
    },
    "short_code":"string",
    "status":"string",
    "type":0,
    "wallet_id":"string"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_FundDetail429 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_fund_FUND_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_fund_FUND_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Fund Deposit Address

Returns a list of fund assets with their Deposit Addresses and current balances. Each fund contains one or more deposit addresses for the different types of assets.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund/{fund_id}/deposit"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "list":[{
    "address":"string",
    "asset":"string",
    "balance":1.2
  }],
  "total_count":1
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_FundDepositResponse179 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_fund_FUND_ID_deposit, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_fund_FUND_ID_deposit Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Fund Whitelist

Get Whitelisted addresses for fund transactions.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund/{fund_id}/whitelist"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "list":[{
    "address":"string",
    "asset":"string",
    "name":"string"
  }],
  "total_count":1
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_FundWhitelist602 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_fund_FUND_ID_whitelist, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_fund_FUND_ID_whitelist Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Holdings

Returns information on all the assets for a company on the Qredo network. Each Holding is divided according to the asset type. Each Holding entry also includes the balance for that asset, allowing you to track funds coming in and out.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/holding"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "holdings":[{
    "amount":1.2,
    "symbol":"string"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_Holdings189 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_holding, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_holding Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Liquidity Hub

Get all the active swaps in the liquidity hub. You can use websocket connection to get live notifications when a new swap is added to the liquidity hub using this endpoint: wss://api.qredo.network/api/v1/p/liquidityhub/feed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/liquidityhub"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "items":{
    "added":1,
    "expires":1,
    "owner":true,
    "receive_amount":1.2,
    "receive_asset":"string",
    "send_amount":1.2,
    "send_asset":"string",
    "tx_id":"string"
  }
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_LiquidityHub876 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_liquidityhub, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_liquidityhub Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Sweep Status

Obtain details on a sweep transaction status

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/coreclient/{client_id}/sweep/{tx_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "approver_count":1,
  "expires":1,
  "initiated_timestamp":1,
  "reference":"string",
  "status":[{
    "action_id":"string",
    "entity":"string",
    "status":"string",
    "timestamp":1
  }],
  "status_details":{
    "amount":1,
    "asset":"string",
    "expires":1,
    "fees":1,
    "net_amount":1,
    "recipient_wallet_id":"string",
    "reference":"string",
    "requested_by":"string",
    "wallet_id":"string"
  },
  "threshold_required":1,
  "tx_id":"string",
  "tx_status":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_SweepInfo212 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_coreclient_CLIENT_ID_sweep_TX_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_coreclient_CLIENT_ID_sweep_TX_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Transfer Status

Returns the Transfer Status for a specific transaction at that point in time.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/transfer/{tx_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "approver_count":1,
  "expires":1,
  "initiated_timestamp":1,
  "initiator_authorized":true,
  "initiator_name":"string",
  "reference":"string",
  "status":[{
    "action_id":"string",
    "first_name":"string",
    "last_name":"string",
    "status":"string",
    "timestamp":1,
    "user_id":"string",
    "username":"string"
  }],
  "status_details":{
    "account_no":"string",
    "amount":1,
    "asset":"string",
    "benefit_of":"string",
    "expires":1,
    "fees":1,
    "fund_id":"string",
    "net_amount":1,
    "recipient_address":"string",
    "recipient_email":"string",
    "recipient_first_name":"string",
    "recipient_last_name":"string",
    "recipient_username":"string",
    "reference":"string",
    "requested_by":"string"
  },
  "threshold_required":1,
  "tx_id":"string",
  "tx_status":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_TxInfo177 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_transfer_TX_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_transfer_TX_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Wallet History

Get wallet history

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/wallet/{wallet_id}/history"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "history":[{
    "amount":1.2,
    "asset":"string",
    "chain_tx_id":"string",
    "fee":1.2,
    "net_amount":1.2,
    "timestamp":1.2,
    "tx_id":"string",
    "wallet_id":"string"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_FundWalletHistory187 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_wallet_WALLET_ID_history, operation_id: OBPv4.0.0-dynamicEndpoint_GET_wallet_WALLET_ID_history Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Wallet Info

Get wallet info, addresses and balance.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/wallet/{wallet_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "address":"string",
  "address_type":"string",
  "asset":"string",
  "balance":1.2,
  "connected":[{
    "client_id":"string",
    "counterparty_id":"string",
    "name":"string",
    "status":"string"
  }],
  "custodygroup_tx":"string",
  "custodygroup_withdraw":"string",
  "name":"string",
  "policy_tx":{
    "id":"string",
    "members":[{
      "accountCode":"string",
      "company":{
        "name":"string"
      },
      "core-client":{
        "name":"string"
      },
      "id":"string",
      "initials":"string",
      "name":"string",
      "type":"user",
      "user":{
        "email":"string",
        "firstName":"string",
        "lastName":"string",
        "userName":"string"
      }
    }],
    "name":"string",
    "threshold":1
  },
  "policy_withdraw":{
    "id":"string",
    "members":[{
      "accountCode":"string",
      "company":{
        "name":"string"
      },
      "core-client":{
        
      },
      "id":"string",
      "initials":"string",
      "name":"string",
      "type":"user",
      "user":{
        "email":"string",
        "firstName":"string",
        "lastName":"string",
        "userName":"string"
      }
    }],
    "name":"string",
    "threshold":1
  },
  "short_code":"string",
  "status":"string",
  "type":0,
  "wallet_id":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_FundWalletInfo206 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_wallet_WALLET_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_wallet_WALLET_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Get Withdrawal Status

Obtain details on a withdrawal status

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/withdraw/{tx_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "approver_count":1,
  "expires":1,
  "initiated_timestamp":1,
  "initiator_authorized":true,
  "initiator_name":"string",
  "reference":"string",
  "status":[{
    "action_id":"string",
    "first_name":"string",
    "last_name":"string",
    "status":"string",
    "timestamp":1,
    "user_id":"string",
    "username":"string"
  }],
  "status_details":{
    "account_no":"string",
    "amount":1,
    "asset":"string",
    "benefit_of":"string",
    "expires":1,
    "fees":1,
    "fund_id":"string",
    "net_amount":1,
    "recipient_address":"string",
    "recipient_email":"string",
    "recipient_first_name":"string",
    "recipient_last_name":"string",
    "recipient_username":"string",
    "reference":"string",
    "requested_by":"string"
  },
  "threshold_required":1,
  "tx_id":"string",
  "tx_status":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_WithdrawalInfo633 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_withdraw_TX_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_withdraw_TX_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Initiate Atomic Swap Taker Transaction

Initiate an atomic swap take transaction.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/atomicswap/take"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "status":"new",
  "tx_id":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_AtomicSwapTake101 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_atomicswap_take, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_atomicswap_take Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

New Transfer

Initiate a new Transfer on a fund that includes various settings for the transaction. When a transfer transaction is created, custodian(s) need to approve it via their Qredo Signing app. The number of custodian approvals depends on the Transfer Policy settings for the fund.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/transfer"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "status":"new",
  "tx_id":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_Transfer522 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_transfer, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_transfer Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

New Withdrawal

Initiate a withdrawal and set parameters for the transaction. When a withdrawal transaction is created, custodian(s) need to approve it through their Qredo Signing app. (The number of custodian approvals depends on your Transfer Policy settings.)

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/withdraw"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "status":"new",
  "tx_id":"string"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDynamicEndpoint_Withdrawal169 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_withdraw, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_withdraw Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Pending Actions

Returns actions with a status of 'Pending'

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/coreclient/{client_id}/actions"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "actions":[{
    "expireTime":1,
    "id":"string",
    "status":"pending",
    "timestamp":1,
    "type":"ApproveWithdraw"
  }],
  "count":1
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_ActionsInfo204 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_coreclient_CLIENT_ID_actions, operation_id: OBPv4.0.0-dynamicEndpoint_GET_coreclient_CLIENT_ID_actions Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Reject A Specific Action

Reject a specific action

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/coreclient/{client_id}/action/{action_id}"
    },
    {
        "key":"http_method",
        "value":"DELETE"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "expireTime":1,
  "id":"string",
  "status":"pending",
  "timestamp":1,
  "type":"ApproveWithdraw"
}

Request Headers:

Response Headers:

Required Roles:

CanDeleteDynamicEndpoint_ActionDetails604 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_DELETE_coreclient_CLIENT_ID_action_ACTION_ID, operation_id: OBPv4.0.0-dynamicEndpoint_DELETE_coreclient_CLIENT_ID_action_ACTION_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Returns All Trusted Parties For A Company

Returns all Trusted Parties for a Company. A Trusted Party is a user that can be added as a custodian of a wallet or member of a fund.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/trustedparty"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "company_id":"string",
  "list":[{
    "company_id":"string",
    "list":{
      "address":"string",
      "created":1,
      "name":"string",
      "trusted_entity_id":"string",
      "type":"string"
    },
    "total_count":1
  }],
  "total_count":1
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_TrustedPartyList113 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_trustedparty, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_trustedparty Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Search Company

Search for a Company in the database using the string entered in the query parameter for matching. For example, entering 3 letters returns all companies where those letters exist.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/search"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "matches":[{
    "company_id":"string",
    "domain":"string",
    "name":"string"
  }],
  "total_count":1
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_CompanySearchResponse193 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_search, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_search Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Search Fund

Search funds in the database using the string entered in the query parameter for matching. For example, entering 3 letters returns all funds where those letters exist.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund/search"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "list":[{
    "id":"string",
    "name":"string"
  }],
  "total_count":1
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_FundSearchResult162 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_fund_search, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_fund_search Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Supported Assets

Returns a list of supported assets and their codes

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/assets"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "assets":{
    "code":"string",
    "enabled":true,
    "name":"string",
    "scale":1.2,
    "unitCode":"string"
  }
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_Assets164 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_assets, operation_id: OBPv4.0.0-dynamicEndpoint_GET_assets Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Transaction Ledger

Get transaction ledger for a fund

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund/{fund_id}/ledger"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "List":[{
    "TxID":"string",
    "accountNo":"string",
    "address":"string",
    "amount":1,
    "asset":"string",
    "benefitOf":"string",
    "chainTxID":"string",
    "counterpartyID":"string",
    "counterpartyName":"string",
    "expireTime":1,
    "fees":1,
    "fundID":"string",
    "netAmount":1,
    "reference":"string",
    "status":"pending_initiate",
    "timestamp":1,
    "type":"none"
  }],
  "Total":1
}

Request Headers:

Response Headers:

Required Roles:

CanGetDynamicEndpoint_TxLedger724 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_company_COMPANY_ID_fund_FUND_ID_ledger, operation_id: OBPv4.0.0-dynamicEndpoint_GET_company_COMPANY_ID_fund_FUND_ID_ledger Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Update Company

Change details of a Company

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}"
    },
    {
        "key":"http_method",
        "value":"PUT"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									{
  "company_id":"string",
  "ref":""
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateDynamicEndpoint_Company109 - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by dynamicEndpoint_PUT_company_COMPANY_ID, operation_id: OBPv4.0.0-dynamicEndpoint_PUT_company_COMPANY_ID Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Create User Auth Context

Create User Auth Context. These key value pairs will be propagated over connector to adapter. Normally used for mapping OBP user and
Bank User/Customer.
Authentication is Mandatory

URL Parameters:

USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON request body fields:

key: CustomerNumber
value: 5987953

JSON response body fields:

key: CustomerNumber
time_stamp: 2017-09-19T02:31:05.000Z
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
value: 5987953

Typical Successful Response

								
									{
  "user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "key":"CUSTOMER_NUMBER",
  "value":"78987432",
  "time_stamp":"2017-09-19T00:00:00Z"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateUserAuthContext - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-10001: Incorrect json format.
OBP-30053: Could not insert the UserAuthContext
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv3.1.0, function_name: by createUserAuthContext, operation_id: OBPv3.1.0-createUserAuthContext Tags: User, New-Style,

Create User Auth Context Update Request

Create User Auth Context Update Request.
Authentication is Mandatory

A One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
SCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

key: CustomerNumber
value: 5987953

JSON response body fields:

key: CustomerNumber
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
value: 5987953

Typical Successful Response

								
									{
  "user_auth_context_update_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "key":"CUSTOMER_NUMBER",
  "value":"78987432",
  "status":"INITIATED"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-10001: Incorrect json format.
OBP-30053: Could not insert the UserAuthContext
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by createUserAuthContextUpdateRequest, operation_id: OBPv3.1.0-createUserAuthContextUpdateRequest Tags: User, New-Style,

Delete User Auth Context

Delete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID.

Authentication is Mandatory

URL Parameters:

USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields:

Typical Successful Response

								
									{
  "jsonString":"{}"
}

Request Headers:

Response Headers:

Required Roles:

CanDeleteUserAuthContext - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by deleteUserAuthContextById, operation_id: OBPv3.1.0-deleteUserAuthContextById Tags: User, New-Style,

Get User (Current)

Get the logged in user

Authentication is Mandatory

JSON response body fields:

bank_id: gh.29.uk
email: felixsmith@example.com
provider: ETHEREUM
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith

Typical Successful Response

								
									{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "email":"felixsmith@example.com",
  "provider_id":"Chris",
  "provider":"http://127.0.0.1:8080",
  "username":"felixsmith",
  "entitlements":{
    "list":[{
      "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
      "role_name":"CanQueryOtherUser",
      "bank_id":"gh.29.uk"
    }]
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Connector Methods:

obp.getBankAccountsForUser

Version: OBPv3.0.0, function_name: by getCurrentUser, operation_id: OBPv3.0.0-getCurrentUser Tags: User, New-Style,

Get User Auth Contexts

Get User Auth Contexts for a User.

Authentication is Mandatory

URL Parameters:

USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields:

key: CustomerNumber
time_stamp: 2017-09-19T02:31:05.000Z
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
value: 5987953

Typical Successful Response

								
									{
  "user_auth_contexts":[{
    "user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "key":"CUSTOMER_NUMBER",
    "value":"78987432",
    "time_stamp":"2017-09-19T00:00:00Z"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetUserAuthContext - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by getUserAuthContexts, operation_id: OBPv3.1.0-getUserAuthContexts Tags: User, New-Style,

Featured APIs

API Explorer

v5.0.0 (45 APIs)

Add Asset To A Fund

Add Fund

Add To Liquidity Hub

Add Trusted Party

Add Wallet To A Fund

Add Whitelist Address

Approve Action

Calculate Fees

Cancel Atomic Swap

Create A New Core Client

Create Atomic Swap Quote

Create Company

Del Trusted Party

Details Of An Action

Get A List Of All Registered Core Clients

Get Atomic Swap Taker Status

Get Atomic Swaps Quote Details

Get Company

Get Connected Wallets

Get Fund

Get Fund Deposit Address

Get Fund Whitelist

Get Holdings

Get Liquidity Hub

Get Sweep Status

Get Transfer Status

Get Wallet History

Get Wallet Info

Get Withdrawal Status

Initiate Atomic Swap Taker Transaction

New Transfer

New Withdrawal

Pending Actions

Reject A Specific Action

Returns All Trusted Parties For A Company

Search Company

Search Fund

Supported Assets

Transaction Ledger

Update Company

Create User Auth Context

Create User Auth Context Update Request

Delete User Auth Context

Get User (Current)

Get User Auth Contexts