Managed Integrations - Centrapay Docs

A Managed Integration is an Integration API which a third party can control.

Managed Integration Model

Attributes

id
string
The Managed Integration’s unique identifier.
type
string
The type of Managed Integration. Supported types are paypal-referral.
enabled
boolean
Flag indicating whether the Managed Integration should become active or inactive.
status
string
Current status of the Managed Integration. Supported values are created, pending, provisioning, active, inactive and archived.
externalId
string
Field used to reference an id from an external system.
params
object
Params depending on the Managed Integration type.
createdAt
timestamp
When the Managed Integration was created.
createdBy
crn
The User or API Key that created the Managed Integration.
updatedAt
timestamp
When the Managed Integration was updated.
updatedBy
crn
The User or API Key that updated the Managed Integration.
claimedByAccountId
string
Centrapay account id used to claim the Managed Integration.
claimedBy
crn
The User or API Key that claimed the Managed Integration.
claimedAt
timestamp
When the Managed Integration was claimed.
invitation
object
A summary of the associated Invitation API . See Invitation Summary.
inProgress
boolean
Flag indicating whether a status transition is in progress.
test
boolean
A flag which is present if the Managed Integration is for testing.

Invitation Summary Model

A summary of the Invitation API for a Managed Integration.

Attributes

id
string
The Invitation’s unique identifier.
code
string
The Invitation code.
expiresAt
timestamp
When the Invitation expires.

Merchant Model

Attributes

partnerMerchantId
stringrequired
The unique id of the merchant in your system.
merchantName
stringrequired
The name of the merchant.
merchantStreetNumberName
stringrequired
The street number and name where the merchant is located.
merchantSuburb
stringrequired
The suburb where the merchant is located.
merchantTown
stringrequired
The town where the merchant is located.
merchantCountry
stringrequired
The country where the merchant is located.
merchantPostCode
stringrequired
The post code where the merchant is located.
merchantCategoryCode
string
The merchant category code.
settlementAcct
stringrequired
The bank account number for settlement.
chargeAcct
string
The bank account number for charges.
merchantContactName
stringrequired
The merchant contact name.
merchantEmail
stringrequired
The merchant email address.
merchantContactNumber
string
The merchant contact number
terminals
object
Array of Terminal information.

Terminal Model

Attributes

provider
objectrequired
The terminal provider Request. Refer to Integration Types API .
terminalId
stringrequired
The software or logical id of the payment terminal.
kitId
stringrequired
The hardware id or serial number of the payment terminal.
reseller
string
The terminal reseller.
kitType
string
The model of the payment terminal.

Params Model

paypal-referral

Attributes

centrapayMerchantId
string
The ID of the Centrapay merchant that will be onboarded.
email
string
The email address to send the PayPal referral to.

quartz-business

Attributes

partnerBusinessId
stringrequired
The unique id of the business in your system.
nzbn
string
The unique NZBN identifier.
companyName
stringrequired
The name of the company.
tradingName
string
The trading name of the company.
entityType
string
The type of the entity.
businessStreetNumberName
string
The street number and name where the business is located.
businessSuburb
string
The suburb where the business is located.
businessTown
string
The town where the business is located.
businessCountry
string
The country where the business is located.
businessPostCode
string
The post code where the business is located.
primaryContactName
stringrequired
The name of the primary contact of the business.
primaryContactEmail
stringrequired
The email address of the primary contact of the business.
merchants
object
Array of Merchant information.

PUT/api/managed-integrations/{type}/{externalId}

Create or Update Managed Integration

This endpoint allows you to create or update a Managed Integration.

Attributes

enabled
booleanrequired
Flag indicating whether the Managed Integration should become active or inactive.
params
objectrequired
Params depending on the Managed Integration type.
test
boolean
Flag indicating the Managed Integration is for testing, this cannot be changed once the resource has been created.

Errors

INVALID_PARAMS
400
Invalid Params provided for Managed Integration type.
MERCHANT_LIVENESS_MISMATCH
403
The test flag on the merchant doesn’t match the test flag on the paypal-referral managed integration.
MERCHANT_NOT_FOUND
403
The merchant is not found with the centrapayMerchantId on the paypal-referral managed integration.

Request

PUT/api/managed-integrations/paypal-referral/DKTs3U38hdhfEqwF1JKoT2

curl -X PUT \
 https://service.centrapay.com/api/managed-integrations/paypal-referral/DKTs3U38hdhfEqwF1JKoT2 \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "enabled": true,
 "params": {
  "centrapayMerchantId": "5ffcaf432003060007b98343",
  "email": "test@centrapay.com"
 }
}
'

Response

{
  "id": "5ee0c486308f590260d9a07f",
  "type": "paypal-referral",
  "externalId": "DKTs3U38hdhfEqwF1JKoT2",
  "enabled": true,
  "params": {
    "centrapayMerchantId": "5ffcaf432003060007b98343",
    "email": "test@centrapay.com"
  },
  "status": "provisioning",
  "claimedByAccountId": "Jaim1Cu1Q55uooxSens6yk",
  "claimedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "claimedAt": "2020-06-12T01:17:46.499Z",
  "inProgress": true,
  "createdAt": "2020-06-11T01:17:46.499Z",
  "createdBy": "crn:BIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedAt": "2020-06-12T01:17:46.499Z",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}

