Onboarding API Terms and Conditions Specifications
Version: 2016-08-18
Returns latest version of T&Cs doc for a European SEPA application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
Code | Description | Schema |
---|---|---|
200 | Document version info | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document.
version
:
string
description:
Defines the version of the document returned. name : string format: flow/partner/file_type/date:time description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Returns T&Cs for a European SEPA application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
true | path | version | The version of the document. | string |
Code | Description | Schema |
---|---|---|
200 | Document retrieved with identifying properties in HTTP header | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document. [HTTP header]
X-Version
:
string
description:
Defines the version of the document returned. X-Name : string format: flow/partner/file_type description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Returns latest version of T&Cs doc for a United Kingdom BACS application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
Code | Description | Schema |
---|---|---|
200 | Document version info | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document.
version
:
string
description:
Defines the version of the document returned. name : string format: flow/partner/file_type/date:time description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Retrieves T&Cs for a United Kingdom BACS application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
true | path | version | The version of the document. | string |
Code | Description | Schema |
---|---|---|
200 | Document retrieved with identifying properties in HTTP header | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document. [HTTP header]
X-Version
:
string
description:
Defines the version of the document returned. X-Name : string format: flow/partner/file_type description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Returns latest version of T&Cs doc for US ACH application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
Code | Description | Schema |
---|---|---|
200 | Document version info | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document.
version
:
string
description:
Defines the version of the document returned. name : string format: flow/partner/file_type/date:time description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Retrieves T&Cs for a US ACH application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
true | path | version | The version of the document. | string |
Code | Description | Schema |
---|---|---|
200 | Document retrieved with identifying properties in HTTP header | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document. [HTTP header]
X-Version
:
string
description:
Defines the version of the document returned. X-Name : string format: flow/partner/file_type description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Returns latest version of T&Cs doc for a Canada EFT application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
Code | Description | Schema |
---|---|---|
200 | Document version info | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document.
version
:
string
description:
Defines the version of the document returned. name : string format: flow/partner/file_type/date:time description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Retrieves T&Cs for a Canada EFT application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
true | path | version | The version of the document. | string |
Code | Description | Schema |
---|---|---|
200 | Document retrieved with identifying properties in HTTP header | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document. [HTTP header]
X-Version
:
string
description:
Defines the version of the document returned. X-Name : string format: flow/partner/file_type description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Returns latest version of T&Cs for a Canada PSP application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
false | query | lng | The language of the T&Cs document to be returned. Either "fr" or "en". | string |
Code | Description | Schema |
---|---|---|
200 | Document version info | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document.
version
:
string
description:
Defines the version of the document returned. name : string format: flow/partner/file_type/date:time description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Retrieves T&Cs for a Canada PSP application. The input parameters must be the same as the ones used to retrieve the version.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
true | path | version | The version of the document. | string |
false | query | lng | The language of the T&Cs document to be returned. Either "fr" or "en". | string |
Code | Description | Schema |
---|---|---|
200 | Document retrieved with identifying properties in HTTP header. | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document. [HTTP header]
X-Version
:
string
description:
Defines the version of the document returned. X-Name : string format: flow/partner/file_type description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Returns latest version of T&Cs for a US PSP application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
Code | Description | Schema |
---|---|---|
200 | Document version info | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document.
version
:
string
description:
Defines the version of the document returned. name : string format: flow/partner/file_type/date:time description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Retrieves T&Cs for a US PSP application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
true | path | version | The version of the document. | string |
Code | Description | Schema |
---|---|---|
200 | Document retrieved with identifying properties in HTTP header | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document. [HTTP header]
X-Version
:
string
description:
Defines the version of the document returned. X-Name : string format: flow/partner/file_type description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Returns latest version of T&Cs for a Canadian Gateway application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
Code | Description | Schema |
---|---|---|
200 | Document version info | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document.
version
:
string
description:
Defines the version of the document returned. name : string format: flow/partner/file_type/date:time description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Retrieves T&Cs for a Canadian Gateway application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
true | path | version | The version of the document. | string |
Code | Description | Schema |
---|---|---|
200 | Document retrieved with identifying properties in HTTP header | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document. [HTTP header]
X-Version
:
string
description:
Defines the version of the document returned. X-Name : string format: flow/partner/file_type description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Returns latest version of T&Cs for an American Gateway application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
Code | Description | Schema |
---|---|---|
200 | Document version info | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document.
version
:
string
description:
Defines the version of the document returned. name : string format: flow/partner/file_type/date:time description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |
Retrieves T&Cs for an American Gateway application.
Required | In | Name | Description | Schema |
---|---|---|---|---|
true | path | partner | The name of the partner, if customized T&Cs have been agreed. Pass "default" for the default version of the document. | string |
true | path | file_type | The format of the T&Cs document to be returned. Either "html" or "pdf". | string |
true | path | version | The version of the document. | string |
Code | Description | Schema |
---|---|---|
200 | Document retrieved with identifying properties in HTTP header | 200 Response |
404 | Document not found | ErrorResponse |
Response Schema Definitions |
---|
200 Response
{
Defines information about the document. [HTTP header]
X-Version
:
string
description:
Defines the version of the document returned. X-Name : string format: flow/partner/file_type description:Defines the name of the document returned. } |
ErrorResponse
{
Defines an error response
response_status
:
integer
description:
The http response code returned errors : array of Error { Defines an error name : string description:A field associated with the error reason : string description:A code associated with the error message : string description:A human readable message about the error } } |