Go to home page
Docs API Reference

Wallets

A Wallet is a representation of a consumer application.

Wallet Model

Attributes

  • id

    string

    A unique and human readable identifier of the wallet.

  • name

    string

    The displayable name of the wallet.

  • accountId

    string

    The account that owns the wallet.

  • connectUrl

    string

    The URL that we will redirect to for the Connect flow.

  • payUrl

    string

    The URL that we will redirect to for payments.

  • logoMediaUploadId

    string

    The id of the Media Upload image of the Wallet.

  • primaryColorHex

    string

    A hex color code used to visually represent the wallet or brand in the UI.

  • assetTypes

    array

    List of Asset Types that the wallet supports.

Asset Types Model

Attributes

  • id

    string required

    The unique identifier of the Asset Type.

  • collectionId

    string

    Identifier of a Collection that is supported by the wallet. Only valid if the Asset Type is a centrapay.token or centrapay.ledger.

Create Wallet experimental

This endpoint allows you to create a Wallet .

Attributes

  • id

    string required

    A unique and human readable identifier of the Wallet.

  • name

    string required

    The displayable name of the Wallet.

  • accountId

    string required

    The account that owns the wallet.

  • connectUrl

    string

    The URL to redirect to for the Connect flow.

  • payUrl

    string

    The URL to redirect to for payments.

  • logoMediaUploadId

    string

    The ID of the Media Upload image for the Wallet.

  • primaryColorHex

    string

    A hex color code (e.g., #FF5733) used to visually represent the wallet or brand in the UI.

  • assetTypes

    array required

    A list of asset types supported by the Wallet. Each item must include an id, and optionally collectionIds if required for specific asset types.

Request
curl -X POST \
 https://service.centrapay.com/api/wallets \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "id": "payap",
 "name": "Payap",
 "accountId": "abc123",
 "connectionId": "https://app.payap.com/join",
 "payUrl": "https://app.payap.com/pay",
 "logoMediaUploadId": "abcd",
 "primaryColorHex": "#abc123",
 "assetTypes": [
  {
   "id": "quartz.nzd"
  },
  {
   "id": "centrapay.token",
   "collectionId": "98h1d312"
  },
  {
   "id": "centrapay.token",
   "collectionId": "ca9h0221sacw"
  }
 ]
}
'
Response
{
  "id": "payap",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "createdByAccountName": "Payap",
  "createdAt": "2020-05-01T12:30:00.000Z",
  "status": "active",
  "url": "https://app.payap.com/join",
  "merchantId": "abc123",
  "logoMediaUploadId": "abcd",
  "logoImg": "imgLink",
  "primaryColorHex": "#abc123",
  "assetTypes": [
    {
      "id": "quartz.nzd"
    },
    {
      "id": "centrapay.token",
      "collectionId": "98h1d312"
    },
    {
      "id": "centrapay.token",
      "collectionId": "ca9h0221sacw"
    }
  ]
}