Files Via API

Introduction

You can now collect your Payment Information Files by API, which stands for Application Programming Interface. An API is a set of rules and protocols that allow two separate applications to talk to one another.

A great analogy for this is if you go out to a restaurant for food, you don’t go into the kitchen yourself and start making food. At a restaurant you give your order to one of the waiting staff, who take that order to the kitchen, the staff prepare the food according to your order and then the waiting staff bring it back out to you. In this analogy the waiting staff are like the API.

To work with the allpay API you will need to ask your development team to ‘pass’ us the appropriate information indicated in the What should I give? box, below. You’ll notice that you will need to pass us an Apim subscription key, this is easy to find. Navigate to the Files Via Api page on the Payments Hub and at the top left you’ll find the Apim subscription key

For all requests you'll also need to generate a 'Subscription Key' this is easy to do. To generate a subscription key, simply navigate to Files Via Api on the Payments Hub, pop a name into the Key Name box and press the Generate Key button.

Requests

There are five requests that File by Api will respond to: