...
| Code Block |
|---|
{
"id": "055ff314-6399-4350-8b8b-c9cd1e22a065",
"amount": 10.00,
"status": {
"displayName": "Processed successfully",
"name": "PROCESSED"
},
"paymentMethod": "IDEAL",
"currency": "EUR",
"country": "NL",
"description": "TestPayment",
"feeCalculation": {
"sellPercentage": 0.00,
"sellCents": 15
},
"timestamp": "2024-01-20T13:05:51.948873470Z",
"requestId": "852f0c72-0024-4070-9ac7-563eeb4755f6",
"settled": true,
"settlementDate": "2024-01-28T06:00:00.572957294Z",
"settlementId": "1-912-W-2024-3-C0"
} |
Step 5: Optional - Request payment status
...
| Code Block |
|---|
{
"message": "PaymentByRequestId",
"details": {
"requestId": "3bdf2480-4ae6-44a1-bce0-3710d89cbfc4",
"transactions": [
{
"id": "f791c1e4-39eb-4bd1-8201-0460d560fef1",
"created": "2024-01-15T17:21:26.550656Z",
"status": "PROCESSED",
"amount": 10.0,
"currency": "EUR",
"country": "NL",
"paymentMethod": "iDEAL",
"accountholderName": "Oebele de Rekeninghouder",
"requestId": "3bdf2480-4ae6-44a1-bce0-3710d89cbfc4"
}
]
}
} |
Note: The response object contains a ‘transactions’ list because it is possible that one request has produced more than one transaction. For example: an end user has initiated a payment using payment method A and decided not to complete the payment. After pressing ‘back’, the end user initiated a new payment using payment method B. In this case, there can be more than one transaction with the same requestId:
| Code Block |
|---|
{
"message": "PaymentByRequestId",
"details": {
"requestId": "3bdf2480-4ae6-44a1-bce0-3710d89cbfc4",
"transactions": [
{
"id": "c018be0a-a633-40c8-805a-a2dfd6090af8",
"created": "2024-01-30T22:20:25.822136Z",
"status": "PENDING",
"amount": 10.0,
"currency": "EUR",
"country": "NL",
"paymentMethod": "Creditcard",
"accountholderName": "Oebele de Rekeninghouder",
"requestId": "3bdf2480-4ae6-44a1-bce0-3710d89cbfc4"
},
{
"id": "b88e446c-6889-4cc1-958e-10a4ed951ace",
"created": "2024-01-30T22:20:32.424212Z",
"status": "PROCESSED",
"amount": 10.0,
"currency": "EUR",
"country": "NL",
"paymentMethod": "iDEAL",
"accountholderName": "Oebele de Rekeninghouder",
"requestId": "3bdf2480-4ae6-44a1-bce0-3710d89cbfc4"
}
]
}
} |
...
,
"settled": true,
"settlementDate": "2024-01-28T06:00:00.572957294Z",
"settlementId": "1-912-W-2024-3-C0"
}
]
}
} |
Note: The response object contains a ‘transactions’ list because it is possible that one request has produced more than one transaction. For example: an end user has initiated a payment using payment method A and decided not to complete the payment. After pressing ‘back’, the end user initiated a new payment using payment method B. In this case, there can be more than one transaction with the same requestId:
| Code Block |
|---|
{
"message": "PaymentByRequestId",
"details": {
"requestId": "3bdf2480-4ae6-44a1-bce0-3710d89cbfc4",
"transactions": [
{
"id": "c018be0a-a633-40c8-805a-a2dfd6090af8",
"created": "2024-01-30T22:20:25.822136Z",
"status": "PENDING",
"amount": 10.0,
"currency": "EUR",
"country": "NL",
"paymentMethod": "Creditcard",
"accountholderName": "Oebele de Rekeninghouder",
"requestId": "3bdf2480-4ae6-44a1-bce0-3710d89cbfc4",
"settled": true,
"settlementDate": "2024-01-28T06:00:00.572957294Z",
"settlementId": "1-912-W-2024-3-C0"
},
{
"id": "b88e446c-6889-4cc1-958e-10a4ed951ace",
"created": "2024-01-30T22:20:32.424212Z",
"status": "PROCESSED",
"amount": 10.0,
"currency": "EUR",
"country": "NL",
"paymentMethod": "iDEAL",
"accountholderName": "Oebele de Rekeninghouder",
"requestId": "3bdf2480-4ae6-44a1-bce0-3710d89cbfc4",
"settled": true,
"settlementDate": "2024-01-28T06:00:00.572957294Z",
"settlementId": "1-912-W-2024-3-C0"
}
]
}
} |
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
}
} |