{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "TransferRequestPostBody",
"properties": {
"transfer": {
"description": "Object of transfer",
"allOf": [
{
"$ref": "#/components/schemas/TransferObjectBody"
}
]
},
"type": {
"type": "string",
"description": "Payment types available: wallet, p24, p24mobile",
"example": "wallet"
},
"express": {
"type": "boolean",
"description": "Default setting - True:
True \u2013 upon payment, the transfer will be sent in the express mode,
False \u2013 upon payment, the transfer will be sent in the elixir mode.",
"default": true,
"example": true
},
"currency": {
"type": "string",
"maxLength": 3,
"description": "Transfer currency in which the funds will be collected for specific payment types:
wallet \u2013 funds will be collected from the wallet in a given currency;
p24, p24mobile \u2013 the currency in which the client will pay in their funds,
",
"example": "PLN"
},
"send": {
"type": "integer",
"description": "Values:
0 - none,
1 \u2013 send an email with the url to the recipient of the transfer ,
2 \u2013 send an email with the url to the sender of the transfer,
4 \u2013 send an email with a confirmation of completion to the recipient,
8 \u2013 send an email with a confirmation of completion to the sender.
In order to choose, e.g. two options, provide the sum of the respective values: email with url to the sender + to the recipient + email with confirmation to the sender:
2 + 1 + 8 = 11 -> value to be provided",
"example": 11
},
"regulations": {
"type": "boolean",
"default": false,
"description": "Acceptance of Przelewy24 regulations:
false \u2013 display consent on p24 website (default),
true \u2013 consent granted, do not display.
In case the \u201etrue\u201d parameter is sent, the consent \u2013 worded as follows \u2013 must be displayed on the Partner\u2019s website: \u201eI hereby state that I have read the [regulations](https://www.przelewy24.pl/regulamin) and [information obligation](https://www.przelewy24.pl/obowiazekinformacyjny) of \u201dPrzelewy24\u201d.
Under words regulations and information obligation there must be hyperlinks redirecting to websites with these documents. The checkbox must not be ticked by default."
},
"id": {
"type": "string",
"maxLength": 255,
"description": "Unique transfer ID, UUID recommended"
},
"sign": {
"type": "string",
"maxLength": 255,
"description": "Signature calculated separately for each transfer. For more information see Calculation of sign parameter"
},
"label": {
"type": "string",
"maxLength": 20,
"description": "Additional fields used solely for payments of the following types p24, p24mobile.
Additional description in the transfer title.
Can be send in the object of transfer, in the label parameter. Value from the object overwirtes value from this parameter"
},
"ttl": {
"type": "integer",
"description": "Additional fields used solely for payments of the following types p24, p24mobile.
Timestamp \u2013 date and time after which it will not be possible to pay the transaction
NOTE! For the parameter to work in P24 system, please send a request to partner@przelewy24.pl
Example:
1577833200 = 2020-01-01 00:00:00
0 = no limit (as default)"
},
"paymentMethod": {
"type": "integer",
"description": "Additional fields used solely for payments of the following types p24, p24mobile.
The payment method selected in P24, see v1/payment/methods"
},
"returnUrl": {
"type": "string",
"maxLength": 255,
"description": "Additional fields used solely for payments of the following types p24, p24mobile.
The address to which the client will be redirected after processing the payment in Przelewy24.pl. By default, the client will return to the URL address generated upon transfer registration."
},
"sdkVersion": {
"type": "string",
"maxLength": 10,
"default": "3.0",
"description": "Additional fields used solely for payments of the following type p24mobile.
Mobile library version number must be provided. This parameter may be obtained directly from the library (iOS - class P24, Android - class P24SdkVersion). The default value sent is \u201e3.0\u201d."
}
},
"required": [
"transfer",
"type",
"currency",
"send",
"id",
"sign"
]
}