Create a redirect session for a specific purpose
PUT/redirect-sessions/:redirectSessionId
Create a redirect session for a specific purpose
Request
Path Parameters
The id of the redirect session
- application/json
Body
required
- CreateNewTransactionIntentRedirectSession
- CreateExistingTransactionIntentRedirectSession
- CreateNewCustomerRedirectSession
oneOf
redirectData
object
required
a url that the user will be redirected on successful completion of the overall flow (Transaction completed)
a url that the user will be redirected on failure of the overall flow (Transaction/TransactionIntent declined/expired, or technical error)
a url that the user will be redirected on abort of the flow (TransactionIntent cancelled or user aborted the flow before a TransactionIntent was created)
a url that the user will be redirected after successful creation of QR code (user aborted the flow but TransactionIntent was created without finalizing)
Possible values: Value must match regular expression ^[A-z]{2}(-[A-z]{2})?$
Used to define the language and region of the customer. RFC 1766 customer's locale. Supported locales are en/en-* and de/de-*. If another or no locale is provided, the default locale is de-DE.
Possible values: [NewTransactionIntent]
The unique id of the customer. Optional, supplied only in case the merchant is tracking/storing whether a customer is registered at Zastrpay
transactionData
object
required
Possible values: [PassthroughDeposit, PassthroughWithdrawal, CustomerToMerchantTransfer, CustomerToMerchantPassthrough, MerchantToCustomerTransfer, MerchantToCustomerPassthrough]
The type of the transaction, this corresponds to the type of the transaction intent to be created, cannot be used with direction
Possible values: [MerchantToCustomer, CustomerToMerchant]
Specifies the cash flow direction of the transaction. This field cannot be used in conjunction with the 'type' field.
Possible values: <= 10000
The amount of the transaction intent.
Possible values: [EUR]
The currency code as ISO 4217 3-digit code (https://en.wikipedia.org/wiki/ISO_4217).
Possible values: non-empty and <= 50 characters, Value must match regular expression ^[\d\p{L}]([\d\p{L}\-\. ]{0,48}[\d\p{L}])$
A reference to a transaction in an external system e.g. bank transfer. Used for MerchantPayment* and DistributorPayment* transaction types only.
Possible values: <= 50 characters, Value must match regular expression ^(?=(.*\d){2})[0-9\+\/\-\(\)\s]{2,50}$
A phone number with which the customer has registered at Zastrpay. To be provided when the Merchant wants to have KYD/PreCheck performed but does not have the Zastrpay customerId (e.g. because the customer registered directly with Zastrpay, or via another merchant)
redirectData
object
required
a url that the user will be redirected on successful completion of the overall flow (Transaction completed)
a url that the user will be redirected on failure of the overall flow (Transaction/TransactionIntent declined/expired, or technical error)
a url that the user will be redirected on abort of the flow (TransactionIntent cancelled or user aborted the flow before a TransactionIntent was created)
a url that the user will be redirected after successful creation of QR code (user aborted the flow but TransactionIntent was created without finalizing)
Possible values: Value must match regular expression ^[A-z]{2}(-[A-z]{2})?$
Used to define the language and region of the customer. RFC 1766 customer's locale. Supported locales are en/en-* and de/de-*. If another or no locale is provided, the default locale is de-DE.
Possible values: [ExistingTransactionIntent]
The unique id of the customer. Optional, supplied only in case the merchant is tracking/storing whether a customer is registered at Zastrpay
The unique id of the existing transaction intent
redirectData
object
required
a url that the user will be redirected on successful completion of the overall flow (Transaction completed)
a url that the user will be redirected on failure of the overall flow (Transaction/TransactionIntent declined/expired, or technical error)
a url that the user will be redirected on abort of the flow (TransactionIntent cancelled or user aborted the flow before a TransactionIntent was created)
a url that the user will be redirected after successful creation of QR code (user aborted the flow but TransactionIntent was created without finalizing)
Possible values: Value must match regular expression ^[A-z]{2}(-[A-z]{2})?$
Used to define the language and region of the customer. RFC 1766 customer's locale. Supported locales are en/en-* and de/de-*. If another or no locale is provided, the default locale is de-DE.
Possible values: [NewCustomer]
customerData
object
The personal, address and contact data of the customer. Optional, supplied when the merchant is tracking customer registrations at Zastrpay and knows that the customer is not yet registered at Zastrpay, and when the customer has allowed the Merchant to share her/his data with Zastrpay
Possible values: Value must match regular expression ^[\p{L}'\-\ ]{2,50}$
The name of the customer
Possible values: Value must match regular expression ^[\p{L}'\-\ ]{2,50}$
The name of the customer
Possible values: Value must match regular expression ^[\p{L}'\-\ ]{2,50}$
The name of the customer
Possible values: Value must match regular expression ^[\p{L}'\-\ ]{2,50}$
The name of the customer
Possible values: Value must match regular expression ^\d{4}-\d{1,2}-\d{1,2}$
The date of birth of the person
Possible values: <= 50 characters, Value must match regular expression ^[\p{L}0-9'\,\ \-\.\\\/\(\)]{2,50}$
The city of birth of the customer
Possible values: Value must match regular expression ^[A-Z]{2}$
The code of the customer's country of birth as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
Possible values: Value must match regular expression ^[A-Z]{2}$
The country code of the customer's nationality as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
address
object
required
Contains the address details of a customer
Possible values: <= 50 characters, Value must match regular expression ^[\p{L}0-9'\,\ \-\.\\\/\(\)]{2,50}$
The street including housenumber, housename, etc.
Possible values: <= 50 characters, Value must match regular expression ^[\p{L}0-9'\,\ \-\.\\\/\(\)]{2,50}$
The city name
Possible values: <= 50 characters, Value must match regular expression ^[\p{L}0-9\-\ )]{2,50}$
The postal code of the address
Possible values: Value must match regular expression ^[A-Z]{2}$
The country code as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
contact
object
Possible values: <= 100 characters, Value must match regular expression ^(?=.{1,100}$)(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$
The customer's valid email address
Responses
- 201
- 400
- 404
- 409
- 422
- 500
Expected response to a valid request
- application/json
- Schema
- NewTransactionIntent
- ExistingTransactionIntent
- NewCustomer
Schema
- CreatedNewTransactionIntentRedirectSession
- CreatedExistingTransactionIntentRedirectSession
- CreatedNewCustomerRedirectSession
oneOf
The unique id of the redirect session
The unique id of the merchant
The creation datetime of the entity, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time
redirectData
object
required
a url that the user will be redirected on successful completion of the overall flow (Transaction completed)
a url that the user will be redirected on failure of the overall flow (Transaction/TransactionIntent declined/expired, or technical error)
a url that the user will be redirected on abort of the flow (TransactionIntent cancelled or user aborted the flow before a TransactionIntent was created)
a url that the user will be redirected after successful creation of QR code (user aborted the flow but TransactionIntent was created without finalizing)
Identifies the conversation within which the last change of state occurred. Currently the value of X-Request-Id is used if provided, or an internal UUID is generated if not
Possible values: Value must match regular expression ^[A-z]{2}(-[A-z]{2})?$
Used to define the language and region of the customer. RFC 1766 customer's locale. Supported locales are en/en-* and de/de-*. If another or no locale is provided, the default locale is de-DE.
a JWT to be used for subsequent authentication of user request
a url where to redirect the user to continue with the payment process
Possible values: [NewTransactionIntent]
The unique id of the customer. Optional, supplied only in case the merchant is tracking/storing whether a customer is registered at Zastrpay
transactionData
object
required
Possible values: [PassthroughDeposit, PassthroughWithdrawal, CustomerToMerchantTransfer, CustomerToMerchantPassthrough, MerchantToCustomerTransfer, MerchantToCustomerPassthrough]
The type of the transaction, this corresponds to the type of the transaction intent to be created, cannot be used with direction
Possible values: [MerchantToCustomer, CustomerToMerchant]
Specifies the cash flow direction of the transaction. This field cannot be used in conjunction with the 'type' field.
Possible values: <= 10000
The amount of the transaction intent.
Possible values: [EUR]
The currency code as ISO 4217 3-digit code (https://en.wikipedia.org/wiki/ISO_4217).
Possible values: non-empty and <= 50 characters, Value must match regular expression ^[\d\p{L}]([\d\p{L}\-\. ]{0,48}[\d\p{L}])$
A reference to a transaction in an external system e.g. bank transfer. Used for MerchantPayment* and DistributorPayment* transaction types only.
Possible values: <= 50 characters, Value must match regular expression ^(?=(.*\d){2})[0-9\+\/\-\(\)\s]{2,50}$
A phone number with which the customer has registered at Zastrpay. To be provided when the Merchant wants to have KYD/PreCheck performed but does not have the Zastrpay customerId (e.g. because the customer registered directly with Zastrpay, or via another merchant)
kycData
object
The customer data required for KYC/KYD. Returned only for certain merchants that were explicitly whitelisted.
Possible values: Value must match regular expression ^[\p{L}'\-\ ]{2,50}$
The name of the customer
Possible values: Value must match regular expression ^[\p{L}'\-\ ]{2,50}$
The name of the customer
The unique id of the redirect session
The unique id of the merchant
The creation datetime of the entity, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time
redirectData
object
required
a url that the user will be redirected on successful completion of the overall flow (Transaction completed)
a url that the user will be redirected on failure of the overall flow (Transaction/TransactionIntent declined/expired, or technical error)
a url that the user will be redirected on abort of the flow (TransactionIntent cancelled or user aborted the flow before a TransactionIntent was created)
a url that the user will be redirected after successful creation of QR code (user aborted the flow but TransactionIntent was created without finalizing)
Identifies the conversation within which the last change of state occurred. Currently the value of X-Request-Id is used if provided, or an internal UUID is generated if not
Possible values: Value must match regular expression ^[A-z]{2}(-[A-z]{2})?$
Used to define the language and region of the customer. RFC 1766 customer's locale. Supported locales are en/en-* and de/de-*. If another or no locale is provided, the default locale is de-DE.
a JWT to be used for subsequent authentication of user request
a url where to redirect the user to continue with the payment process
Possible values: [ExistingTransactionIntent]
The unique id of the customer. Optional, supplied only in case the merchant is tracking/storing whether a customer is registered at Zastrpay
The unique id of the existing transaction intent
The unique id of the redirect session
The unique id of the merchant
The creation datetime of the entity, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time
redirectData
object
required
a url that the user will be redirected on successful completion of the overall flow (Transaction completed)
a url that the user will be redirected on failure of the overall flow (Transaction/TransactionIntent declined/expired, or technical error)
a url that the user will be redirected on abort of the flow (TransactionIntent cancelled or user aborted the flow before a TransactionIntent was created)
a url that the user will be redirected after successful creation of QR code (user aborted the flow but TransactionIntent was created without finalizing)
Identifies the conversation within which the last change of state occurred. Currently the value of X-Request-Id is used if provided, or an internal UUID is generated if not
Possible values: Value must match regular expression ^[A-z]{2}(-[A-z]{2})?$
Used to define the language and region of the customer. RFC 1766 customer's locale. Supported locales are en/en-* and de/de-*. If another or no locale is provided, the default locale is de-DE.
a JWT to be used for subsequent authentication of user request
a url where to redirect the user to continue with the payment process
Possible values: [NewCustomer]
customerData
object
The personal, address and contact data of the customer. Optional, supplied when the merchant is tracking customer registrations at Zastrpay and knows that the customer is not yet registered at Zastrpay, and when the customer has allowed the Merchant to share her/his data with Zastrpay
Possible values: Value must match regular expression ^[\p{L}'\-\ ]{2,50}$
The name of the customer
Possible values: Value must match regular expression ^[\p{L}'\-\ ]{2,50}$
The name of the customer
Possible values: Value must match regular expression ^[\p{L}'\-\ ]{2,50}$
The name of the customer
Possible values: Value must match regular expression ^[\p{L}'\-\ ]{2,50}$
The name of the customer
Possible values: Value must match regular expression ^\d{4}-\d{1,2}-\d{1,2}$
The date of birth of the person
Possible values: <= 50 characters, Value must match regular expression ^[\p{L}0-9'\,\ \-\.\\\/\(\)]{2,50}$
The city of birth of the customer
Possible values: Value must match regular expression ^[A-Z]{2}$
The code of the customer's country of birth as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
Possible values: Value must match regular expression ^[A-Z]{2}$
The country code of the customer's nationality as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
address
object
required
Contains the address details of a customer
Possible values: <= 50 characters, Value must match regular expression ^[\p{L}0-9'\,\ \-\.\\\/\(\)]{2,50}$
The street including housenumber, housename, etc.
Possible values: <= 50 characters, Value must match regular expression ^[\p{L}0-9'\,\ \-\.\\\/\(\)]{2,50}$
The city name
Possible values: <= 50 characters, Value must match regular expression ^[\p{L}0-9\-\ )]{2,50}$
The postal code of the address
Possible values: Value must match regular expression ^[A-Z]{2}$
The country code as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
contact
object
Possible values: <= 100 characters, Value must match regular expression ^(?=.{1,100}$)(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$
The customer's valid email address
{
"id": "39bfc4da-3fe4-4207-a675-5880d673dc9e",
"redirectData": {
"successUrl": "https://merchant.com/payment/success?param=someValue",
"failureUrl": "https://merchant.com/payment/failure?param=someValue",
"abortUrl": "https://merchant.com/payment/abort?param=someValue",
"qrCodeSuccessUrl": "https://merchant.com/payment/qrCodeSuccessUrl?param=someValue"
},
"locale": "de-DE",
"type": "NewTransactionIntent",
"customerId": "234abc22-33de-4444-5555-222222222222",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJpc3N1ZXIifQ.nbgaqe_ny9RSi3ySOv5BvYYR5Ts34LyW_U8vC48jJfY",
"redirectUrl": "https://myserver.com/redirect-here"
}
{
"id": "d7f3265a-12dc-42e4-a4f8-176e7efe61eb",
"redirectData": {
"successUrl": "https://merchant.com/payment/success?param=someValue",
"failureUrl": "https://merchant.com/payment/failure?param=someValue",
"abortUrl": "https://merchant.com/payment/abort?param=someValue",
"qrCodeSuccessUrl": "https://merchant.com/payment/qrCodeSuccessUrl?param=someValue"
},
"locale": "de-DE",
"type": "ExistingTransactionIntent",
"customerId": "5d1ea0f0-5601-458c-b9e7-d9a8747149c6",
"transactionIntentId": "e5cf83f0-6ed8-4472-b0c2-453c10e2a875",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJpc3N1ZXIifQ.nbgaqe_ny9RSi3ySOv5BvYYR5Ts34LyW_U8vC48jJfY",
"redirectUrl": "https://myserver.com/redirect-here"
}
{
"id": "39bfc4da-3fe4-4207-a675-5880d673dc9e",
"redirectData": {
"successUrl": "https://merchant.com/payment/success?param=someValue",
"failureUrl": "https://merchant.com/payment/failure?param=someValue",
"abortUrl": "https://merchant.com/payment/abort?param=someValue",
"qrCodeSuccessUrl": "https://merchant.com/payment/qrCodeSuccessUrl?param=someValue"
},
"locale": "de-DE",
"type": "NewCustomer",
"customerData": {
"firstName": "Max",
"lastName": "Mustermann",
"dateOfBirth": "1946-10-29",
"placeOfBirth": "Vienna",
"countryOfBirth": "DE",
"nationality": "DE",
"address": {
"streetAddress": "Hauptstrasse 13/12/1",
"city": "Vienna",
"postalCode": "12345",
"country": "DE"
},
"contact": {
"email": "paul.smith@testabc.com"
}
},
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJpc3N1ZXIifQ.nbgaqe_ny9RSi3ySOv5BvYYR5Ts34LyW_U8vC48jJfY",
"redirectUrl": "https://myserver.com/redirect-here"
}
Validation failed
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [Validation, MergedToCustomer, InvalidTransactionIntent]
The type of error. Used for defining which sub-element will be present in the details property.
A short text describing the error.
A link to the online documentation describing the error in detail.
Identifies the conversation within which the error got generated.
details
object
Contains additional details of the error
The reason for CustomerPermissionDenied declineReason
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
The reason for LimitThresholdExceeded declineReason
The id of the customer this was merged, to be used to retry to operation
{
"code": "Validation",
"message": "The field \"customerId\" could not be validated.",
"moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"customerPermissionDeniedReason": "string",
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
],
"limitThresholdExceededReason": "string",
"mergedToCustomerId": "40c7fe9f-3bf9-464a-8d3a-937db20f5dae"
}
}
Redirect Session was updated in the meantime, or duplicate
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [CustomerNotFound, MerchantNotFound, LimitAccountSetNotFound]
The type of error. Used for defining which sub-element will be present in the details property.
A short text describing the error.
A link to the online documentation describing the error in detail.
Identifies the conversation within which the error got generated.
details
object
Contains additional details of the error
The reason for CustomerPermissionDenied declineReason
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
The reason for LimitThresholdExceeded declineReason
{
"code": "CustomerNotFound",
"message": "The field \"customerId\" could not be validated.",
"moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"customerPermissionDeniedReason": "string",
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
],
"limitThresholdExceededReason": "string"
}
}
Redirect Session was updated in the meantime, or duplicate
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [DuplicateEntity]
The type of error. Used for defining which sub-element will be present in the details property.
A short text describing the error.
A link to the online documentation describing the error in detail.
Identifies the conversation within which the error got generated.
details
object
Contains additional details of the error
The reason for CustomerPermissionDenied declineReason
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
The reason for LimitThresholdExceeded declineReason
{
"code": "DuplicateEntity",
"message": "The field \"customerId\" could not be validated.",
"moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"customerPermissionDeniedReason": "string",
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
],
"limitThresholdExceededReason": "string"
}
}
Redirect Session could not be processed
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [CustomerPermissionDenied, LimitThresholdExceeded]
The type of error. Used for defining which sub-element will be present in the details property.
A short text describing the error.
A link to the online documentation describing the error in detail.
Identifies the conversation within which the error got generated.
details
object
Contains additional details of the error
The reason for CustomerPermissionDenied declineReason
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
The reason for LimitThresholdExceeded declineReason
{
"code": "CustomerPermissionDenied",
"message": "The field \"customerId\" could not be validated.",
"moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"customerPermissionDeniedReason": "string",
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
],
"limitThresholdExceededReason": "string"
}
}
Unexpected technical error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [GeneralErrorOccurred]
The type of error. Used for defining which sub-element will be present in the details property.
A short text describing the error.
A link to the online documentation describing the error in detail.
Identifies the conversation within which the error got generated.
details
object
Contains additional details of the error
The reason for CustomerPermissionDenied declineReason
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
The reason for LimitThresholdExceeded declineReason
{
"code": "GeneralErrorOccurred",
"message": "The field \"customerId\" could not be validated.",
"moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"customerPermissionDeniedReason": "string",
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
],
"limitThresholdExceededReason": "string"
}
}