...
Sending the test document to the Gini Pay API. See Submit Files.
Requesting the results. See Retrieve Extractions.
You should get a JSON like in the example.
Correcting the document with the following JSON. Here we change the
amountToPayfrom "995.00:EUR" to "950.00:EUR" and confirm the other field values (iban,bic,paymentRecipient,paymentReference).We added the instant payment support and here you also see the new field
instantPaymentwhere the instant payment has been detected to be enabled the field will show true or if it’s not available it shows as false.
| Code Block | ||
|---|---|---|
| ||
{
"feedback": {
"amountToPay": {
"value": "950.00:EUR"
},
"iban": {
"value": "DE68130300000017850360"
},
"bic": {
"value": "BYLADEM1001"
},
"paymentPurpose": {
"value": "RE-20170512-02"
},
"paymentRecipient": {
"value": "Fahrrad Rückenwind"
},
"instantPayment": {
"value": "false"
},
}
} |
Below we show a more elaborated example including the Return Assistant compound extractions (if RA is enabled) in order to explain different types of the transfer summary. In our current API, we started to support alternative JSON keys for it. For example, instead of "feedback" key when submitting the summary, you can use "extractions" and "compoundExtractions" as you will see in the examples below.
...
| Code Block | ||
|---|---|---|
| ||
{
"candidates": {},
"extractions": {
"amountToPay": {
"box": {
"height": 8.0,
"left": 545.0,
"page": 1,
"top": 586.0,
"width": 17.0
},
"candidates": "amounts",
"entity": "amount",
"value": "45.44:EUR"
},
"iban": {
"box": {
"height": 7.0,
"left": 447.0,
"page": 1,
"top": 746.0,
"width": 100.0
},
} "candidates": "ibans",
"entity": "iban",
"candidatesvalue": "ibansDE14200800000816170700",
},
"instantPayment": {
"entity": "ibantext",
"value": "DE14200800000816170700true"
},
"paymentReference": {
"entity": "reference",
"value": "ReNr 123, KdNr 32"
},
"discount-addon": {
"entity": "amount",
"value": "-2.51:EUR"
},
"amountsAreConsistent": {
"entity": "text",
"value": "true"
}
},
"compoundExtractions": {
"lineItems": [
{
"artNumber": {
"value": "10101",
"entity": "text"
},
"quantity": {
"value": "2",
"entity": "numeric"
},
"description": {
"value": "Trocknerbälle, Wolle, 2er",
"entity": "text"
},
"sumGross": {
"value": "17.98:EUR",
"entity": "amount"
}
},
{
"artNumber": {
"value": "10103",
"entity": "text"
},
"quantity": {
"value": "3",
"entity": "numeric"
},
"description": {
"value": "Faltenstopp f. Wäscheständer",
"entity": "text"
},
"sumGross": {
"value": "29.97:EUR",
"entity": "amount"
}
}
]
}
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"extractions": {
"amountToPay": {
"value": "45.44:EUR"
},
"iban": {
"value": "DE14200800000816170700"
},
"bic": {
"value": "BYLADEM1001"
},
"instantPayment": {
"value": "false"
},
"paymentPurpose": {
"value": "RE-20170512-02"
},
"paymentRecipient": {
"value": "Tchibo GmbH"
},
"amountsAreConsistent": {
"entity": "text",
"value": "true"
},
"discount-addon": {
"entity": "amount",
"value": "-2.51:EUR"
}
},
"compoundExtractions": {
"lineItems": [
{
"artNumber": {
"value": "10101"
},
"quantity": {
"value": "0"
},
"description": {
"value": "Trocknerbälle, Wolle, 2er",
"entity": "text"
},
"sumGross": {
"value": "17.98:EUR",
"entity": "amount"
},
"returnReason": {
"value": "r3"
}
},
{
"artNumber": {
"value": "10103"
},
"quantity": {
"value": "3"
},
"description": {
"value": "Faltenstopp f. Wäscheständer",
"entity": "text"
},
"sumGross": {
"value": "29.97:EUR",
"entity": "amount"
}
}
]
}
} |
...