User Tools

Site Tools


en:girocheckout:bluecode: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:bluecode:start [2023/03/24 20:44]
michaelheumann
en:girocheckout:bluecode:start [2023/05/08 02:05] (current)
michaelheumann
Line 89: Line 89:
 |currency       |Yes       |String(3)   |Currency of the transaction according to [[https://en.wikipedia.org/wiki/ISO_4217#Active_codes|ISO 4217]].\\ EUR = Euro | |currency       |Yes       |String(3)   |Currency of the transaction according to [[https://en.wikipedia.org/wiki/ISO_4217#Active_codes|ISO 4217]].\\ EUR = Euro |
 |purpose        |Yes       |String(37)  |Purpose of the transaction.  This information appears on the settlement sheet. | |purpose        |Yes       |String(37)  |Purpose of the transaction.  This information appears on the settlement sheet. |
-|urlRedirect    |Yes       |String      |URL, where the buyer is to be redirected after payment. | +|urlRedirect    |Yes       |String(2048)      |URL, where the buyer is to be redirected 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]]) |
  
 == Example == == Example ==
Line 103: Line 103:
 ^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 information in case of error | +|msg            |Yes       |String(255)    |Additional information in case of error | 
-|reference      |Optional |String    |Unique GiroCheckout transaction ID | +|reference      |Optional |String(26)    |Unique GiroCheckout transaction ID | 
-|redirect       |Optional |String    |Redirect URL that leads the customer to the Bluecode payment page|+|redirect       |Optional |String(2048)    |Redirect URL that leads the customer to the Bluecode payment page|
 ^HEADER Parameters^^^^ ^HEADER Parameters^^^^
