====== UATP Integration ======

With the GiroCheckout API giropay, iDEAL and EPS can be integrated with UATP support. The integration is only slightly different from a //standard// integration.

**[[en:girocheckout:giropay:start|To documentation for giropay integration]]**\\
**[[en:girocheckout:eps:start|To documentation for eps integration]]**\\
**[[en:girocheckout:ideal:start|To documentation for iDEAL integration]]**

===== Extensions =====

==== Notification about the payment result ====
With the webservice [[en:girocheckout:giropay:start#notification_about_the_payment_result|notification about the payment result]] the UATP information will be forwarded. \\
See the parameter in this case is as follows.

== GET Parameter ==
^name           ^mandatory  ^type        ^description   ^
|gcReference      |Ja       |String      |GiroCheckout transaction ID |
|gcMerchantTxId   |Ja       |String      |merchant transaction ID |
|gcBackendTxId    |Ja       |String      |payment processor transaction ID |
|gcAmount         |Ja       |Integer     |if a decimal currency is used, the amount has to be in the smallest unit of value, eg. cent, penny |
|gcCurrency       |Ja       |String      |currency |
|gcResultPayment  |Optional |Integer     |[[en:girocheckout:resultcodes#zahlungsausgang|payment result codes]]|
|gcResultAVS      |Optional |Integer     |[[en:girocheckout:resultcodes#altersverifikation|age verification result codes]] |
|gcUatpcard       |Optional |String      |UATP cardnumber |
|gcUatpexpdate    |Optional |String      |expiry date of UATP card (format: MMYY) |
|gcUatpstatus     |Optional |Integer     |1 = card issued, 0 = error during card issue  |
==== Get transaction information ====
Through this API there are provided transaction data of past transaction with UATP information. 

=== request ===
**URL:** https://payment.girosolution.de/girocheckout/api/v2/transaction/statusUATP \\
**provided by:** GiroCheckout \\
**called by:** merchant

== POST parameter ==
^name           ^mandatory  ^type      ^description   ^
|merchantId     |Ja       |Integer   |merchant ID  |
|projectId      |Ja       |Integer   |project ID |
|reference      |Ja       |String    |GiroCheckout transaction id  |
|hash           |Ja       |String(32)|HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |

=== reply ===
The reply includes a JSON encoded string. The field rc contains the response code. If it is 0 the request has been successfully processed.

== params ==
^name           ^mandatory  ^type      ^description   ^
|rc             |yes       |Integer   |[[girocheckout:errorcodes|response code]] |
|msg            |yes       |String    |additional information about the response code |
|reference      |optional |String    |unique GiroCheckout transaction ID |
|backendTxId    |optional |String    |payment processor transaction id |
|amount         |optional |Integer   |if a decimal currency is used, the amount is in the smallest unit of value, eg. Cent, Penny |
|currency       |optional |Integer   |currency |
|resultPayment  |optional |Integer   |[[girocheckout:resultcodes#zahlungsausgang|payment result codes]] |
|resultAVS      |optional |Integer   |[[girocheckout:resultcodes#altersverifikation|result of the age verification (in case of a giropay-ID transaction)]]  |
|obvName        |optional |String    | Optional adjustable field, which includes the name of the person who has to be verified (in case of a giropay-ID transaction) |
|uatpCard       |Optional |String    |UATP cardnumber |
|uatpExpdate    |Optional |String    |expiry date of UATP card (format: MMYY) |
|uatpStatus     |Optional |Integer   |1 = card issued, 0 = error during card issue |

===== UATP authorization system =====
For every **successful** giropay, iDEAL and EPS Transaktion a UATP card will be issued and the card limit will be set to the transaction amount.