Users | Portafino

Get the transfer by transfer ID

get

Get the transfer by transfer ID.

Authorizations

x-api-idstringRequired

Path parameters

transferIdstringRequired

Responses

200

Transfer found

application/json

400

Bad request - Invalid transfer ID format

404

Transfer not found

500

Internal server error

get

/v1/users/transfer/{transferId}

GET /v1/users/transfer/{transferId} HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Accept: */*

{
  "id": "123",
  "state": "pending",
  "amount": "100.00",
  "created_at": "2021-01-01T00:00:00.000Z",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "receipt": {
    "initial_amount": "100.00",
    "exchange_fee": "100.00",
    "gas_fee": "100.00",
    "subtotal_amount": "100.00",
    "final_amount": "100.00",
    "url": "https://www.google.com"
  },
  "source": {
    "currency": "usd",
    "payment_rail": "ach",
    "from_address": "0x1234567890123456789012345678901234567890"
  },
  "destination": {
    "currency": "usd",
    "payment_rail": "ach",
    "wire_message": "123",
    "sepa_reference": "123",
    "swift_reference": "123",
    "spei_reference": "123",
    "swift_charges": "our",
    "ach_reference": "123",
    "to_address": "123"
  }
}

Get user details including PII from Bridge

get

Proxies request to Bridge API to get fresh user details including name and type. Data is NOT stored on our servers - fetched directly from Bridge.

Authorizations

x-api-idstringRequired

Path parameters

idstringRequired

Responses

200

User details retrieved from Bridge

application/json

400

User not registered with provider

404

User not found

500

Internal server error

get

/v1/users/{id}/details

GET /v1/users/{id}/details HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Accept: */*

{
  "id": "user_id_123",
  "email": "[email protected]",
  "type": "individual",
  "status": "active",
  "firstName": "John",
  "lastName": "Doe",
  "businessLegalName": "Acme Corp Ltd",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T00:00:00Z"
}

Get the balance of a user

get

Get the balance of a user.

Authorizations

x-api-idstringRequired

Path parameters

idstringRequired

Responses

200

Balance found

application/json

400

Bad request - Invalid user ID format

404

User not found

500

Internal server error

501

Not implemented

get

/v1/users/{id}/balance

GET /v1/users/{id}/balance HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Accept: */*

{
  "id": "123",
  "balances": {
    "USDC": "100.50",
    "EURC": "250.75"
  }
}

Get the transfers of a user

get

Get the transfers of a user.

Authorizations

x-api-idstringRequired

Path parameters

idstringRequired

Query parameters

limitnumberRequired

The number of items to return (default of 10, max of 50)

Default: 10Example: 10

starting_afterstringOptional

This is a transfer id. If this is specified, the next page that starts with a transfer right AFTER the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers older than the specified transfer id will be returned (shouldn't be set if ending_before is set)

Example: 123

ending_beforestringOptional

This is a transfer id. If this is specified, the next page that starts with a transfer right BEFORE the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers newer than the specified transfer id will be returned (shouldn't be set if starting_after is set)

Example: 123

tx_hashstringOptional

Tx hash of the transaction

Example: 0x1234567890123456789012345678901234567890

updated_after_msnumberOptional

This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned

Example: 1714732800000

updated_before_msnumberOptional

Unix timestamp in milliseconds - returns objects updated BEFORE this timestamp

Example: 1714732800000

statestring · enumRequired

Filter transfers by their external state

Example: awaiting_fundsPossible values:

Responses

200

Transfers found

application/json

400

Bad request - Invalid user ID format

404

User not found

500

Internal server error

get

/v1/users/{id}/transfers

GET /v1/users/{id}/transfers?limit=10&state=awaiting_funds HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123",
    "state": "pending",
    "amount": "100.00",
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-01-01T00:00:00.000Z",
    "receipt": {
      "initial_amount": "100.00",
      "exchange_fee": "100.00",
      "gas_fee": "100.00",
      "subtotal_amount": "100.00",
      "final_amount": "100.00",
      "url": "https://www.google.com"
    },
    "source": {
      "currency": "usd",
      "payment_rail": "ach",
      "from_address": "0x1234567890123456789012345678901234567890"
    },
    "destination": {
      "currency": "usd",
      "payment_rail": "ach",
      "wire_message": "123",
      "sepa_reference": "123",
      "swift_reference": "123",
      "spei_reference": "123",
      "swift_charges": "our",
      "ach_reference": "123",
      "to_address": "123"
    }
  }
]

Get a user by their User ID

get

Get a user by their User ID.

Authorizations

x-api-idstringRequired

Path parameters

idstringRequired

Responses

200

User found

application/json

400

Bad request - Invalid user ID format

404

User not found

500

Internal server error

get

/v1/users/{id}

GET /v1/users/{id} HTTP/1.1
Host: staging.api.portafino.appliedblockchain.dev
x-api-id: YOUR_API_KEY
Accept: */*

{
  "id": "user_id_123",
  "rejectionReasons": [
    {
      "developer_reason": "test-developer-reason",
      "reason": "test-reason",
      "created_at": "2025-12-12T14:14:48.149Z"
    }
  ],
  "status": "pending"
}