Links

Redirect link operations

Retrieve a link to fund milestones

post

Retrieve a link to redirect the user (payer) to the fund agreement milestone(s) screen. Note that one, a subset or all milestones can be supplied as required.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

agreementIdstringRequired

ID of the agreement

Example: agreement_123

userIdstringRequired

ID of the user funding the milestone

Example: 123

agreementNamestringRequired

Name of the agreement for display purposes only

Example: Agreement 1

callbackUrlstringOptional

Link to redirect the user to after the milestone submission

Example: https://example.com/callback

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/agreements/milestones/fund

HTTPcURLJavaScriptPython

POST /v1/links/agreements/milestones/fund HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "agreementId": "agreement_123",
  "userId": "123",
  "agreementName": "Agreement 1",
  "callbackUrl": "https://example.com/callback",
  "milestones": [
    {
      "id": "milestone_123",
      "name": "Milestone 1"
    }
  ]
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}

Retrieve a link to submit delivery for a milestone

post

Retrieve a link to redirect the user (receiver) to the submit delivery screen for agreement milestone(s). Note that one, a subset or all milestones can be supplied as required.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

agreementIdstringRequired

ID of the agreement

Example: agreement_123

userIdstringRequired

ID of the user submitting the delivery

Example: 123

agreementNamestringRequired

Name of the agreement for display purposes only

Example: Agreement 1

callbackUrlstringOptional

Link to redirect the user to after the milestone payment approval

Example: https://example.com/callback

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/agreements/milestones/submit

HTTPcURLJavaScriptPython

POST /v1/links/agreements/milestones/submit HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "agreementId": "agreement_123",
  "userId": "123",
  "agreementName": "Agreement 1",
  "callbackUrl": "https://example.com/callback",
  "milestones": [
    {
      "name": "Milestone 1",
      "id": "milestone_123",
      "deliveryFileUri": "https://example.com/delivery.pdf",
      "deliveryFileHash": "0x1234567890abcdef"
    }
  ]
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}

Retrieve a link to pay milestones

post

Retrieve a link to redirect the user (payer) to the payment approval screen for agreement milestone(s). Note that one, a subset or all milestones can be supplied as required.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

agreementIdstringRequired

ID of the agreement

Example: agreement_123

userIdstringRequired

ID of the user submitting the delivery

Example: 123

agreementNamestringRequired

Name of the agreement for display purposes only

Example: Agreement 1

callbackUrlstringOptional

Link to redirect the user to after the milestone dispute

Example: https://example.com/callback

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/agreements/milestones/pay

HTTPcURLJavaScriptPython

POST /v1/links/agreements/milestones/pay HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "agreementId": "agreement_123",
  "userId": "123",
  "agreementName": "Agreement 1",
  "callbackUrl": "https://example.com/callback",
  "milestones": [
    {
      "id": "milestone_123",
      "name": "Milestone 1"
    }
  ]
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}

Retrieve a link to dispute a milestone

post

Retrieve a link to redirect the user to the agreement milestone(s) dispute screen. Note that one, a subset or all milestones can be supplied as required.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

agreementIdstringRequired

ID of the agreement

Example: agreement_123

userIdstringRequired

ID of the user submitting the delivery

Example: 123

agreementNamestringRequired

Name of the agreement for display purposes only

Example: Agreement 1

callbackUrlstringOptional

Link to redirect the user to after the milestone dispute

Example: https://example.com/callback

reasonstringRequired

Reason for disputing the milestone for display purposes only

Example: The milestone was not delivered

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/agreements/milestones/dispute

HTTPcURLJavaScriptPython

POST /v1/links/agreements/milestones/dispute HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "agreementId": "agreement_123",
  "userId": "123",
  "agreementName": "Agreement 1",
  "callbackUrl": "https://example.com/callback",
  "milestone": {
    "id": "milestone_123",
    "name": "Milestone 1"
  },
  "reason": "The milestone was not delivered"
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}

Retrieve a link to approve a milestone

post

Retrieve a link to redirect the user to the approve agreement milestone(s) screen.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

agreementIdstringRequired

ID of the agreement

Example: agreement_123

userIdstringRequired

ID of the user submitting the delivery

Example: 123

agreementNamestringRequired

Name of the agreement for display purposes only

Example: Agreement 1

callbackUrlstringOptional

Link to redirect the user to after the milestone approval

Example: https://example.com/callback

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/agreements/milestones/approve

HTTPcURLJavaScriptPython

POST /v1/links/agreements/milestones/approve HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "agreementId": "agreement_123",
  "userId": "123",
  "agreementName": "Agreement 1",
  "callbackUrl": "https://example.com/callback",
  "milestones": [
    {
      "id": "milestone_123",
      "name": "Milestone 1"
    }
  ]
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}

Retrieve a link to upload a file to an agreement

post

Retrieve a link to redirect the user to the upload agreement file screen.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

idstringRequired

ID of the agreement

Example: agreement_123

userIdstringRequired

ID of the user uploading the agreement

Example: 123

namestringRequired

Name of the agreement for display purposes only

Example: Agreement 1

callbackUrlstringOptional

Link to redirect the user to after the agreement upload

Example: https://example.com/callback

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/agreements/upload

HTTPcURLJavaScriptPython

POST /v1/links/agreements/upload HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "id": "agreement_123",
  "userId": "123",
  "name": "Agreement 1",
  "callbackUrl": "https://example.com/callback"
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}

