Start
POST/schedule/:apiKey/start
Start a schedule.
Requires the registrationId
of an existing transaction of type Register, Debit (withRegister
), or Preauthorize (withRegister
).
Please be aware of the rate limit for this API endpoint:
- Total limit: Each unique API user is limited to to 60 requests per 60-second window.
If these limits are exceeded, the server will respond with a HTTP 429 status code, indicating too many requests. Please ensure to manage your requests within these limits to maintain uninterrupted service.
Request
Path Parameters
Possible values: <= 50 characters
API Key of Connector
- application/json
Body
required
Start a schedule on the given registration transaction
Possible values: <= 50 characters
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Possible values: [DAY
, WEEK
, MONTH
, YEAR
]
The unit that the duration is measured in.
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$
RFC 3339 Internet Date/Time Format date-time
Possible values: <= 255 characters
Possible values: <= 4096 characters
Callback URL for sending notifications of transactions initiated by the schedule, instead of the URL from the Register transaction.
Responses
- 200
- 429
Schedule response
- application/json
- Schema
- Example (from schema)
- Success
- Error
Schema
- false
- true
success
string
required
Possible values: [false
, true
]
Error message.
While the errorMessage
field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances.
For consistent and reliable error handling in your application, always base your logic on the errorCode
field, not the errorMessage
.
Error code.
For a complete list of error codes and their meanings, please see the appendix on Error codes.
Adapter specific error message, passed verbatim from the upstream Adapter.
Adapter specific error code, passed verbatim from the upstream Adapter.
Possible values: [ACTIVE
, PAUSED
, CANCELLED
, ERROR
, CREATE-PENDING
, NON-EXISTING
]
Status of the schedule.
Possible values: [ACTIVE
, PAUSED
, CANCELLED
, ERROR
, CREATE-PENDING
, NON-EXISTING
]
Status of the schedule.
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$
RFC 3339 Internet Date/Time Format date-time
{
"success": true
}
{
"success": true,
"scheduleId": "SC-1234-1234-1234-1234-1234-1234",
"registrationUuid": "abcde01234abcde01234",
"oldStatus": "NON-EXISTING",
"newStatus": "ACTIVE",
"scheduledAt": "2019-09-30T12:00:00+00:00"
}
{
"success": false,
"errorMessage": "The scheduleId is not valid or does not match to the connector",
"errorCode": 7040
}
Rate limit exceeded
- application/json
- Schema
- Example (from schema)
- Example
Schema
Possible values: [false
]
Returns true
or false
depending on whether the request was successful.
Error message.
While the errorMessage
field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances.
For consistent and reliable error handling in your application, always base your logic on the errorCode
field, not the errorMessage
.
{
"success": false,
"errorMessage": "string",
"errorCode": 0,
"details": "string"
}
{
"success": false,
"errorCode": 1009,
"errorMessage": "Too many requests"
}
Callbacks
- POST statusChange
POST{$request.body#/callbackUrl}
Receive status updates about transactions.
Status changes are posted as callbacks to the callbackUrl
defined in the request.
See the Callbacks reference for further information about callbacks.
- application/json
Body
required
The current state of the transaction.
Array [
]
- cardData
- phoneData
- ibanData
- walletData
- achData
01
- Additional information needed.02
- Try again later.03
- Do not try again.- PaymentIbanData
- PaymentWalletData
Array [
]
Array [
]
UUID of the transaction.
Possible values: non-empty
and <= 50 characters
A unique identifier supplied by the merchant to track transactions within their own systems.
This field links the platform’s transaction back to the merchant’s system, allowing for easy tracking and reconciliation. Note that while this ID is used within the platform, there is no guarantee that it will be forwarded to the Payment Service Provider (PSP).
Possible values: <= 50 characters
Purchase ID of the transaction.
Possible values: [DEBIT
, CAPTURE
, DEREGISTER
, PREAUTHORIZE
, REFUND
, REGISTER
, VOID
, CHARGEBACK
, CHARGEBACK-REVERSAL
, PAYOUT
, INCREMENTAL-AUTHORIZATION
]
Possible values: [cb-resolved
, cb-reversal-resolved
]
Only present if transaction has a subType
.
Payment method.
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
dccData
object
Possible values: <= 128 characters
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Possible values: <= 32 characters
Possible values: non-empty
and <= 50 characters
errors
object[]
Error message.
While the message
field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances.
For consistent and reliable error handling in your application, always base your logic on the code
field, not the message
.
Error code.
For a complete list of error codes and their meanings, please see the appendix on Error codes.
Adapter specific error message, passed verbatim from the upstream Adapter.
Adapter specific error code, passed verbatim from the upstream Adapter.
chargebackData
object
When transactionType
is CHARGEBACK
this field contains information on the chargeback.
Possible values: non-empty
and <= 50 characters
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$
RFC 3339 Internet Date/Time Format date-time
When transactionType
is CHARGEBACK
this field contains information on the chargeback.
chargebackReversalData
object
When transactionType
is CHARGEBACK-REVERSAL
this field contains information on the chargeback-reversal.
Possible values: non-empty
and <= 50 characters
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$
RFC 3339 Internet Date/Time Format date-time
When transactionType
is CHARGEBACK-REVERSAL
this field contains information on the chargeback-reversal.
extraData
object
Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.
Possible values: <= 64
.
Property name: <= 64 characters
.
Property value: <= 8192 characters
.
returnData
object
_TYPE
string
required
Possible values: [cardData
, phoneData
, ibanData
, walletData
, achData
]
Type of credit card
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
Possible values: Value must match regular expression ^((0[1-9])|(1[0-2]))$
Possible values: Value must match regular expression ^[0-9]{4}$
Possible values: Value must match regular expression ^[0-9]{6-8}$
Possible values: Value must match regular expression ^[0-9]{6}$
Possible values: Value must match regular expression ^[0-9]{4}$
Possible values: [OFF
, OPTIONAL
, MANDATORY
]
Triggers the 3D Secure authentication for this transaction.
Pipes through the merchant advice code for failed transactions if supported by the adapter.
Possible values: [01
, 02
, 03
]
Merchant advice code for failed transactions if supported by the adapter.
The schemeTransactionIdentifier
, is a unique reference generated by a card scheme.
It serves the purpose of traceability back to the initial transaction.
It is also referred to as the 'scheme reference ID,' 'scheme transaction ID,' 'trace ID' (for Mastercard), or 'transaction ID' (for VISA).
Possible values: [updated
, contact
, new-expiry
, closed
]
Status of the last account updater run.
Only non-null if the account updater is enabled and has run at least once.
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$
Last run of the account updater.
Only non-null if the account updater is enabled and has run at least once.
RFC 3339 Internet Date/Time Format full-date
.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$
RFC 3339 Internet Date/Time Format full-date
.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
Reference ID of the wallet.
Owner of the wallet.
Type of wallet.
First name of wallet owner.
Last name of wallet owner.
Country code of wallet owner.
UUID of the transaction that initially registered this wallet.
Possible values: [person
, company
]
Possible values: [checking
, savings
]
Possible values: <= 17 characters
Possible values: >= 9 characters
and <= 9 characters
payByLinkData
object
true
if this transaction was a Pay-by-Link transaction.
true
if this Pay-by-Link was sent to the transaction customer via email.
Endpoint to call to cancel a Pay-by-Link transaction.
For details, see Pay-by-Link API reference.
Indicates at what date time the Pay-by-Link transaction expires.
customer
object
Possible values: <= 36 characters
Possible values: <= 50 characters
Possible values: <= 50 characters
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$
RFC 3339 Internet Date/Time Format full-date
.
Possible values: [M
, F
]
Possible values: <= 50 characters
Possible values: <= 50 characters
Possible values: <= 50 characters
Possible values: <= 16 characters
Possible values: <= 30 characters
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
Possible values: <= 20 characters
Possible values: <= 50 characters
Possible values: <= 50 characters
Possible values: <= 50 characters
Possible values: <= 50 characters
Possible values: <= 50 characters
Possible values: <= 50 characters
Possible values: <= 16 characters
Possible values: <= 30 characters
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
Possible values: <= 20 characters
Possible values: <= 50 characters
Possible values: <= 255 characters
Possible values: <= 50 characters
Possible values: <= 20 characters
extraData
object
Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.
Possible values: <= 64
.
Property name: <= 64 characters
.
Property value: <= 8192 characters
.
paymentData
object
oneOf
ibanData
object
Possible values: <= 34 characters
Possible values: <= 11 characters
Possible values: <= 50 characters
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$
RFC 3339 Internet Date/Time Format full-date
.
walletData
object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
customerProfileData
object
The unique customer profile identifier generated by the platform.
The customer profile identifier provided by you when creating the customer profile. Unique within one customer profile container.
The created payment instrument for the customer profile, use with transactionToken
when creating new transactions.
Whether this payment instrument was marked as preferred for the customer.
splits
object[]
Possible values: <= 10
Possible values: <= 11 characters
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Possible values: <= 11 characters
Possible values: <= 128 characters
commissionFee
object
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Error message.
While the message
field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances.
For consistent and reliable error handling in your application, always base your logic on the code
field, not the message
.
Error code.
For a complete list of error codes and their meanings, please see the appendix on Error codes.
Adapter specific error message, passed verbatim from the upstream Adapter.
Adapter specific error code, passed verbatim from the upstream Adapter.
Possible values: [OK
, PENDING
, ERROR
]
scheduleData
object[]
ID of schedule which was started with the transaction.
Possible values: [ACTIVE
, PAUSED
, CANCELLED
, ERROR
, CREATE-PENDING
, NON-EXISTING
]
Status of the schedule.
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$
RFC 3339 Internet Date/Time Format date-time
Possible values: [reconciliation
, settlement
]
In case the transaction status, amount or currency has been changed after reconciliation the parameter can have the following value: reconciliation
, settlement
.
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
In case the transaction amount has been changed after reconciliation the is parameter will contain the original amount.
Decimals separated by .
, max. 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
In case the transaction currency has been changed after reconciliation the is parameter will contain the original currency.
ISO 4217 three-letter currency code.
Callbacks Responses
- 200
- 500
Reply with status 200 and body OK
if you have received the callback successfully.
- text/plain
- Schema
- Success
Schema
string
Possible values: [OK
]
OK
Callback processing failed and retries will be performed.
See the Response handling — Acknowledging callback receipt reference for further information.