Document Collector API
The Document Collector API enables merchants to upload supporting documentation required for payment processing. Currently, it supports uploading cross-border…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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/crossBorderInvoicesGoing 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.
Endpoints 1
Documents
- POSTUpload a document
/crossBorderInvoicesUploads a document for a merchant account.
API details
- Base URL
https://document-collector-test.adyen.com/v1https://document-collector-live.adyen.com/v1- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 1 operation on 1 pathPOST 1
- Main resources
- Documents 1
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the Document Collector API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Document Collector API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Upload a document” (POST /crossBorderInvoices), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Document Collector API?
The Document Collector API enables merchants to upload supporting documentation required for payment processing. Currently, it supports uploading cross-border… It is listed under Payments and has 1 endpoint.
Who publishes the Document Collector API?
It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Document Collector API?
Its description lists 2 base URLs: https://document-collector-test.adyen.com/v1, https://document-collector-live.adyen.com/v1. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Document Collector API?
It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).
How many endpoints does the Document Collector API have?
1 operation on 1 path (1 POST). The largest groups are Documents.
Is forking the Document Collector API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.