Document Collector API

The Document Collector API enables merchants to upload supporting documentation required for payment processing. Currently, it supports uploading cross-border invoices in PDF format for transactions processed in INR, as required under the Reserve Bank of India (RBI) guidelines for cross-border payments.

Authentication

Your Adyen contact will provide your API credential and an API key. To connect to the API, add an X-API-Key header with the API key as the value, for example:

curl
-H "Content-Type: multipart/form-data" \
-H "X-API-Key: YOUR_API_KEY" \
...

Alternatively, you can use the username and password to connect to the API using basic authentication. For example:

curl
-H "Content-Type: multipart/form-data" \
-U "ws@Company.YOUR_COMPANY":"YOUR_WS_PASSWORD" \
...

Versioning

The Document Collector API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://document-collector-test.adyen.com/v1/crossBorderInvoices

Going live

When going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to https://document-collector-live.adyen.com/v1.