-|hash           |Yes       |String    |HMAC MD5 hash over the complete JSON string. (see [[en:girocheckout:general:start#api_call_reply_to_the_merchant|api call reply]]) |+|hash           |Yes       |String(32)    |HMAC MD5 hash over the complete 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 128: Line 128:
 === GET Parameters === === GET Parameters ===
 ^Name             ^Mandatory    ^  Type        ^Description   ^ ^Name             ^Mandatory    ^  Type        ^Description   ^
-|gcReference      |Yes       |String      | GiroCheckout transaction ID | +|gcReference      |Yes       |String(36)      | GiroCheckout transaction ID | 
-|gcMerchantTxId   |Yes       |String      | Merchant transaction ID | +|gcMerchantTxId   |Yes       |String(255)      | Merchant transaction ID | 
-|gcBackendTxId    |Yes       |String      | Transaction ID of the payment processor |+|gcBackendTxId    |Yes       |String(26)      | Transaction ID of the payment processor |
 |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 of the transaction according to [[https://en.wikipedia.org/wiki/ISO_4217#Active_codes|ISO 4217]].\\ EUR = Euro |+|gcCurrency       |Yes       |String(3)      | Currency of the transaction according to [[https://en.wikipedia.org/wiki/ISO_4217#Active_codes|ISO 4217]].\\ EUR = Euro |
 |gcResultPayment  |Yes       |Integer     | [[en:girocheckout:resultcodes#result_codes_payment|Result codes]]| |gcResultPayment  |Yes       |Integer     | [[en:girocheckout:resultcodes#result_codes_payment|Result codes]]|
-|gcHash           |Yes       |String      | HMAC MD5 hash of the complete JSON string (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |+|gcHash           |Yes       |String(32)      | HMAC MD5 hash of the complete JSON string (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |
  
 === Response === === Response ===
Line 154: Line 154:
 == GET Parameters == == GET Parameters ==
 ^Name             ^Mandatory  ^Type        ^Description   ^ ^Name             ^Mandatory  ^Type        ^Description   ^
-|gcReference      |Yes       |String      | GiroCheckout transaction ID | +|gcReference      |Yes       |String(36)      | GiroCheckout transaction ID | 
-|gcMerchantTxId   |Yes       |String      | Merchant transaction ID | +|gcMerchantTxId   |Yes       |String(255)      | Merchant transaction ID | 
-|gcBackendTxId    |Yes       |String      | Transaction ID of the payment processor |+|gcBackendTxId    |Yes       |String(26)      | Transaction ID of the payment processor |
 |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 of the transaction according to [[https://en.wikipedia.org/wiki/ISO_4217#Active_codes|ISO 4217]].\\ EUR = Euro |+|gcCurrency       |Yes       |String(3)      | Currency of the transaction according to [[https://en.wikipedia.org/wiki/ISO_4217#Active_codes|ISO 4217]].\\ EUR = Euro |
 |gcResultPayment  |Yes       |Integer     | [[en:girocheckout:resultcodes#result_codes_payment|Result codes]]| |gcResultPayment  |Yes       |Integer     | [[en:girocheckout:resultcodes#result_codes_payment|Result codes]]|
-|gcHash           |Yes       |String      | HMAC MD5 hash of the complete JSON string (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |+|gcHash           |Yes       |String(32)      | HMAC MD5 hash of the complete JSON string (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |
  
  
Line 177: Line 177:
 |amount         |yes       |Integer     |If a decimal currency is used, the amount has to be in the smallest unit of value, e.g. Cent, Penny | |amount         |yes       |Integer     |If a decimal currency is used, the amount has to be in the smallest unit of value, e.g. Cent, Penny |
 |currency       |yes       |String(3)   |Currency according to [[http://de.wikipedia.org/wiki/ISO_4217#Aktuell_g.C3.BCltige_W.C3.A4hrungen|ISO 4217]].\\ EUR = Euro | |currency       |yes       |String(3)   |Currency according to [[http://de.wikipedia.org/wiki/ISO_4217#Aktuell_g.C3.BCltige_W.C3.A4hrungen|ISO 4217]].\\ EUR = Euro |
-|reference      |yes       |String      |GiroCheckout transaction ID from a previous transaction, which the capture or refund is for | +|reference      |yes       |String(36)      |GiroCheckout transaction ID from a previous transaction, which the capture or refund is for | 
-|purpose        |optional  |String      |Purpose of the refund. This information is printed on the credit card statement. | +|purpose        |optional  |String(27)      |Purpose of the refund. This information is printed on the credit card statement. | 
-|hash           |yes       |String      |HMAC MD5 hash on the complete call. See [[en:girocheckout:general:start#hash_generation|hash generation]] |+|hash           |yes       |String(32)      |HMAC MD5 hash on the complete call. See [[en:girocheckout:general:start#hash_generation|hash generation]] |
  
 == Example == == Example ==
Line 190: Line 190:
 ^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      |yes       |String    |Unique GiroCheckout transaction ID | +|reference      |yes       |String(36)    |Unique GiroCheckout transaction ID | 
-|merchantTxId   |yes       |String      | Unique transaction id of the merchant | +|merchantTxId   |yes       |String(255)      | Unique transaction id of the merchant | 
-|backendTxId    |yes       |String      | Payment processor transaction ID |+|backendTxId    |yes       |String(26)      | Payment processor transaction ID |
 |amount         |yes       |Integer     | If a decimal currency is used, the amount has to be in the smallest unit of value, e.g. Cent, Penny | |amount         |yes       |Integer     | If a decimal currency is used, the amount has to be in the smallest unit of value, e.g. Cent, Penny |
-|currency       |yes       |String      | Currency |+|currency       |yes       |String(3)      | Currency |
 |resultPayment  |yes       |Integer     | [[en:girocheckout:resultcodes#result_codes_payment|Payment result codes]]| |resultPayment  |yes       |Integer     | [[en:girocheckout:resultcodes#result_codes_payment|Payment result codes]]|
 ^HEADER parameter^^^^ ^HEADER parameter^^^^
-|hash           |yes       |String    |HMAC MD5 hash on the complete JSON string. (see [[en:girocheckout:general:start#api_call_reply_to_the_merchant|api call reply]]) |+|hash           |yes       |String(32)    |HMAC MD5 hash on the complete 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/bluecode/start.txt · Last modified: 2023/05/08 02:05