Terms and Conditions API Spec

Terms and Conditions (SEPA EUR)

GET

/v1/boarding/workflows/sepa-eur/terms/{partner}/{file_type}/version

Description

Returns latest version of T&Cs doc for a European SEPA application.

Parameters

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

Responses

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 } }

GET

/v1/boarding/workflows/sepa-eur/terms/{partner}/{file_type}/version/{version}

Description

Returns T&Cs for a European SEPA application.

Parameters

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

Responses

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 } }

Terms and Conditions (BACS GBP)

GET

/v1/boarding/workflows/bacs-gbp/terms/{partner}/{file_type}/version

Description

Returns latest version of T&Cs doc for a United Kingdom BACS application.

Parameters

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

Responses

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 } }

GET

/v1/boarding/workflows/bacs-gbp/terms/{partner}/{file_type}/version/{version}

Description

Retrieves T&Cs for a United Kingdom BACS application.

Parameters

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

Responses

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 } }

Terms and Conditions (ACH USD)

GET

/v1/boarding/workflows/ach-usd/terms/{partner}/{file_type}/version

Description

Returns latest version of T&Cs doc for US ACH application.

Parameters

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

Responses

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 } }

GET

/v1/boarding/workflows/ach-usd/terms/{partner}/{file_type}/version/{version}

Description

Retrieves T&Cs for a US ACH application.

Parameters

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

Responses

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 } }

Terms and Conditions (EFT CAD)

GET

/v1/boarding/workflows/eft-cad/terms/{partner}/{file_type}/version

Description

Returns latest version of T&Cs doc for a Canada EFT application.

Parameters

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

Responses

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 } }

GET

/v1/boarding/workflows/eft-cad/terms/{partner}/{file_type}/version/{version}

Description

Retrieves T&Cs for a Canada EFT application.

Parameters

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

Responses

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 } }

Terms and Conditions (PSP CAD)

GET

/v1/boarding/workflows/psp-cad/terms/{partner}/{file_type}/version

Description

Returns latest version of T&Cs for a Canada PSP application.

Parameters

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

Responses

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 } }

GET

/v1/boarding/workflows/psp-cad/terms/{partner}/{file_type}/version/{version}

Description

Retrieves T&Cs for a Canada PSP application. The input parameters must be the same as the ones used to retrieve the version.

Parameters

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

Responses

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 } }

Terms and Conditions (PSP USD)

GET

/v1/boarding/workflows/psp-usd/terms/{partner}/{file_type}/version

Description

Returns latest version of T&Cs for a US PSP application.

Parameters

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

Responses

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 } }

GET

/v1/boarding/workflows/psp-usd/terms/{partner}/{file_type}/version/{version}

Description

Retrieves T&Cs for a US PSP application.

Parameters

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

Responses

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 } }

Terms and Conditions (GW CDN)

GET

/v1/boarding/workflows/gw-cdn/terms/{partner}/{file_type}/version

Description

Returns latest version of T&Cs for a Canadian Gateway application.

Parameters

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

Responses

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 } }

GET

/v1/boarding/workflows/gw-cdn/terms/{partner}/{file_type}/version/{version}

Description

Retrieves T&Cs for a Canadian Gateway application.

Parameters

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

Responses

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 } }

Terms and Conditions (GW USA)

GET

/v1/boarding/workflows/gw-usa/terms/{partner}/{file_type}/version

Description

Returns latest version of T&Cs for an American Gateway application.

Parameters

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

Responses

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 } }

GET

/v1/boarding/workflows/gw-usa/terms/{partner}/{file_type}/version/{version}

Description

Retrieves T&Cs for an American Gateway application.

Parameters

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

Responses

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 } }

Onboarding API TAC

Operations