Retrieve a link to propose a payment split

post

Retrieve a link to propose a payment split for a milestone.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

agreementIdstringRequired

ID of the agreement

Example: agreement_123

userIdstringRequired

ID of the user proposing the payment split

Example: 123

agreementNamestringRequired

Name of the agreement for display purposes only

Example: Agreement 1

callbackUrlstringOptional

Link to redirect the user to after the payment split proposal

Example: https://example.com/callback

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/agreements/milestones/propose-split

HTTPcURLJavaScriptPython

POST /v1/links/agreements/milestones/propose-split HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "agreementId": "agreement_123",
  "milestone": {
    "id": "milestone_123",
    "name": "Milestone 1"
  },
  "userId": "123",
  "agreementName": "Agreement 1",
  "callbackUrl": "https://example.com/callback"
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}

Retrieve a link to approve or reject a payment split

post

Retrieve a link to approve or reject a payment split for a milestone.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

agreementIdstringRequired

ID of the agreement

Example: agreement_123

userIdstringRequired

ID of the user approving or rejecting the payment split

Example: 123

agreementNamestringRequired

Name of the agreement for display purposes only

Example: Agreement 1

callbackUrlstringOptional

Link to redirect the user to after the payment split proposal

Example: https://example.com/callback

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/agreements/milestones/resolve-split

HTTPcURLJavaScriptPython

POST /v1/links/agreements/milestones/resolve-split HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "agreementId": "agreement_123",
  "milestone": "milestone_123",
  "userId": "123",
  "agreementName": "Agreement 1",
  "callbackUrl": "https://example.com/callback"
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}

Retrieve a link to register a new user

post

Retrieve a link to redirect to the registration screens for a new user (or to pick up an unfinished registration).

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

callbackUrlstringOptional

Callback URL to redirect the user back after registration is complete.

Example: https://example.com/callback

idstringRequired

User ID within the organization

Example: 123

typestring · enumRequired

Type of the user to register

Example: individualPossible values:

emailstringRequired

Email address to forward to on/off ramp and kyc services. Note that this is not persisted in Portafino.

Example: [email protected]

businessNamestringOptional

Business name to register. Note that this is not persisted in Portafino.

Example: Acme widgets

businessTypestringOptional

Business type to register. Note that this is not persisted in Portafino.

Example: Investment bank

businessWebsitestringOptional

Business website to register. Note that this is not persisted in Portafino.

Example: acmewidgets.com

businessCountrystringOptional

Business country to register. Note that this is not persisted in Portafino.

Example: GBR

displayMessagestringOptional

Message to greet the user.

Example: Welcome to the organization, please fill out the following forms to register

Responses

200

Action flow started

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/users/register

HTTPcURLJavaScriptPython

POST /v1/links/users/register HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 327

{
  "callbackUrl": "https://example.com/callback",
  "id": "123",
  "type": "individual",
  "email": "[email protected]",
  "businessName": "Acme widgets",
  "businessType": "Investment bank",
  "businessWebsite": "acmewidgets.com",
  "businessCountry": "GBR",
  "displayMessage": "Welcome to the organization, please fill out the following forms to register"
}

{
  "redirectUrl": "https://example.com/register?sessionToken=123"
}

Retrieve a link to deposit funds

post

To deposit funds into the organization's user wallet, use this endpoint to retrieve the appropriate bank transfer instructions.

• This route returns the necessary details to complete a bank transfer deposit, including the IBAN and other relevant instructions.

• Note: At present, only bank transfers are supported. Card or crypto deposits are not available through this endpoint.

Environment-Specific Behavior

Staging Environment:

• In addition to standard bank deposit details, the response also includes access to a faucet tool. This allows developers to generate mock USDC tokens for testing purposes.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

idstringRequired

The ID of the user

Example: user_id_123

callbackUrlstringOptional

Link to redirect the user to after the action

Example: https://example.com/callback

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/users/deposit

HTTPcURLJavaScriptPython

POST /v1/links/users/deposit HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "id": "user_id_123",
  "callbackUrl": "https://example.com/callback"
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}

Retrieve a link to withdraw funds

post

Retrieve a link to off-ramp / withdraw a user's funds.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

idstringRequired

The ID of the user

Example: user_id_123

callbackUrlstringOptional

Link to redirect the user to after the action

Example: https://example.com/callback

amountnumberOptional

The amount to withdraw

Example: 100

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/users/withdraw

HTTPcURLJavaScriptPython

POST /v1/links/users/withdraw HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "id": "user_id_123",
  "callbackUrl": "https://example.com/callback",
  "amount": 100
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}

Retrieve a link to provide additional user data

post

Retrieve a link to provide additional user data needed for KYB/KYC process.

Authorizations

x-api-idx-api-key

x-api-idstringRequired

Body

application/json

idstringRequired

The ID of the user

Example: user_id_123

callbackUrlstringOptional

Link to redirect the user to after the action

Example: https://example.com/callback

Responses

200

Success

application/json

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

post

/v1/links/users/provide-user-data

HTTPcURLJavaScriptPython

POST /v1/links/users/provide-user-data HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "id": "user_id_123",
  "callbackUrl": "https://example.com/callback"
}

{
  "redirectUrl": "https://example.com/action?sessionToken=123"
}