Requests Reference Overview

Requests

You use requests to integrate the API with your checkout process or applications.

You use a combination of an endpoint in the API and a method to model the functions that you use to integrate the service and your checkout process or applications.

For example, you might use the Confirming Transactions (POST + /seller/transactions/key/confirm) request to confirm a transaction in your basket after payment is confirmed.

The following requests are available:

Fields

Specific information is sent to the API and returned by the API as values for fields. These fields are grouped together in JSON object arrays such as Transaction Line object or the Address object.

For more information about the available fields, see Fields Reference section.

Responses

Responses are returned by the API for specific requests. These contain information request's body in the same JSON format that you use to send information to the API.

In general, but not always, the responses returned match the fields that are sent in the associated request. In some cases, you may also find that a response contains more or fewer fields than were specified in the body of the request. These might be added by the API and returned for information purposes. For example, an identifier that is added by the API is returned in a request when the transaction is confirmed.

{key} values

The {key} value represents the specific transaction that you want to perform the request on. More information is provided in the Transaction Keys topic.