Canopy API - Latest

Configure payment processor information for your organization

PUT /organization/payment_processors

Body

Set your payment processor configurations for your organization.

modern_treasury_config object
- api_key string | null Required
  
  Modern Treasury api key.
- org_id string | null Required
  
  Modern Treasury organization id.
- originating_account_id string | null Required
  
  Modern Treasury originating account id.
dwolla_config object
- app_key string | null Required
  
  Dwolla app key.
- app_secret string | null Required
  
  Dwolla app secret
- master_account string | null Required
  
  Your Dwolla master account.
stripe_config object
- api_url string | null Required
  
  Full url for Stripe's API.
- api_secret_key string | null Required
  
  Secret key used to authenticate with Stripe's API.
- webhook_url string | null Required
  
  Full url for the canopy webhook. This will be autogenerated if not provided.
- webhook_signing_key string | null Required
  
  Signing key to use for verifying the webhook caller.
repay_config object
- api_user string Required
  
  Your Repay API user key.
- api_token string Required
  
  Your Repay API access key.
- merchant_id string Required
  
  The merchant config value obtained from the corresponding payment processor.
authorize_net_config object
- merchant_name string | null Required
  
  Your Authorize.net merchant name.
- transaction_key string | null Required
  
  Your Authorize.net merchant transaction key.
- is_prod boolean | null
  
  Whether you are using production mode for Authorize.net.
checkout_config object
- public_key string | null Required
  
  Checkout.com public key
- processing_channel_id string | null
  
  A processing channel is the equivalent of a business line. In order to process your transactions you may need to denote which processing channel to process the transaction request on.
- secret_key string | null Required
  
  Checkout.com secret key.

Responses

• 200 object

Payment Processor configuration for your organization
- repay_config object
  api_user string | null Required
  
  Your Repay API user key.
  
  api_token string | null Required
  
  Your Repay API access key.
  
  merchant_id string | null Required
  
  The merchant config value obtained from the corresponding payment processor.
- authorize_net_config object
  merchant_name string | null Required
  
  Your Authorize.net merchant name.
  
  transaction_key string | null Required
  
  Your Authorize.net merchant transaction key.
  
  is_prod boolean | null
  
  Whether you are using production mode for Authorize.net.
- checkout_config object
  secret_key string | null Required
  
  Checkout.com secret key.
  
  public_key string | null Required
  
  Checkout.com public key
  
  processing_channel_id string | null
  
  A processing channel is the equivalent of a business line. In order to process your transactions you may need to denote which processing channel to process the transaction request on.
- dwolla_config object
  app_key string | null Required
  
  Dwolla app key.
  
  app_secret string | null Required
  
  Dwolla app secret
  
  master_account string | null Required
  
  Your Dwolla master account.
- modern_treasury_config object
  api_key string | null Required
  
  Modern Treasury app key.
  
  org_id string | null Required
  
  Modern Treasury organization id.
  
  originating_account_id string | null Required
  
  Your Modern Treasury originating account id.
- stripe_config object
  api_url string | null Required
  
  Full url for Stripe's API.
  
  api_client_id string | null
  
  Client ID used to authenticate with Stripe's API.
  
  api_secret_key string | null Required
  
  Secret key used to authenticate with Stripe's API.
  
  webhook_url string | null Required
  
  Full url for the canopy webhook. This will be autogenerated if not provided.
  
  webhook_signing_key string | null Required
  
  Signing key to use for verifying the webhook caller.
• 401

Unauthorized.
• 403

Forbidden.
• 422

Invalid input
• 429

Too many requests.
• default

Unexpected Error.

PUT /organization/payment_processors

curl \
 -X PUT https://<your_environment_name>-uat-api.canopyservicing.com/organization/payment_processors \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"repay_config":{"api_user":"string","api_token":"string","merchant_id":"87397472"},"authorize_net_config":{"merchant_name":"5KP3u95bQpv","transaction_key":"346HZ32z3fP4hTG2","is_prod":true},"checkout_config":{"secret_key":"string","public_key":"string","processing_channel_id":"string"},"modern_treasury_config":{"api_key":"string","org_id":"string","originating_account_id":"string"},"dwolla_config":{"app_key":"string","app_secret":"string","master_account":"string"},"stripe_config":{"api_url":"https://api.stripe.com/v1/","api_secret_key":"037609E9-1A48-4CD5-B4D3-FB76718A0A17","webhook_url":"https://api.canopyservicing.com/webhooks/stripe","webhook_signing_key":"F6FA6F42-9E9D-4C22-BCD6-24690E0F57BE"}}'

Request example

{
  "repay_config": {
    "api_user": "string",
    "api_token": "string",
    "merchant_id": "87397472"
  },
  "authorize_net_config": {
    "merchant_name": "5KP3u95bQpv",
    "transaction_key": "346HZ32z3fP4hTG2",
    "is_prod": true
  },
  "checkout_config": {
    "secret_key": "string",
    "public_key": "string",
    "processing_channel_id": "string"
  },
  "modern_treasury_config": {
    "api_key": "string",
    "org_id": "string",
    "originating_account_id": "string"
  },
  "dwolla_config": {
    "app_key": "string",
    "app_secret": "string",
    "master_account": "string"
  },
  "stripe_config": {
    "api_url": "https://api.stripe.com/v1/",
    "api_secret_key": "037609E9-1A48-4CD5-B4D3-FB76718A0A17",
    "webhook_url": "https://api.canopyservicing.com/webhooks/stripe",
    "webhook_signing_key": "F6FA6F42-9E9D-4C22-BCD6-24690E0F57BE"
  }
}

Response example (200)

{
  "repay_config": {
    "api_user": "234sdjlkfjas",
    "api_token": "238293749",
    "merchant_id": "87397472"
  },
  "authorize_net_config": {
    "merchant_name": "5KP3u95bQpv",
    "transaction_key": "346HZ32z3fP4hTG2",
    "is_prod": true
  },
  "checkout_config": {
    "secret_key": "string",
    "public_key": "string",
    "processing_channel_id": "string"
  },
  "dwolla_config": {
    "app_key": "8234-as3da6-23n20384d",
    "app_secret": "9df2903sdfk23084n0329048",
    "master_account": "273894723"
  },
  "modern_treasury_config": {
    "api_key": "key-n10283bnsd10283091n98102830",
    "org_id": "2d888ddsd79397d24ge9",
    "originating_account_id": "29314709237"
  },
  "stripe_config": {
    "api_url": "https://api.stripe.com/v1/",
    "api_client_id": "string",
    "api_secret_key": "037609E9-1A48-4CD5-B4D3-FB76718A0A17",
    "webhook_url": "https://api.canopyservicing.com/webhooks/stripe",
    "webhook_signing_key": "F6FA6F42-9E9D-4C22-BCD6-24690E0F57BE"
  }
}