Versions Compared

Key

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

...

In this case one can check if there is any transaction with a “PROCESSED” status to confirm that a successful payment has been made.

Changing recurrences

After creating a recurrence, it may be desirable to change properties of this recurrence.
In order to do so, one can send a changeRecurrence request.

Note: this request requires you send a bearer token in the Authorization header.
Note2: the existing recurrence will end effective immediately.

Url: https://sandbox,globadyme.com/api/globadymeGateway/recurrence/changeRecurring

Example:

Code Block
{
    "recurrenceFrequency" : "YEARLY",
    "recurrenceAmount" : 44,
    "startDate": "2101-01-01",
    "transactionId": "891ea6b3-0fbb-4a93-8e03-80f0967ee704",
    "description": "newer recurrence description",
    "id": 1
}

Mandatory fields:

  • recurrenceFrequency: The new frequency at which executions should take place. Note: This frequency will start after the startDate parameter. Possible values:

    • YEARLY

    • QUARTERLY

    • MONTHLY

    • WEEKLY

    • DAILY

  • recurrenceAmount: The amount to be transferred at each execution.

  • startDate: The date at which the new recurrence should take effect.

  • transactionId: The ID of the original transaction on which the original authorization was given.

  • description: The description for the new recurrence.

  • id: The ID of the recurrence to be replaced by the new recurrence.

Example response:

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

The response will contain the id of the new recurrence.

Stopping recurrences

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

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

Example:

Code Block
{
    "id": 1
}

Mandatory fields:

  • id: The ID of the recurrence to be stopped.

Example response:

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