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
Next revision
Previous revision
en:girocheckout:bluecode:start [2019/06/11 18:39]
michaelheumann
en:girocheckout:bluecode:start [2023/05/08 02:05] (current)
michaelheumann
Line 1: Line 1:
-====== Blue Code ======+====== Bluecode ======
  
-You may find further information on the payment method "Blue Code" here: https://www.bluecode.com/.+You may find further information on the payment method "Bluecode" here: https://www.bluecode.com/.
  
 ===== Testdata ===== ===== Testdata =====
Line 18: Line 18:
 </uml> </uml>
  
-===== Initializing a Blue Code payment =====+===== Initializing a Bluecode payment =====
 After a successful initialization a reference number and a redirect link is transmitted to the merchant. The transmitted link leads to the payment form, to which the customer must be redirected. This may be done via an HTTP redirect hreader, an HTML page with a meta tag or Javascript. After a successful initialization a reference number and a redirect link is transmitted to the merchant. The transmitted link leads to the payment form, to which the customer must be redirected. This may be done via an HTTP redirect hreader, an HTML page with a meta tag or Javascript.
  
Line 32: Line 32:
 participant "Shop" as shop participant "Shop" as shop
 participant "GiroCheckout" as girocheckout participant "GiroCheckout" as girocheckout
-participant "Blue Code" as bc+participant "Bluecode" as bc
  
 autonumber autonumber
Line 54: Line 54:
 </uml> </uml>
  
-  - Customer selects payment method Blue Code +  - Customer selects payment method Bluecode 
-  - Shop initializes Blue Code transaction ([[en:girocheckout:bluecode:start#initializing_a_blue_code_payment|Initialization]])+  - Shop initializes Bluecode transaction ([[en:girocheckout:bluecode:start#initializing_a_bluecode_payment|Initialization]])
   - Shop receives response about transaction outcome (transaction ends on error) and sends redirect URL to customer browser   - Shop receives response about transaction outcome (transaction ends on error) and sends redirect URL to customer browser
-  - Customer browser forwards to the Blue Code payment page, where a QR code is displayed (in Desktop variant) +  - Customer browser forwards to the Bluecode payment page, where a QR code is displayed (in Desktop variant) 
-  - Customer scans QR code with his smartphone (Blue Code App) (in Desktop variant) +  - Customer scans QR code with his smartphone (Bluecode App) (in Desktop variant) 
-  - Blue Code sends message to customer smartphone and waits for confirmation+  - Bluecode sends message to customer smartphone and waits for confirmation
   - Customer authorizes the transaction on his smartphone   - Customer authorizes the transaction on his smartphone
-  - Blue Code processes the transaction+  - Bluecode processes the transaction
   - Customer clicks "Back to shop" ([[en:girocheckout:bluecode:start#redirecting_the_customer_to_the_merchant|Redirect]])   - Customer clicks "Back to shop" ([[en:girocheckout:bluecode:start#redirecting_the_customer_to_the_merchant|Redirect]])
-  - Blue Code transmits result to GiroCheckout+  - Bluecode transmits result to GiroCheckout
   - GiroCheckout notifies shop about transaction outcome ([[en:girocheckout:bluecode:start#notification_about_payment_result|Notification]])   - GiroCheckout notifies shop about transaction outcome ([[en:girocheckout:bluecode:start#notification_about_payment_result|Notification]])
   - Shop processes transaction outcome   - Shop processes transaction outcome
Line 83: Line 83:
  
 ^Name           ^Mandatory  ^Type        ^Description   ^ ^Name           ^Mandatory  ^Type        ^Description   ^
-|merchantId     |Yes       |Integer     |Merchant ID of a Blue Code project | +|merchantId     |Yes       |Integer     |Merchant ID of a Bluecode project | 
-|projectId      |Yes       |Integer     |Project ID of a Blue Code project | +|projectId      |Yes       |Integer     |Project ID of a Bluecode project | 
-|merchantTxId   |Yes       |String(255) |Unique merchant transaction ID |+|merchantTxId   |Yes       |String(255) |Unique merchant transaction ID. Allowed characters: any letters (incl. language-specific special characters such as German Umlauts), 0-9, symbols & = + , : ; . _ ! ? # /  |
 |amount         |Yes       |Integer     |If a decimal currency is used, the amount has to be in the smallest unit of value, eg. Cent, Penny | |amount         |Yes       |Integer     |If a decimal currency is used, the amount has to be in the smallest unit of value, eg. Cent, Penny |
 |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. | 
-|hash           |Yes       |String      |HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |+|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(32)      |HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |
  
 == Example == == Example ==
Line 97: Line 98:
  
 ==== Response ==== ==== Response ====
-The response is a JSON object. The field rc returns an error code.  If rc=0 is returned, the transaction was initialized successfully. As a response, you receive a transaction number and the redirectURL to the Blue Code payment page. +The response is a JSON object. The field rc returns an error code.  If rc=0 is returned, the transaction was initialized successfully. As a response, you receive a transaction number and the redirectURL to the Bluecode payment page. 
  
 === Parameters === === Parameters ===
 ^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 Blue Code 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 113: Line 114:
 == Example in case of failure == == Example in case of failure ==
 {{page>codesamples:bluecode#transactionstart.response.false&noheader&nofooter}} {{page>codesamples:bluecode#transactionstart.response.false&noheader&nofooter}}
- 
  
 ==== Notification about payment result ==== ==== Notification about payment result ====
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 174: Line 174:
 |merchantId     |yes       |Integer     |Merchant ID | |merchantId     |yes       |Integer     |Merchant ID |
 |projectId      |yes       |Integer     |Project ID| |projectId      |yes       |Integer     |Project ID|
-|merchantTxId   |yes       |String(255) |Unique transaction id of the merchant |+|merchantTxId   |yes       |String(255) |Unique transaction id of the merchant. Allowed characters: any letters (incl. language-specific special characters such as German Umlauts), 0-9, symbols & = + , : ; . _ ! ? # /  |
 |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