Skip to content

Cancel payment plan

Request

Cancel payment plan

Security
bearer and basic and apiKey
Path
paymentPlanIdstringrequired

The Id of payment plan

curl -i -X POST \
  -u '<username>:<password>' \
  'https://test.paygate.nexigroup.com/api/v2/payment-plans/{paymentPlanId}/cancel' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
idstring

Unique identifer of the payment plan.

planStatusstring

Indicates if the payment method record was cancelled.

Enum:"ACTIVE""CANCELLED""INVALID""COMPLETED""RETRY"
cancellationDateany, (date-time)

Indicates the date when the payment plan was cancelled.

Response
{ "id": "string", "planStatus": "ACTIVE", "cancellationDate": null }