Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The response will contain the id of the new recurrence.

Stopping recurrences

This endpoints endpoint facilitates the stopping of a recurrence. Note: this request requires you send a bearer token in the Authorization header.

...

Code Block
{
    "message": "recurrence",
    "details": {
        "id": 1
    }
}

Triggering a recurrence

This endpoint facilitates the triggering of a recurrence. This means that a new payment is instantiated using the properties from the existing periodic recurrence (and using the Mandate created based on the initial payment), overwriting them with the amount and description provided in the request body.

Note: this request requires you send a bearer token in the Authorization header.

Note2: if the Mandate supporting this recurrence has been stopped or has expired, a new payment will not be created. See the Mandates page for more information about Mandates.

Note3: triggering a recurrence has no effect on the scheduling of the recurrence.

Url: https://sandbox.globadyme.com/api/globadymeGateway/recurrence/triggerRecurring

Example:

Code Block
{
    "recurrenceId": 2,
    "amount": 11.22,
    "description": "test of triggerRecurring"
}

Mandatory fields:

  • recurrenceId: The ID of the recurrence to be triggered.

  • amount: The amount to be transfered in this new payment.

  • description: The description to be

Example response:

Code Block
{
    "message": "payment",
    "details": {
        "transactionId": "8ee67b0c-0056-44b5-b56b-cf952589582f"
    }
}