diff --git a/api/account-memberships/index.html b/api/account-memberships/index.html index 90ceb5750..3d343177b 100644 --- a/api/account-memberships/index.html +++ b/api/account-memberships/index.html @@ -19,7 +19,7 @@
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs

Integration Requests

An Integration Request allows Centrapay users to request the creation of an Integration  API  on a Centrapay Account.

+

Integration Requests

An Integration Request allows Centrapay users to request the creation of an Integration  API  on a Centrapay Account.

Integration Request Model

Attributes

Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs

Merchant Configs

A Merchant Config defines the available payment options for paying a Payment Request  API .

+

Merchant Configs

A Merchant Config defines the available payment options for paying a Payment Request  API .

Merchant Config Model

Attributes

Payment Option Config Model

Attributes

  • type

    stringrequired

    Type of payment method. See supported payment types below.

  • walletId

    string

    Merchant’s Centrapay Settlement Wallet to receive payments. Optional for centrapay.nzd types, if not supplied then a settlement wallet may be created and then assigned.

  • paypalMerchantAccountId

    string

    Id of the PayPal merchants account. Required for paypal.usd and venmo.usd types.

  • paypalStoreId

    string

    Id of the PayPal merchants store. Required for paypal.usd and venmo.usd types.

  • farmlandsMerchantNumber

    string

    Id of the Farmlands merchant that funds will be transferred to.

  • externalMerchantId

    string

    Id of the external merchant. Required for epay, stadius, quartz, and uplinkapi.test types.

+

  • type

    stringrequired

    Type of payment method. See supported payment types below.

  • walletId

    string

    Merchant’s Centrapay Settlement Wallet to receive payments. Optional for centrapay.nzd types, if not supplied then a settlement wallet may be created and then assigned.

  • paypalMerchantAccountId

    string

    Id of the PayPal merchants account. Required for paypal.usd and venmo.usd types.

  • paypalStoreId

    string

    Id of the PayPal merchants store. Required for paypal.usd and venmo.usd types.

  • farmlandsMerchantNumber

    string

    Id of the Farmlands merchant that funds will be transferred to.

  • externalMerchantId

    string

    Id of the external merchant. Required for epay, stadius, quartz, and uplinkapi.test types.

  • collectionIds

    string

    Id of the Token Collection  API , can be discount collection type. Required for centrapay.ledger types.

See Asset Types  API  for values that may be present in the type field.

Test payment options should never be used for live merchant configurations.

@@ -50,7 +50,7 @@ Collapse all

  • paymentOptions

    arrayrequired

    A list of Payment Option Configs.

  • allowedRedirectUrls

    arrayexperimental

    Allowed prefixes for the redirectUrl property on Payment Requests created with this Config.

Errors

Request
POST/api/merchants/5ee0c486308f590260d9a07f/configs
curl -X POST \
+

  • INVALID_WALLET_TYPE

    403

    walletId does not belong to a Settlement Wallet  API .

  • LIVENESS_MISMATCH

    403

    Only Merchants  API  with the test flag can have merchant configs with test assets, vice versa

  • COLLECTIONS_INVALID

    403

    An item in the collectionIds array does not exist or does not belong to a supported collection type.

Request
POST/api/merchants/5ee0c486308f590260d9a07f/configs
curl -X POST \
  https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/configs \
  -H 'content-type: application/json' \
  -H 'x-api-key: <TOKEN>' \
@@ -167,7 +167,7 @@
 Collapse all

  • paymentOptions

    arrayrequired

    A list of Payment Option Configs.

  • allowedRedirectUrls

    arrayexperimental

    Allowed prefixes for the redirectUrl property on Payment Requests created with this Config.

Errors

Request
PUT/api/merchants/5ee0c486308f590260d9a07f/configs/mc_5ee168e8597be5002af7baed
curl -X PUT \
+

  • INVALID_WALLET_TYPE

    403

    walletId does not belong to a Settlement Wallet  API .

  • LIVENESS_MISMATCH

    403

    Only Merchants  API  with the test flag can have merchant configs with test assets, vice versa

  • COLLECTIONS_INVALID

    403

    An item in the collectionIds array does not exist or does not belong to a supported collection type.

Request
PUT/api/merchants/5ee0c486308f590260d9a07f/configs/mc_5ee168e8597be5002af7baed
curl -X PUT \
  https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/configs/mc_5ee168e8597be5002af7baed \
  -H 'content-type: application/json' \
  -H 'x-api-key: <TOKEN>' \
diff --git a/api/merchants/index.html b/api/merchants/index.html
index 9ab9b496f..0a53676c8 100644
--- a/api/merchants/index.html
+++ b/api/merchants/index.html
@@ -19,7 +19,7 @@
 
 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs