Girocheckout API

User Tools

Site Tools

Trace:
en:girocheckout:eps:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
en:girocheckout:eps:start [2023/03/24 20:45]
michaelheumann 		en:girocheckout:eps:start [2023/05/05 03:29] (current)
michaelheumann
Line 98: Line 98:
 == JSON parameter == == JSON parameter ==
 ^name           ^mandatory  ^type      ^description   ^ ^name           ^mandatory  ^type      ^description   ^
-|rc             |yes       |Integer   |[[en:girocheckout:errorcodes|error codes]] | +|rc             |yes       |Integer     |[[en:girocheckout:errorcodes|error codes]] | 
-|msg            |yes       |String    |additional informationen about the response code | +|msg            |yes       |String(255) |additional informationen about the response code | 
-|bic            |yes       |String    |BIC | +|bic            |yes       |String(11)  |BIC | 
-|bankname       |yes       |String    |name of the bank | +|bankname       |yes       |String(100) |name of the bank | 
-|eps            |yes       |Integer   |0 = eps payment is not supported \\ 1 = eps payment is supported|+|eps            |yes       |Integer     |0 = eps payment is not supported \\ 1 = eps payment is supported|
 ^HEADER parameter^^^^ ^HEADER parameter^^^^
-|hash           |yes       |String    |HMAC MD5 hash overall the JSON string. (see [[en:girocheckout:general:start#api_call_reply_to_the_merchant|api call reply]]) |+|hash           |yes       |String(32)  |HMAC MD5 hash overall the JSON string. (see [[en:girocheckout:general:start#api_call_reply_to_the_merchant|api call reply]]) |
  
 == example == == example ==
Line 133: Line 133:
 == JSON parameter == == JSON parameter ==
 ^name           ^mandatory  ^type      ^description   ^ ^name           ^mandatory  ^type      ^description   ^
-|rc             |yes       |Integer   |[[en:girocheckout:errorcodes|error codes]] | +|rc             |yes       |Integer     |[[en:girocheckout:errorcodes|error codes]] | 
-|msg            |yes       |String    |additional informationen about the response code | +|msg            |yes       |String(255) |additional informationen about the response code | 
-|issuer         |optional  |Mixed     |list of all supported issuer banks containing bic as key and name|+|issuer         |optional  |Mixed       |list of all supported issuer banks containing bic as key and name|
  
 == Beispiel == == Beispiel ==
Line 158: Line 158:
 |currency       |yes              |String(3)   |currency\\ EUR = Euro| |currency       |yes              |String(3)   |currency\\ EUR = Euro|
 |purpose        |yes              |String(27)  |purpose | |purpose        |yes              |String(27)  |purpose |
-|bic            |**deprecated**         |String(11)  |**This parameter must not be used anymore. All eps transactions now use an external bank selection form!** BIC (8 or 11-digits)| +|bic            |**deprecated**   |String(11)  |**This parameter must not be used anymore. All eps transactions now use an external bank selection form!** BIC (8 or 11-digits)| 
-|urlRedirect    |yes              |String      |URL, where the buyer has to be sent after payment | +|urlRedirect    |yes              |String(2048)|URL, where the buyer has to be sent after payment | 
-|urlNotify      |yes              |String      |URL, where the notification has to be sent after payment | +|urlNotify      |yes              |String(2048)|URL, where the notification has to be sent after payment | 
-|kassenzeichen  |optional         |String (255) |Optional field that allows passing an additional reference/identifier for the transaction. This value is displayed inside GiroCockpit as part of the transaction details (and soon export) and a search for it is also supported there. Characters must comply with the UTF-8 character set. | +|kassenzeichen  |optional         |String(255) |Optional field that allows passing an additional reference/identifier for the transaction. This value is displayed inside GiroCockpit as part of the transaction details (and soon export) and a search for it is also supported there. Characters must comply with the UTF-8 character set. | 
-|hash           |yes              |String      |HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |+|hash           |yes              |String(32)  |HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |
  
  
Line 176: Line 176:
 == Parameter == == Parameter ==
 ^name           ^mandatory  ^type      ^description   ^ ^name           ^mandatory  ^type      ^description   ^
-|rc             |yes       |Integer   |[[en:girocheckout:errorcodes|response code]] | +|rc             |yes      |Integer     |[[en:girocheckout:errorcodes|response code]] | 
-|msg            |yes       |String    |additional information about the response code | +|msg            |yes      |String(255) |additional information about the response code | 
-|reference      |optional |String    |unique GiroCheckout transaction ID | +|reference      |optional |String(36)  |unique GiroCheckout transaction ID | 
-|redirect       |optional |String    |redirect URL to the buyer's online banking account|+|redirect       |optional |String(2048)|redirect URL to the buyer's online banking account|
 ^HEADER parameter^^^^ ^HEADER parameter^^^^
-|hash           |yes       |String    |HMAC MD5 hash overall the JSON string. (see [[en:girocheckout:general:start#api_call_reply_to_the_merchant|api call reply]]) |+|hash           |yes       |String(32) |HMAC MD5 hash overall the JSON string. (see [[en:girocheckout:general:start#api_call_reply_to_the_merchant|api call reply]]) |
  
 == example in case of success == == example in case of success ==
Line 205: Line 205:
 == GET parameter == == GET parameter ==
 ^name             ^mandatory  ^  type        ^description   ^ ^name             ^mandatory  ^  type        ^description   ^
-|gcReference      |yes              |String      | unique GiroCheckout transaction ID | +|gcReference      |yes              |String(36)  | unique GiroCheckout transaction ID | 
-|gcMerchantTxId   |yes              | String     | merchant transaction ID | +|gcMerchantTxId   |yes              |String(255) | merchant transaction ID | 
-|gcBackendTxId    |yes              |String      | payment processor transaction ID |+|gcBackendTxId    |yes              |String(10)  | payment processor transaction ID |
 |gcAmount         |yes              |Integer     | if a decimal currency is used, the amount has to be in the smallest unit of value, eg. cent, penny | |gcAmount         |yes              |Integer     | if a decimal currency is used, the amount has to be in the smallest unit of value, eg. cent, penny |
-|gcCurrency       |yes              |String      | currency |+|gcCurrency       |yes              |String(3)   | currency |
 |gcResultPayment  |yes              |Integer     | [[en:girocheckout:resultcodes#zahlungsausgang|payment result codes]]| |gcResultPayment  |yes              |Integer     | [[en:girocheckout:resultcodes#zahlungsausgang|payment result codes]]|
-|gcHash           |yes              |String      | HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |+|gcHash           |yes              |String(32)  | HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |
  
 === reply === === reply ===
Line 231: Line 231:
 == GET parameter == == GET parameter ==
 ^name             ^ mandatory  ^  type        ^description   ^ ^name             ^ mandatory  ^  type        ^description   ^
-|gcReference      |yes      |String      | unique GiroCheckout transaction ID | +|gcReference      |yes      |String(36)  | unique GiroCheckout transaction ID | 
-|gcMerchantTxId   |yes      | String     | merchant transaction ID | +|gcMerchantTxId   |yes      |String(255) | merchant transaction ID | 
-|gcBackendTxId    |yes      |String      | payment processor transaction ID |+|gcBackendTxId    |yes      |String(10)  | payment processor transaction ID |
 |gcAmount         |yes      |Integer     | if a decimal currency is used, the amount has to be in the smallest unit of value, eg. cent, penny | |gcAmount         |yes      |Integer     | if a decimal currency is used, the amount has to be in the smallest unit of value, eg. cent, penny |
-|gcCurrency       |yes       |String      | currency | +|gcCurrency       |yes      |String(3)   | currency | 
-|gcResultPayment  |yes       |Integer     | [[en:girocheckout:resultcodes#zahlungsausgang|payment result codes]]| +|gcResultPayment  |yes      |Integer     | [[en:girocheckout:resultcodes#zahlungsausgang|payment result codes]]| 
-|gcHash           |yes       |String      | HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |+|gcHash           |yes      |String(32)  | HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |
  
 ===== Retrieve sender information ===== ===== Retrieve sender information =====
Line 262: Line 262:
 == JSON Parameters == == JSON Parameters ==
 ^Name           ^Mandatory  ^Type      ^Description   ^ ^Name           ^Mandatory  ^Type      ^Description   ^
-|rc             |yes       |Integer   |[[en:girocheckout:errorcodes|response code]] | +|rc             |yes      |Integer   |[[en:girocheckout:errorcodes|response code]] | 
-|msg            |yes       |String    |additional information about the response code in case of error| +|msg            |yes      |String(255) |additional information about the response code in case of error| 
-|accountholder  |Optional |String    |Account holder of the sender account| +|accountholder  |Optional |String(255) |Account holder of the sender account| 
-|iban           |Optional |String    |IBAN of the sender account | +|iban           |Optional |String(36)  |IBAN of the sender account | 
-|bic            |Optional |String    |BIC of the sender account |+|bic            |Optional |String(11)  |BIC of the sender account |
 ^HEADER parameter^^^^ ^HEADER parameter^^^^
-|hash           |yes       |String    |HMAC MD5 hash of the full JSON string. (see [[en:girocheckout:general:start#api_call_reply_to_the_merchant|api call reply]]) |+|hash           |yes       |String(32) |HMAC MD5 hash of the full JSON string. (see [[en:girocheckout:general:start#api_call_reply_to_the_merchant|api call reply]]) |
  
 == Example in case of success == == Example in case of success ==
en/girocheckout/eps/start.txt · Last modified: 2023/05/05 03:29

Page Tools