GET/api/managed-integrations/{type}/{externalId}

Get Managed Integration

This endpoint allows you to retrieve a Managed Integration by type and external id.

Request

GET/api/managed-integrations/paypal-referral/DKTs3U38hdhfEqwF1JKoT2

curl -X GET \
 https://service.centrapay.com/api/managed-integrations/paypal-referral/DKTs3U38hdhfEqwF1JKoT2 \
 -H 'x-api-key: <TOKEN>'

Response

{
  "id": "5ee0c486308f590260d9a07f",
  "type": "paypal-referral",
  "externalId": "DKTs3U38hdhfEqwF1JKoT2",
  "enabled": true,
  "params": {
    "centrapayMerchantId": "5ffcaf432003060007b98343",
    "email": "test@centrapay.com"
  },
  "status": "provisioning",
  "claimedByAccountId": "Jaim1Cu1Q55uooxSens6yk",
  "claimedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "claimedAt": "2020-06-12T01:17:46.499Z",
  "inProgress": true,
  "createdAt": "2020-06-11T01:17:46.499Z",
  "createdBy": "crn:BIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedAt": "2020-06-12T01:17:46.499Z",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}

GET/api/accounts/{accountId}/managed-integrations

List Managed Integration

This endpoint allows you to retrieve the list of managed integrations for an account. Returns a paginated API list of Managed Integrations for an Account.

Attributes

pageKey
string
Used to retrieve the next page of items.

Request

GET/api/accounts/Jaim1Cu1Q55uooxSens6yk/managed-integrations

curl -X GET \
 'https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/managed-integrations?pageKey=Collection%23k9oBPAOgjz4k6a9MXNfRlFzn%7C%23Collection%7C4xb2jbtvgr07eax9259od5he' \
 -H 'x-api-key: <TOKEN>'

Response

{
  "nextPageKey": "Collection#ujk6nDuqFueXNGndXj8Qp9hU|#Collection",
  "items": [
    {
      "id": "5ee0c486308f590260d9a07f",
      "type": "paypal-referral",
      "externalId": "DKTs3U38hdhfEqwF1JKoT2",
      "enabled": true,
      "params": {
        "centrapayMerchantId": "5ffcaf432003060007b98343",
        "email": "test@centrapay.com"
      },
      "status": "provisioning",
      "claimedByAccountId": "Jaim1Cu1Q55uooxSens6yk",
      "claimedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "claimedAt": "2020-06-12T01:17:46.499Z",
      "inProgress": true,
      "createdAt": "2020-06-11T01:17:46.499Z",
      "createdBy": "crn:BIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "updatedAt": "2020-06-12T01:17:46.499Z",
      "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
    },
    {
      "id": "4maj50b6fdhmv0v38yrgjzdh",
      "type": "paypal-referral",
      "externalId": "alL3YQEGeY5WLu5uSFbM0tb3",
      "enabled": true,
      "params": {
        "centrapayMerchantId": "7aqasjid5kbcp7wquopoe4dg",
        "email": "test2@centrapay.com"
      },
      "status": "provisioning",
      "claimedByAccountId": "Jaim1Cu1Q55uooxSens6yk",
      "claimedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "claimedAt": "2020-07-12T01:18:46.499Z",
      "inProgress": true,
      "createdAt": "2020-07-11T01:18:46.499Z",
      "createdBy": "crn:BIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "updatedAt": "2020-07-12T01:18:46.499Z",
      "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
    }
  ]
}

Managed Integration Model

Attributes

id

type

enabled

status

externalId

params

createdAt

createdBy

updatedAt

updatedBy

claimedByAccountId

claimedBy

claimedAt

invitation

inProgress

test

Invitation Summary Model

Attributes

id

code

expiresAt

Merchant Model

Attributes

partnerMerchantId

merchantName

merchantStreetNumberName

merchantSuburb

merchantTown

merchantCountry

merchantPostCode

merchantCategoryCode

settlementAcct

chargeAcct

merchantContactName

merchantEmail

merchantContactNumber

terminals

Terminal Model

Attributes

provider

terminalId

kitId

reseller

kitType

Params Model

paypal-referral

Attributes

centrapayMerchantId

email

quartz-business

Attributes

partnerBusinessId

nzbn

companyName

tradingName

entityType

businessStreetNumberName

businessSuburb

businessTown

businessCountry

businessPostCode

primaryContactName

primaryContactEmail

merchants

Create or Update Managed Integration

Attributes

enabled

params

test

Errors

INVALID_PARAMS

MERCHANT_LIVENESS_MISMATCH

MERCHANT_NOT_FOUND

Get Managed Integration

List Managed Integration

Attributes

pageKey