Go to home page
Docs API Reference

Asset Program Memberships

A Membership to an Asset Program .

An Asset Program Membership represents the formal relationship between a business account and an Asset Program. This membership must be approved by the asset program owner and accepted by the business account to be in effect. The membership establishes the business's eligibility to participate in the Asset Program and is a prerequisite for Asset Program Configs to become active. While Asset Program Configs can be created at any time, they will only become active once both approval and acceptance are complete, allowing merchants to accept the program's assets as payment.

Asset Program Membership Model

Attributes

  • id

    string

    The unique identifier of the Asset Program Membership.

  • assetProgramId

    string

    The id of the Asset Program the Membership belongs to.

  • merchantId

    string

    The id of the Merchant associated with the membership.

  • accountId

    string

    The Account that owns the Merchant .

  • status

    string

    The status of the Asset Program Membership. Possible values: created, accepted, approved.

  • tosAcceptedAt

    timestamp

    When the Asset Program Membership terms of service were accepted.

  • approvedAt

    timestamp

    When the Asset Program Membership was approved by the Asset Program owner.

  • test

    boolean

    true if the Asset Program Membership is for testing purposes only. This is based on the Asset Program.

  • createdAt

    timestamp

    When the Asset Program Membership was created.

  • createdBy

    crn

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

  • updatedAt

    timestamp

    When the Asset Program Membership was updated.

  • updatedBy

    crn

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

Create Asset Program Membership experimental

This endpoint allows you to create an Asset Program Membership .

Attributes

  • assetProgramId

    string required

    The id of the Asset Program the Membership belongs to.

  • accountId

    string required

    The Account that owns the Merchant .

  • accept

    boolean

    true to automatically accept the terms of service for the membership. Requires asset-program-memberships:accept permission on the account.

  • approve

    boolean

    true to automatically approve the membership. Requires asset-program-memberships:approve permission on the Asset Program owner account.

Errors

  • ACCOUNT_TYPE_INVALID

    403

    The Account must be type org.

  • LIVENESS_MISMATCH

    403

    The liveness of the Account doesn't match the liveness of the Asset Program .

Request
curl -X POST \
 https://service.centrapay.com/api/asset-program-memberships \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
 "accountId": "Jaim1Cu1Q55uooxSens6yk",
 "accept": true,
 "approve": false
}
'
Response
{
  "id": "apm_Xv990BzkgfoDS7bBls50pd",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
  "status": "accepted",
  "test": true,
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "updatedAt": "2021-08-25T00:03:15.123Z",
  "updatedBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "tosAcceptedAt": "2021-08-25T00:03:15.123Z",
  "approvedAt": null
}

Get Asset Program Membership experimental

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

Attributes

  • id

    string required

    The unique identifier of the Asset Program Membership.

Request
curl -X GET \
 https://service.centrapay.com/api/asset-program-memberships/apm_Xv990BzkgfoDS7bBls50pd \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "apm_Xv990BzkgfoDS7bBls50pd",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
  "status": "approved",
  "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",
  "tosAcceptedAt": "2021-08-25T00:03:15.123Z",
  "approvedAt": "2021-08-25T00:05:30.456Z"
}

List Asset Program Memberships by Asset Program experimental

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

Attributes

  • id

    string required

    The unique identifier of the Asset Program.

  • status

    string required

    Filter memberships by status. Possible values: created, accepted, approved.

  • 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 Memberships.

  • 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-memberships?status=approved' \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "id": "apm_Xv990BzkgfoDS7bBls50pd",
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
      "status": "approved",
      "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",
      "tosAcceptedAt": "2021-08-25T00:03:15.123Z",
      "approvedAt": "2021-08-25T00:05:30.456Z"
    }
  ],
  "nextPageKey": "eyJjcmVhdGVkQXQiOiIyMDIxLTA4LTI1VDAwOjAyOjQ5LjQ4OFoifQ=="
}

List Asset Program Memberships by Account experimental

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

Attributes

  • id

    string required

    The unique identifier of the Account.

  • status

    string

    Filter memberships by status. Possible values: created, accepted, approved.

  • 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 Memberships.

  • 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-memberships \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "id": "apm_Xv990BzkgfoDS7bBls50pd",
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
      "status": "approved",
      "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",
      "tosAcceptedAt": "2021-08-25T00:03:15.123Z",
      "approvedAt": "2021-08-25T00:05:30.456Z"
    }
  ],
  "nextPageKey": "eyJjcmVhdGVkQXQiOiIyMDIxLTA4LTI1VDAwOjAyOjQ5LjQ4OFoifQ=="
}

Accept Asset Program Membership experimental

This endpoint allows you to accept the terms of service for an Asset Program Membership .

Attributes

  • id

    string required

    The unique identifier of the Asset Program Membership.

Request
curl -X POST \
 https://service.centrapay.com/api/asset-program-memberships/apm_Xv990BzkgfoDS7bBls50pd/accept \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "apm_Xv990BzkgfoDS7bBls50pd",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
  "status": "accepted",
  "test": true,
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "updatedAt": "2021-08-25T00:03:15.123Z",
  "updatedBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "tosAcceptedAt": "2021-08-25T00:03:15.123Z",
  "approvedAt": null
}

Approve Asset Program Membership experimental

This endpoint allows you to approve an Asset Program Membership . This action can only be performed by the Asset Program owner.

Attributes

  • id

    string required

    The unique identifier of the Asset Program Membership.

Request
curl -X POST \
 https://service.centrapay.com/api/asset-program-memberships/apm_Xv990BzkgfoDS7bBls50pd/approve \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "apm_Xv990BzkgfoDS7bBls50pd",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
  "status": "approved",
  "test": true,
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "updatedAt": "2021-08-25T00:05:30.456Z",
  "updatedBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "tosAcceptedAt": "2021-08-25T00:03:15.123Z",
  "approvedAt": "2021-08-25T00:05:30.456Z"
}