Page Comparison

...

Submit documents by sending a POST request to the /documents resource path. After successful submission, the location of the new document is returned in the Location header.

Info
Please note that we reject and don’t process files with wrong format or bad quality. In this case we return 400 error in the response message.

The Gini Pay API currently supports two different variants of uploads, one optimized for web applications running in a web browser and the other for all other types of clients. The first variant optimized for web applications expects the documents to be uploaded using a multipart/form-data encoding method. The second variant for all other clients simply uses the request body (independent of the request Content-Type) as the document.

...

Status Code	Description
400 (Bad Request)	Returned when a file is sent in an invalid format or has a bad quality which we are unable to process.
401 (Unauthorized)	Authorization credentials are either missing, wrong or outdated.
415	Content type is not supported.
503	Service unavailable. Try again later.

...

Pages that are part of the document are referred to as partial documents. If you want to upload a page (or a page picture) that belongs to the document, your request header should additionally include Content-Type field with application/vnd.gini.v1.partial+png value or application/vnd.gini.v1.partial+pdf in case of PDF page. See the examples below.

In case you want to submit a parsed QR code, please use application/vnd.gini.v1.partial+qr+json. The parsing of the QR field fields is optional. The paymentdata needs to contain at least the iban and the paymentRecipient keys. Hence, but the values can be emptythe minimal valid QR code body could be the following:

Code Block

language	json

{
  "qrcode": "bank://singlepaymentsepa?name=Gini%20Online%20Shop&reason=A12345-6789&iban=DE89370400440532013000&bic=GINIBICXXX&amount=47%2C65&currency=EUR",
  "paymentdata": {
    "iban": "DE01234567898765432101",
    "paymentRecipient": "Telekom GmbH"
  }
}

Mandatory QR fields

Key	Value
`iban`	`DE01234567898765432101`
`paymentRecipient`	`Telekom GmbH`

Optional QR fields

Key	Value
`amountToPay`	`25.79:EUR`
`bic`	`SPESDE3EXXX`
`paymentReference`	`Nr.12345`

See the complete QR request example below.

Request

In order to upload a page picture or a partial document, specify a different content type:

Info

application/vnd.gini.v1.partial+<FILE_TYPE>

For example, `applicationapplication/vnd.gini.v1.partial+png` png for images

Headers

Header	Value
`Content-Type`	`multipart/form-data; boundary=...`
	`/`
`Accept`	`application/vnd.gini.v1+json`
`x-document-metadata-branchid`	`some customer specific id`
`x-document-metadata-deviceclass`	`desktop_device` or `mobile_device`

...

Header	Value
`Content-Type`	`application/vnd.gini.v1+json`
`Location`	Absolute URI (created partial document URI) which should be referred by a composite document.

Errors

Status Code	Description
400 (Bad Request)	Returned when the sent file has invalid format or has a bad quality which we are unable to process.
401 (Unauthorized)	Authorization credentials are either missing, wrong or outdated.
415	Content type is not supported.
503	Service unavailable. Try again later.

Anchor

	partial_doc_examples
	partial_doc_examples

Code Block

language	json

//upload a partial document

//variant for web applications running in a web browser with access token:

curl -H 'Authorization: BEARER <token>'
    --form 'file=@file.JPEG'
    -H 'Accept: application/vnd.gini.v1+json'
    -H 'Content-Type: application/vnd.gini.v1.partial+png'
    -i https://pay-api.gini.net/documents
    
//variant for other types of applications with access token:

curl -H 'Authorization: BEARER <token>'
    --data-binary '@file.JPEG'
    -H 'Accept: application/vnd.gini.v1+json'
    -H 'Content-Type: application/vnd.gini.v1.partial+png'
    -i https://pay-api.gini.net/documents?filename=file.JPEG

//or with X-User-identifier (see how to setup X-User-identifier):

curl -H 'X-User-Identifier: user1'
    --form 'file=@file.JPEG'
    -H 'Accept: application/vnd.gini.v1+json'
    -H 'Content-Type: application/vnd.gini.v1.partial+png'
    -u 'client-id:client-secret'
    -i https://pay-api.gini.net/documents
    
// variant for QR code 
curl -H 'Authorization: BEARER <token>'
    --form 'data.json={
        "qrcode": "bank://singlepaymentsepa?name=Gini%20Online%20Shop&reason=A12345-6789&iban=DE89370400440532013000&bic=GINIBICXXX&amount=47%2C65&currency=EUR",
          "paymentdata": {
            "amountToPay": "25.79:EUR",
            "paymentRecipient": "Telekom GmbH",
            "iban": "<IBAN>DE01234567898765432101",
            "bic": "<BIC>SPESDE3EXXX",
            "paymentReference": "<REFERENCE>Nr.12345"
          }
      }'
    -H 'Accept: application/vnd.gini.v1+json'
    -H 'Content-Type: application/vnd.gini.v1.partial+png'
    -i https://pay-api.gini.net/documents

...

Status Code	Description
400 (Bad Request)	Returned when a file was sent in an invalid format is sentor has a bad quality which we are unable to process.
401 (Unauthorized)	Authorization credentials are either missing, wrong or outdated.
415	Content type not supported.
503	Service unavailable. Try again later.

...

Versions Compared

Old Version 15

New Version Current

Key

Mandatory QR fields

Optional QR fields

Request

Headers

Errors