Deactivate Funding Rule
Move a funding rule to INACTIVE so it stops applying to incoming funds.
Deactivate a funding rule when it should no longer split incoming funds. Deactivation moves the rule to INACTIVE status; it stays on record for reference and reporting but is no longer applied to matching inbound transactions.
Deactivation is the way to retire a rule; only a Program Manager can deactivate a funding rule, and only rules currently in
ACTIVEstatus can be deactivated.
Deactivate a funding rule
Make a POST request to /v1/fundingRule/id/{id}/deactivate (or /v1/fundingRule/externalId/{externalId}/deactivate):
POST /v1/fundingRule/id/{id}/deactivate
POST /v1/fundingRule/externalId/{externalId}/deactivateThe request body is empty.
Example
Request
POST /v1/fundingRule/id/14/deactivate
{}On success the API returns 204 No Content, the rule moves to INACTIVE, and it stops applying to incoming funds.
Response
204 No Content
See also
- Funding Rules overview: statuses and business validations
- Retrieve Funding Rule: confirm the rule's status after deactivation
- List Funding Rules: find active rules to deactivate
- Error Codes and Messages: reason and return codes when a deactivate fails
Updated about 6 hours ago