Go to home page

Asset Program Configs

An Asset Program Config defines how an Asset Program is configured for a specific merchant. It is created after a merchant has an approved Asset Program Membership and wants to enable the asset program for payments.

An Asset Program Config manages the relationship between a specific merchant and an Asset Program, defining how the program's assets will be configured as payment options for that merchant. These configs can be created even if the Asset Program Membership is not yet fully in effect, but they will only become active when all requirements are met: the membership must be both approved by the asset program owner and accepted by the business account. This allows businesses to prepare their payment configurations in advance while ensuring proper authorization before assets can be accepted as payments.

Asset Program Config Model

Attributes

  • id

    string

    The unique identifier of the Asset Program Config.

  • assetProgramId

    string

    The id of the Asset Program the Config belongs to.

  • assetProgramMembershipId

    string

    The id of the Asset Program Membership the Config belongs to.

  • merchantId

    string

    The id of the Merchant associated with the config.

  • accountId

    string

    The Account that owns the Merchant.

  • enabled

    boolean

    true if the Asset Program Config is enabled for payments.

  • status

    string

    The status of the Asset Program Config. Possible values: active, disabled.

  • test

    boolean

    true if the Asset Program Config is for testing purposes only.

  • createdAt

    timestamp

    When the Asset Program Config was created.

  • createdBy

    crn

    The User or API Key that created the Asset Program Config.

  • updatedAt

    timestamp

    When the Asset Program Config was updated.

  • updatedBy

    crn

    The User or API Key that updated the Asset Program Config.

Create Asset Program Config experimental

This endpoint allows you to create an Asset Program Config for an approved Asset Program Membership.

Attributes

Errors

  • ASSET_PROGRAM_MEMBERSHIP_NOT_APPROVED

    403

    The Asset Program Membership must be approved before creating a config.

  • MERCHANT_ACCOUNT_MISMATCH

    403

    The Merchant must belong to the same account as the Asset Program Membership.

Request
curl -X POST https://service.centrapay.com/api/asset-program-memberships/apm_Xv990BzkgfoDS7bBls50pd/asset-program-configs \
-H 'content-type: application/json' \
-H 'x-api-key: <TOKEN>' \
-d '{
  "merchantId": "5ee0c486308f590260d9a07f"
}'
Response
{
  "id": "apc_WRhAxxWpTKb5U7pXyxQjjY",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
  "assetProgramMembershipId": "apm_Xv990BzkgfoDS7bBls50pd",
  "merchantId": "5ee0c486308f590260d9a07f",
  "enabled": true,
  "status": "active",
  "test": false,
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "updatedAt": "2021-08-25T00:02:49.488Z",
  "updatedBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99"
}

Get Asset Program Config experimental

This endpoint allows you to retrieve a specific Asset Program Config.

Attributes

  • id

    stringrequired

    The unique identifier of the Asset Program Config.

Request
curl -X GET https://service.centrapay.com/api/asset-program-configs/apc_WRhAxxWpTKb5U7pXyxQjjY \
-H 'x-api-key: <TOKEN>'
Response
{
  "id": "apc_WRhAxxWpTKb5U7pXyxQjjY",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
  "assetProgramMembershipId": "apm_Xv990BzkgfoDS7bBls50pd",
  "merchantId": "5ee0c486308f590260d9a07f",
  "enabled": true,
  "status": "active",
  "test": true,
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "updatedAt": "2021-08-25T00:02:49.488Z",
  "updatedBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99"
}

List Asset Program Configs by Asset Program experimental

This endpoint allows you to list Asset Program Configs for a specific Asset Program.

Attributes

  • id

    stringrequired

    The unique identifier of the Asset Program.

  • pageKey

    string

    The page key used in pagination to fetch the next page of results.

  • paginationLimit

    number

    The maximum number of results per page. Maximum value is 100. Defaults to 50.

Response

  • items

    array

    The list of Asset Program Configs.

  • nextPageKey

    string

    The page key to use for fetching the next page of results, if more results are available.

Request
curl -X GET https://service.centrapay.com/api/asset-programs/ap_WRhAxxWpTKb5U7pXyxQjjY/asset-program-configs \
-H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "id": "apc_WRhAxxWpTKb5U7pXyxQjjY",
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
      "assetProgramMembershipId": "apm_Xv990BzkgfoDS7bBls50pd",
      "merchantId": "5ee0c486308f590260d9a07f",
      "enabled": true,
      "status": "active",
      "test": true,
      "createdAt": "2021-08-25T00:02:49.488Z",
      "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
      "updatedAt": "2021-08-25T00:02:49.488Z",
      "updatedBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99"
    }
  ],
  "nextPageKey": "eyJjcmVhdGVkQXQiOiIyMDIxLTA4LTI1VDAwOjAyOjQ5LjQ4OFoifQ=="
}

List Asset Program Configs by Account experimental

This endpoint allows you to list Asset Program Configs for a specific Account.

Attributes

  • id

    stringrequired

    The unique identifier of the Account.

  • pageKey

    string

    The page key used in pagination to fetch the next page of results.

  • paginationLimit

    number

    The maximum number of results per page. Maximum value is 100. Defaults to 50.

Response

  • items

    array

    The list of Asset Program Configs.

  • nextPageKey

    string

    The page key to use for fetching the next page of results, if more results are available.

Request
curl -X GET https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/asset-program-configs \
-H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "id": "apc_WRhAxxWpTKb5U7pXyxQjjY",
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
      "assetProgramMembershipId": "apm_Xv990BzkgfoDS7bBls50pd",
      "merchantId": "5ee0c486308f590260d9a07f",
      "enabled": true,
      "status": "active",
      "test": true,
      "createdAt": "2021-08-25T00:02:49.488Z",
      "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
      "updatedAt": "2021-08-25T00:02:49.488Z",
      "updatedBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99"
    }
  ],
  "nextPageKey": "eyJjcmVhdGVkQXQiOiIyMDIxLTA4LTI1VDAwOjAyOjQ5LjQ4OFoifQ=="
}