Go to home page
Docs API Reference

Asset Program Memberships

A Membership to an Asset Program .

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 .

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

  • merchantId

    string required

    The id of the Merchant associated with the membership.

Errors

  • ACCOUNT_TYPE_INVALID

    403

    The Account must be type org.

  • MERCHANT_ACCOUNT_MISMATCH

    403

    The accountId on the Merchant doesn't match the accountId provided.

  • LIVENESS_MISMATCH

    403

    The liveness of the Account does'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",
 "merchantId": "5ee0c486308f590260d9a07f"
}
'
Response
{
  "id": "apm_Xv990BzkgfoDS7bBls50pd",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "merchantId": "5ee0c486308f590260d9a07f",
  "assetProgramId": "ap_WRhAxxWpTKb5U7pXyxQjjY",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "test": true,
  "updatedAt": "2021-08-25T00:02:49.488Z",
  "updatedBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99"
}