Skip to content
Developerhome
Product homepage
Payments Out Service

Get list of supported payment types

  Less than to read

Payment types that can be specified when submitting electronic payments using Payments Out Service are exposed through the localinstruments endpoint.

This returns all payment types available through Payments Out Service. Not all providers support all payment types.

To see which are supported by a provider:

  • Retrieve the provider’s definition file
  • Check the IDs in its localInstruments array

The name that’s used here may not necessarily match.

For more information, go to Get definitions of supported electronic payments providers and Understand provider rules.

Local instruments (payment types) have rules assigned to them to define the information required by a local instrument. Some examples of local instruments are:

  • BACS requires a sort code and account number to be supplied.
  • ACH requires a routing number and account number.
  • Cheque (check) requires an address and postal (zip) code.

Provider-specific rules should be used in combination with rules referenced in the provider’s local instruments list. This will give a complete set of rules for that provider. If a rule exists at both a provider and at local instrument level (based on the same apiPath and jsonPath) then the provider rule should take precedence over the local instrument rule.

To obtain the list of available payment types, send a GET request with these headers:

Headers

GET /v3/localinstruments HTTP/1.1
Host: api-payout.sage.com
x-application: {app name}
x-api-key: {api key}

Where:

  • {app name} is the name of an application supported by Payments Out Service, in an acceptable format. For example, sage.intacct.

  • {api key} is the API key for the Consumer API.

For information about these parameters, go to the Consumer API reference.

Response

The $.data.validationRules element in the JSON response shows the rules that define the data required for each payment type.

For descriptions of the JSON elements in the response, go the Responses section in Retrieve payment types.

Example response

Take a look at the example response for local instruments data.