Skip to content

Get definitions of supported electronic payments providers

  Less than to read

Send a GET request with these headers to get definitions of electronic payments providers. Payments Out Service uses these to generate payments for particular countries.


GET /v3/providers?country={country} HTTP/1.1
x-application: {app name}
x-fapi-interaction-id: {UUID}
x-api-key: {api key}


  • {country} is the country you want to get the definitions of supported payment providers for. Specify the country using ISO 3166-1 Alpha-2 format. For example: AU.

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

  • {UUID} is a Universally Unique Identifier to write into logs. This value is used to debug your application’s integration with Payments Out Service. Use a new UUID for each request. UUIDs must conform to RFC 4122.

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

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


The $.data.accountType.validationRules element in the JSON response provides the rules that define how your batch of payments must be formatted. They need to follow this format so Payments Out Service can submit electronic payments to the provider. For an explanation of how provider rules work, go to Understand provider rules.

For descriptions of the JSON elements in the response, go to the Responses section in Retrieve all payment providers.

Example response

Go to the example response to see the format of responses for supported payment providers in the US.