Configure nacha report details for your organization

PUT /organization/nacha_config

Body

Set your NACHA reporting configurations for your organization.

  • nacha_destination_config object
  • nacha_origin_config object
  • payouts_source object
    • default object
      • payout_entity_id string

        This is the payout entity from which payouts on the NACHA file will be sent if the payments that drive those payments were completed without using a canopy payment processor integration.

    • ach object
      • payout_entity_id string

        This is the payout entity from which payouts on the NACHA file will be sent if the payments that drive those payments were completed using a canopy ACH payment processor integration.

    • debit object
      • payout_entity_id string

        This is the payout entity from which payouts on the NACHA file will be sent if the payments that drive those payments were completed using a canopy DEBIT payment processor integration.

    • credit object
      • payout_entity_id string

        This is the payout entity from which payouts on the NACHA file will be sent if the payments that drive those payments were completed using a canopy CREDIT payment processor integration.

  • is_balanced_nacha boolean

    When true, NACHA files generated will include an offsetting entry for each entry present, creating a balanced NACHA file. When false, Canopy will generate unbalanced NACHA files in which the offsetting transaction details are inferred from the Company Identification Number in the batch header.

    Default value is false.

Responses

  • • 200 object

    NACHA configuration for your organization

    • nacha_destination_config object
      • bank_name string

        The name of the bank for the immediate_destination to appear in the file header record of your NACHA files.

      • bank_routing_number string

        The routing number of the bank for the immediate_destination to appear in the file header record of your NACHA files.

    • nacha_origin_config object
      • bank_name string

        The name of the bank for the immediate_origin to appear in the file header record of your NACHA files.

      • bank_routing_number string

        The routing number of the bank for the immediate_origin to appear in the file header record of your NACHA files.

    • payouts_source object
      • default object
        • payout_entity_id string

          This is the payout entity from which payouts on the NACHA file will be sent if the payments that drive those payments were completed without using a canopy payment processor integration.

      • ach object
        • payout_entity_id string

          This is the payout entity from which payouts on the NACHA file will be sent if the payments that drive those payments were completed using a canopy ACH payment processor integration.

      • debit object
        • payout_entity_id string

          This is the payout entity from which payouts on the NACHA file will be sent if the payments that drive those payments were completed using a canopy DEBIT payment processor integration.

      • credit object
        • payout_entity_id string

          This is the payout entity from which payouts on the NACHA file will be sent if the payments that drive those payments were completed using a canopy CREDIT payment processor integration.

    • is_balanced_nacha boolean

      When true, NACHA files generated will include an offsetting entry for each entry present, creating a balanced NACHA file. When false, Canopy will generate unbalanced NACHA files in which the offsetting transaction details are inferred from the Company Identification Number in the batch header.

      Default value is false.

  • • 401

    Unauthorized.

  • • 403

    Forbidden.

  • • 422

    Invalid input

  • • 429

    Too many requests.

  • • default

    Unexpected Error.

PUT /organization/nacha_config 
curl \
 -X PUT https://<your_environment_name>-uat-api.canopyservicing.com/organization/nacha_config \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"nacha_destination_config":{"bank_name":"DEST/BANK","bank_routing_number":"064000101"},"nacha_origin_config":{"bank_name":"ORIG/BANK","bank_routing_number":"064008637"},"payouts_source":{"default":{"payout_entity_id":"0x1234"},"ach":{"payout_entity_id":"0x1234"},"debit":{"payout_entity_id":"0x1234"},"credit":{"payout_entity_id":"0x1234"}},"is_balanced_nacha":true}'
Request example 
{
  "nacha_destination_config": {
    "bank_name": "DEST/BANK",
    "bank_routing_number": "064000101"
  },
  "nacha_origin_config": {
    "bank_name": "ORIG/BANK",
    "bank_routing_number": "064008637"
  },
  "payouts_source": {
    "default": {
      "payout_entity_id": "0x1234"
    },
    "ach": {
      "payout_entity_id": "0x1234"
    },
    "debit": {
      "payout_entity_id": "0x1234"
    },
    "credit": {
      "payout_entity_id": "0x1234"
    }
  },
  "is_balanced_nacha": true
}
Response example (200) 
{
  "nacha_destination_config": {
    "bank_name": "CRU OHIO",
    "bank_routing_number": "064000101"
  },
  "nacha_origin_config": {
    "bank_name": "WEIR TN",
    "bank_routing_number": "064000101"
  },
  "payouts_source": {
    "default": {
      "payout_entity_id": "0x1234"
    },
    "ach": {
      "payout_entity_id": "0x1234"
    },
    "debit": {
      "payout_entity_id": "0x1234"
    },
    "credit": {
      "payout_entity_id": "0x1234"
    }
  },
  "is_balanced_nacha": true
}