Go to home page
Docs API Reference

Connections

A Connection is a link between a Wallet and a Sales Channel.

Connection Model

Attributes

  • id

    string

    The unique identifier of the Connection.

  • createdBy

    crn

    The User or API Key that created the Connection.

  • createdByAccountName

    string

    The name of the Account that created the Connection.

  • createdAt

    timestamp

    When the Connection was created.

  • status

    string

    The status of the Connection.

  • url

    string

    The url of the Connection.

  • merchantId

    string

    The Merchant the Connection is made on behalf of.

  • test

    boolean

    true if the Connection is for testing purposes only.

Create Connection experimental

This endpoint allows you to create a Connection .

Attributes

  • merchantId

    string required

    The Merchant to create the Connection on behalf of.

Request
curl -X POST \
 https://service.centrapay.com/api/connections \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "merchantId": "abcde"
}
'
Response
{
  "id": "1234",
  "createdBy": "crn:1234abc:api-key:MyAPIKey",
  "createdByAccountName": "Salespoint",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "status": "created",
  "url": "https://app.centrapay.com/connect/1234",
  "merchantId": "abcde"
}

Authorize Connection experimental

This endpoint allows you to authorize a Connection .

Attributes

  • walletId

    string required

    The ID of the wallet that is authorizing the Connection

Request
curl -X POST \
 https://service.centrapay.com/api/connections/1234/authorize \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "walletId": "vendswift-nz"
}
'
Response
{
  "id": "1234",
  "createdBy": "crn:1234abc:api-key:MyAPIKey",
  "createdByAccountName": "Salespoint",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "status": "created",
  "url": "https://app.centrapay.com/connect/1234",
  "updatedBy": "crn:1234abc:api-key:MyAPIKey",
  "updatedAt": "2022-08-25T00:02:49.488Z",
  "walletId": "vendswift-nz",
  "walletName": "VendSwift"
}