Sign in
Agreement modification

suspend agreement

post/payto/agreements/{agreement_uid}/suspension

Request body

reason'customer_requested' | 'initiating_party_requested' | 'mandate_suspended_final_collection' | 'mandate_suspended_one_collection' required

Reason for the agreement being suspended

narrativestring nullable

Free text field to store a description to accompany the given reason_code

Example request

{
  "reason": "initiating_party_requested",
  "narrative": "My custom description"
}

Response

accepted