Go to home page
Docs API Reference

Sales Channels

A Sales Channel is a container for information to assist onboarding a Merchant to accept payment.

Sales Channel Model

Attributes

  • id

    string

    The unique identifier of the Sales Channel.

  • name

    string

    The display name of the Sales Channel.

  • type

    string

    The type of the Sales Channel integration either reseller or provider.

  • accountId

    string

    Id of the Account that owns the Sales Channel.

  • test

    boolean

    true if the Sales Channel is for testing purposes only. This is based on the Account that owns the Asset Program.

  • providerSalesChannelId

    string

    The id of the Sales Channel for the device provider. Required if type is reseller.

  • deviceId

    boolean

    true if a device id is required to onboard to Sales Channel.

  • deviceModel

    boolean

    true if a device model is required to onboard to Sales Channel.

  • deviceSerialNumber

    boolean

    true if a device serial number id is required to onboard to Sales Channel.

  • notificationEmail

    string

    Email to notify for requests to connect to Sales Channel.

  • notificationFrequency

    string

    Frequency of notification emails. Valid values are weekly and daily.

  • notificationUrl

    string

    Url for web hook notifications for requests to connect to Sales Channel.

  • createdAt

    timestamp

    When the Sales Channel was created.

  • createdBy

    crn

    The User or API Key that created the Sales Channel.

  • updatedAt

    timestamp

    When the Sales Channel was updated.

  • updatedBy

    crn

    The User or API Key that updated the Sales Channel.

Create Sales Channel experimental

This endpoint allows you to create an Sales Channel .

Attributes

  • name

    string required

    The display name of the Sales Channel.

  • type

    string required

    The type of the Sales Channel integration either reseller or provider.

  • accountId

    string required

    Id of the Account that owns the Sales Channel.

  • providerSalesChannelId

    string

    The id of the Sales Channel for the device provider. Required if type is reseller.

  • deviceId

    boolean

    true if the device id is required to onboard to Sales Channel.

  • deviceModel

    boolean

    true if the device model is required to onboard to Sales Channel.

  • deviceSerialNumber

    boolean

    true if a device serial number is required to onboard to Sales Channel.

  • notificationEmail

    string

    Email to notify for requests to connect to Sales Channel. Either notificationEmail or notificationUrl required.

  • notificationFrequency

    string

    Frequency of notification emails. Valid values are weekly and daily. Required if notificationEmail is set.

  • notificationUrl

    string

    Url for web hook notifications for requests to connect to Sales Channel. Either notificationEmail or notificationUrl required.

Errors

  • ACCOUNT_TYPE_INVALID

    403

    The Account must be type org.

Request
curl -X POST \
 https://service.centrapay.com/api/sales-channels \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "accountId": "Jaim1Cu1Q55uooxSens6yk",
 "deviceId": true,
 "deviceModel": true,
 "deviceSerialNumber": true,
 "externalId": true,
 "name": "My Sales Channel",
 "notificationEmail": "support@centrapay.com",
 "notificationFrequency": "weekly",
 "providerSalesChannelId": "5efbe17d96c083633e2b9241",
 "test": true,
 "type": "reseller"
}
'
Response
{
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "deviceId": true,
  "deviceModel": true,
  "deviceSerialNumber": true,
  "externalId": true,
  "id": "WRhAxxWpTKb5U7pXyxQjjY",
  "name": "My Sales Channel",
  "notificationEmail": "support@centrapay.com",
  "notificationFrequency": "weekly",
  "providerSalesChannelId": "5efbe17d96c083633e2b9241",
  "test": true,
  "type": "reseller",
  "updatedAt": "2021-08-25T00:02:49.488Z",
  "updatedBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99"
}