How should I describe my API Pull?

Modified on Thu, 16 Sep, 2021 at 3:14 PM

To create an offering via API, you must describe each of the URLs that is available in that offering. To validate this step, you must indicate:

  • A name: strictly indicative information that enables your acquirers to understand the logic of your API and the data that is available for the URL in question.
  • URL: exact URL
  • Type of query: GET or POST (how information is sent, depending on sensitivity)
  • Data output format: indicative information that tells your acquirers the output format for your data (CSV, JSON, XML, etc.).
  • Parameters: Parameters are detected automatically when your URL is saved. You may change, add, or delete them at any time.

Three methods are available for sending: in the URL, in the path, or in the body of the query. Each parameter may be optional.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article