Onboarding API Spec

Name	In
api_key	header

Funds Transfer (SEPA EUR)

POST

/workflows/sepa-eur/applications

Description

Creates a new European SEPA application. The status of the application will be returned in the status object. A Location header that points to the URL of the new resource will be available in the response. The Location header has an application ID that should be used for all future requests to that application.

Parameters

Required	In	Name	Description	Schema
true	body	application	Application details	SepaEurApplicationRequest

Parameter Schema Definitions
SepaEurApplicationRequest { Defines a SEPA European application id : integer description: This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly] merchant_id : integer description: This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly] pricing_id* : string maxLength: 32 description: This is the reference number for the pricing package associated with an application status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description: Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD version* : string description: Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016 timestamp* : string format: date-time description: Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly] } email* : string maxLength: 500 } business* : SepaEurBusiness { The details of a European business company_name* : string maxLength: 64 annual_sales* : number format: float32 description: This is the annual sales volume in EUR. entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description: This is the business entity type website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description: This is the business start date in ISO 8601 format with a timezone registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description: This is the "doing business as" name batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } directors* : array of SepaEurDirector { Defines a SEPA European business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description: Defines the birthday in ISO 8601 format with a timezone start_date* : string format: date-time description: Defines the ownership start date in ISO 8601 format with a timezone percentage : number format: float32 maximum: 100 minimum: 0 description: Defines the percentage, from 0.00 to 100.00, of the company ownership. address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } } bank_account* : EuropeanBankAccount { Defines a European bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 swift_code* : string maxLength: 11 description: Must be either 8 or 11 characters in length. Characters 1-4 are letters (A-Z). Characters 5-6 are a valid ISO 3166-1 Alpha-2 country code (https://en.wikipedia.org/wiki/ISO3166-1alpha-2). To verify a SWIFT/BIC code and for example SWIFT/BIC codes, see https://formvalidation.io/guide/validators/bic/ iban* : string maxLength: 34 description: Must be valid IBAN. To verify an IBAN and get example IBANS, see https://formvalidation.io/guide/validators/iban bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description: First name of the primary contact for the bank account. last_name : string maxLength: 64 description: Last name of the primary contact for the bank account. email : string maxLength: 500 description: Email of the primary contact for the bank account. phone_number : string maxLength: 15 description: Phone number of the primary contact for the bank account. } } documents : array of SepaEurFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members mandate description: Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Mandate" type* : string Enum (6) jpg jpeg doc docx pdf png description: File type of the document; accepted file formats. notes : string description: Description of the document and the contents that it must contain. base64* : string description: The document data, submitted as a base64 encoded string.. uri : string description: The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly] } } custom_data : object description: Optional custom data, must be a JSON object. Example: {"id": 12345} }

Parameter Schema Definitions

SepaEurApplicationRequest { Defines a SEPA European application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : SepaEurBusiness { The details of a European business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in EUR.

entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description:

This is the business entity type

website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of SepaEurDirector { Defines a SEPA European business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : EuropeanBankAccount { Defines a European bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 swift_code* : string maxLength: 11 description:

Must be either 8 or 11 characters in length. Characters 1-4 are letters (A-Z). Characters 5-6 are a valid ISO 3166-1 Alpha-2 country code (https://en.wikipedia.org/wiki/ISO3166-1alpha-2). To verify a SWIFT/BIC code and for example SWIFT/BIC codes, see https://formvalidation.io/guide/validators/bic/

iban* : string maxLength: 34 description:

Must be valid IBAN. To verify an IBAN and get example IBANS, see https://formvalidation.io/guide/validators/iban

bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description:

First name of the primary contact for the bank account.

last_name : string maxLength: 64 description:

Last name of the primary contact for the bank account.

email : string maxLength: 500 description:

Email of the primary contact for the bank account.

phone_number : string maxLength: 15 description:

Phone number of the primary contact for the bank account.

} } documents : array of SepaEurFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members mandate description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Mandate"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
201	Application created	Status
400	Invalid request	Array of Error
500	Unexpected error	Error

Response Schema Definitions
Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/sepa-eur/applications

Description

Retrieves all European SEPA applications referenced by the given criteria in the url. A search criteria can be a combination of the following: - state={state} - Accepted values are "in_progress", "in_review", "on_hold", "approved" "rejected", "live" and "temp_disabled" - createdbefore={date} - createdafter={date} - updatedbefore={date} - updatedafter={date}

Documents file data will be excluded to limit the amount of data on the wire.

Parameters

No parameters

Responses

Code	Description	Schema
200	Application(s) retrieved	Array of SepaEurApplicationRequest
400	Invalid request	Array of Error
404	Applications not found	Error
500	Unexpected error	Error

Response Schema Definitions
SepaEurApplicationRequest { Defines a SEPA European application id : integer description: This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly] merchant_id : integer description: This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly] pricing_id* : string maxLength: 32 description: This is the reference number for the pricing package associated with an application status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description: Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD version* : string description: Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016 timestamp* : string format: date-time description: Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly] } email* : string maxLength: 500 } business* : SepaEurBusiness { The details of a European business company_name* : string maxLength: 64 annual_sales* : number format: float32 description: This is the annual sales volume in EUR. entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description: This is the business entity type website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description: This is the business start date in ISO 8601 format with a timezone registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description: This is the "doing business as" name batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } directors* : array of SepaEurDirector { Defines a SEPA European business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description: Defines the birthday in ISO 8601 format with a timezone start_date* : string format: date-time description: Defines the ownership start date in ISO 8601 format with a timezone percentage : number format: float32 maximum: 100 minimum: 0 description: Defines the percentage, from 0.00 to 100.00, of the company ownership. address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } } bank_account* : EuropeanBankAccount { Defines a European bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 swift_code* : string maxLength: 11 description: Must be either 8 or 11 characters in length. Characters 1-4 are letters (A-Z). Characters 5-6 are a valid ISO 3166-1 Alpha-2 country code (https://en.wikipedia.org/wiki/ISO3166-1alpha-2). To verify a SWIFT/BIC code and for example SWIFT/BIC codes, see https://formvalidation.io/guide/validators/bic/ iban* : string maxLength: 34 description: Must be valid IBAN. To verify an IBAN and get example IBANS, see https://formvalidation.io/guide/validators/iban bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description: First name of the primary contact for the bank account. last_name : string maxLength: 64 description: Last name of the primary contact for the bank account. email : string maxLength: 500 description: Email of the primary contact for the bank account. phone_number : string maxLength: 15 description: Phone number of the primary contact for the bank account. } } documents : array of SepaEurFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members mandate description: Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Mandate" type* : string Enum (6) jpg jpeg doc docx pdf png description: File type of the document; accepted file formats. notes : string description: Description of the document and the contents that it must contain. base64* : string description: The document data, submitted as a base64 encoded string.. uri : string description: The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly] } } custom_data : object description: Optional custom data, must be a JSON object. Example: {"id": 12345} }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

SepaEurApplicationRequest { Defines a SEPA European application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : SepaEurBusiness { The details of a European business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in EUR.

entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description:

This is the business entity type

website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of SepaEurDirector { Defines a SEPA European business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : EuropeanBankAccount { Defines a European bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 swift_code* : string maxLength: 11 description:

Must be either 8 or 11 characters in length. Characters 1-4 are letters (A-Z). Characters 5-6 are a valid ISO 3166-1 Alpha-2 country code (https://en.wikipedia.org/wiki/ISO3166-1alpha-2). To verify a SWIFT/BIC code and for example SWIFT/BIC codes, see https://formvalidation.io/guide/validators/bic/

iban* : string maxLength: 34 description:

Must be valid IBAN. To verify an IBAN and get example IBANS, see https://formvalidation.io/guide/validators/iban

bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description:

First name of the primary contact for the bank account.

last_name : string maxLength: 64 description:

Last name of the primary contact for the bank account.

email : string maxLength: 500 description:

Email of the primary contact for the bank account.

phone_number : string maxLength: 15 description:

Phone number of the primary contact for the bank account.

} } documents : array of SepaEurFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members mandate description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Mandate"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/sepa-eur/applications/{applicationId}

Description

Updates a European SEPA application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update	integer
true	body	document	Application details	SepaEurApplicationRequest

Parameter Schema Definitions
SepaEurApplicationRequest { Defines a SEPA European application id : integer description: This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly] merchant_id : integer description: This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly] pricing_id* : string maxLength: 32 description: This is the reference number for the pricing package associated with an application status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description: Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD version* : string description: Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016 timestamp* : string format: date-time description: Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly] } email* : string maxLength: 500 } business* : SepaEurBusiness { The details of a European business company_name* : string maxLength: 64 annual_sales* : number format: float32 description: This is the annual sales volume in EUR. entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description: This is the business entity type website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description: This is the business start date in ISO 8601 format with a timezone registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description: This is the "doing business as" name batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } directors* : array of SepaEurDirector { Defines a SEPA European business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description: Defines the birthday in ISO 8601 format with a timezone start_date* : string format: date-time description: Defines the ownership start date in ISO 8601 format with a timezone percentage : number format: float32 maximum: 100 minimum: 0 description: Defines the percentage, from 0.00 to 100.00, of the company ownership. address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } } bank_account* : EuropeanBankAccount { Defines a European bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 swift_code* : string maxLength: 11 description: Must be either 8 or 11 characters in length. Characters 1-4 are letters (A-Z). Characters 5-6 are a valid ISO 3166-1 Alpha-2 country code (https://en.wikipedia.org/wiki/ISO3166-1alpha-2). To verify a SWIFT/BIC code and for example SWIFT/BIC codes, see https://formvalidation.io/guide/validators/bic/ iban* : string maxLength: 34 description: Must be valid IBAN. To verify an IBAN and get example IBANS, see https://formvalidation.io/guide/validators/iban bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description: First name of the primary contact for the bank account. last_name : string maxLength: 64 description: Last name of the primary contact for the bank account. email : string maxLength: 500 description: Email of the primary contact for the bank account. phone_number : string maxLength: 15 description: Phone number of the primary contact for the bank account. } } documents : array of SepaEurFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members mandate description: Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Mandate" type* : string Enum (6) jpg jpeg doc docx pdf png description: File type of the document; accepted file formats. notes : string description: Description of the document and the contents that it must contain. base64* : string description: The document data, submitted as a base64 encoded string.. uri : string description: The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly] } } custom_data : object description: Optional custom data, must be a JSON object. Example: {"id": 12345} }

Parameter Schema Definitions

SepaEurApplicationRequest { Defines a SEPA European application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : SepaEurBusiness { The details of a European business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in EUR.

entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description:

This is the business entity type

website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of SepaEurDirector { Defines a SEPA European business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : EuropeanBankAccount { Defines a European bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 swift_code* : string maxLength: 11 description:

Must be either 8 or 11 characters in length. Characters 1-4 are letters (A-Z). Characters 5-6 are a valid ISO 3166-1 Alpha-2 country code (https://en.wikipedia.org/wiki/ISO3166-1alpha-2). To verify a SWIFT/BIC code and for example SWIFT/BIC codes, see https://formvalidation.io/guide/validators/bic/

iban* : string maxLength: 34 description:

Must be valid IBAN. To verify an IBAN and get example IBANS, see https://formvalidation.io/guide/validators/iban

bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description:

First name of the primary contact for the bank account.

last_name : string maxLength: 64 description:

Last name of the primary contact for the bank account.

email : string maxLength: 500 description:

Email of the primary contact for the bank account.

phone_number : string maxLength: 15 description:

Phone number of the primary contact for the bank account.

} } documents : array of SepaEurFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members mandate description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Mandate"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
200	Application Updated.	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions
Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/sepa-eur/applications/{applicationId}

Description

Retrieves a European SEPA application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to retrieve	string

Responses

Code	Description	Schema
200	Application retrieved	SepaEurApplicationResponse
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions
SepaEurApplicationResponse { Defines a SEPA European application id : integer description: This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly] merchant_id : integer description: This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly] pricing_id* : string maxLength: 32 description: This is the reference number for the pricing package associated with an application status : StatusResponse { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] submitted_on : string format: date-time description: Defines the date when the application was put into review in ISO 8601 format with a timezone [ReadOnly] approved_on : string format: date-time description: Defines the date when the application was approved in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description: Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD version* : string description: Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016 timestamp* : string format: date-time description: Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly] } email* : string maxLength: 500 } business* : SepaEurBusiness { The details of a European business company_name* : string maxLength: 64 annual_sales* : number format: float32 description: This is the annual sales volume in EUR. entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description: This is the business entity type website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description: This is the business start date in ISO 8601 format with a timezone registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description: This is the "doing business as" name batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } directors* : array of SepaEurDirector { Defines a SEPA European business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description: Defines the birthday in ISO 8601 format with a timezone start_date* : string format: date-time description: Defines the ownership start date in ISO 8601 format with a timezone percentage : number format: float32 maximum: 100 minimum: 0 description: Defines the percentage, from 0.00 to 100.00, of the company ownership. address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } } bank_account* : EuropeanBankAccount { Defines a European bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 swift_code* : string maxLength: 11 description: Must be either 8 or 11 characters in length. Characters 1-4 are letters (A-Z). Characters 5-6 are a valid ISO 3166-1 Alpha-2 country code (https://en.wikipedia.org/wiki/ISO3166-1alpha-2). To verify a SWIFT/BIC code and for example SWIFT/BIC codes, see https://formvalidation.io/guide/validators/bic/ iban* : string maxLength: 34 description: Must be valid IBAN. To verify an IBAN and get example IBANS, see https://formvalidation.io/guide/validators/iban bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description: First name of the primary contact for the bank account. last_name : string maxLength: 64 description: Last name of the primary contact for the bank account. email : string maxLength: 500 description: Email of the primary contact for the bank account. phone_number : string maxLength: 15 description: Phone number of the primary contact for the bank account. } } documents : array of SepaEurFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members mandate description: Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Mandate" type* : string Enum (6) jpg jpeg doc docx pdf png description: File type of the document; accepted file formats. notes : string description: Description of the document and the contents that it must contain. base64* : string description: The document data, submitted as a base64 encoded string.. uri : string description: The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly] } } custom_data : object description: Optional custom data, must be a JSON object. Example: {"id": 12345} }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

SepaEurApplicationResponse { Defines a SEPA European application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : StatusResponse { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

submitted_on : string format: date-time description:

Defines the date when the application was put into review in ISO 8601 format with a timezone [ReadOnly]

approved_on : string format: date-time description:

Defines the date when the application was approved in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : SepaEurBusiness { The details of a European business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in EUR.

entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description:

This is the business entity type

website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of SepaEurDirector { Defines a SEPA European business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : EuropeanBankAccount { Defines a European bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 swift_code* : string maxLength: 11 description:

Must be either 8 or 11 characters in length. Characters 1-4 are letters (A-Z). Characters 5-6 are a valid ISO 3166-1 Alpha-2 country code (https://en.wikipedia.org/wiki/ISO3166-1alpha-2). To verify a SWIFT/BIC code and for example SWIFT/BIC codes, see https://formvalidation.io/guide/validators/bic/

iban* : string maxLength: 34 description:

Must be valid IBAN. To verify an IBAN and get example IBANS, see https://formvalidation.io/guide/validators/iban

bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description:

First name of the primary contact for the bank account.

last_name : string maxLength: 64 description:

Last name of the primary contact for the bank account.

email : string maxLength: 500 description:

Email of the primary contact for the bank account.

phone_number : string maxLength: 15 description:

Phone number of the primary contact for the bank account.

} } documents : array of SepaEurFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members mandate description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Mandate"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

POST

/workflows/sepa-eur/applications/{applicationId}/documents

Description

Creates a European SEPA application document for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to create a document in.	integer
true	body	document	Document details	SepaEurFile

Parameter Schema Definitions
SepaEurFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members mandate description: Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Mandate" type* : string Enum (6) jpg jpeg doc docx pdf png description: File type of the document; accepted file formats. notes : string description: Description of the document and the contents that it must contain. base64* : string description: The document data, submitted as a base64 encoded string.. uri : string description: The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly] }

Parameter Schema Definitions

SepaEurFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members mandate description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Mandate"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

}

Responses

Code	Description	Schema
200	Document created	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions
Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

DELETE

/workflows/sepa-eur/applications/{applicationId}/documents/{documentId}

Description

Deletes a European SEPA application document for the referenced applicationId and documentId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to delete the document from	integer
true	path	documentId	The name of the document to delete	string

Responses

Code	Description	Schema
204	Documents Updated	Status
400	Invalid request	Array of Error
404	Application or Document not found	Error
500	Unexpected error	Error

Response Schema Definitions
Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/sepa-eur/applications/{applicationId}/status

Description

NOTE: This is for internal use only. If you are integrating to the onboarding API you will not have access to set the status. Our system will do that. Updates a European SEPA application status for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update status for	integer
true	body	status	The status details	Status

Parameter Schema Definitions
Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } }

Parameter Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Responses

Code	Description	Schema
200	Status Updated	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions
Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

Terms and Conditions (SEPA EUR)

GET

/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.	string

Responses

Code	Description	Schema
200	Document version info	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

GET

/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.	string
true	path	version	The version of the document.	string

Responses

Code	Description	Schema
200	Document retrieved with identifing properties in HTTP header	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Funds Transfer (BACS GBP)

POST

/workflows/bacs-gbp/applications

Description

Creates a new United Kingdom BACS application. The status of the application will be returned in the status object. A Location header that points to the URL of the new resource will be available in the response. The Location header has an application ID that should be used for all future requests to that application.

Parameters

Required	In	Name	Description	Schema
true	body	application	Application details	BacsGbpApplicationRequest

Parameter Schema Definitions
BacsGbpApplicationRequest { Defines a BACS United Kingdom application id : integer description: This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly] merchant_id : integer description: This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly] pricing_id* : string maxLength: 32 description: This is the reference number for the pricing package associated with an application status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description: Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD version* : string description: Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016 timestamp* : string format: date-time description: Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly] } email* : string maxLength: 500 } business* : BacsGbpBusiness { The details of a BACS United Kingdom business company_name* : string maxLength: 64 annual_sales* : number format: float32 description: This is the annual sales volume in GBP. entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description: This is the business entity type website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description: This is the business start date in ISO 8601 format with a timezone registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description: This is the "doing business as" name batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } directors* : array of BacsGbpDirector { Defines a BACS United Kingdom business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description: Defines the birthday in ISO 8601 format with a timezone start_date* : string format: date-time description: Defines the the ownership start date in ISO 8601 format with a timezone percentage : number format: float32 maximum: 100 minimum: 0 description: Defines the percentage, from 0.00 to 100.00, of the company ownership. address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } } bank_account* : UnitedKingdomBankAccount { Defines a United Kingdom bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 address : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } sort_code* : string pattern: ^\d{2}-?\d{2}-?\d{2}$ account_number* : string pattern: ^\d{8}$ bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description: First name of the primary contact for the bank account. last_name : string maxLength: 64 description: Last name of the primary contact for the bank account. email : string maxLength: 500 description: Email of the primary contact for the bank account. phone_number : string maxLength: 15 description: Phone number of the primary contact for the bank account. } } documents : array of BacsGbpFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members direct_debit description: Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Direct Debit Instructions" type* : string Enum (6) jpg jpeg doc docx pdf png description: File type of the document; accepted file formats. notes : string description: Description of the document and the contents that it must contain. base64* : string description: The document data, submitted as a base64 encoded string.. uri : string description: The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly] } } custom_data : object description: Optional custom data, must be a JSON object. Example: {"id": 12345} }

Parameter Schema Definitions

BacsGbpApplicationRequest { Defines a BACS United Kingdom application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : BacsGbpBusiness { The details of a BACS United Kingdom business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in GBP.

entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description:

This is the business entity type

website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of BacsGbpDirector { Defines a BACS United Kingdom business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : UnitedKingdomBankAccount { Defines a United Kingdom bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 address : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} sort_code* : string pattern: ^\d{2}-?\d{2}-?\d{2}$ account_number* : string pattern: ^\d{8}$ bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description:

First name of the primary contact for the bank account.

last_name : string maxLength: 64 description:

Last name of the primary contact for the bank account.

email : string maxLength: 500 description:

Email of the primary contact for the bank account.

phone_number : string maxLength: 15 description:

Phone number of the primary contact for the bank account.

} } documents : array of BacsGbpFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members direct_debit description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Direct Debit Instructions"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
201	Application created	Status
400	Invalid request	Array of Error
500	Unexpected error	Error

Response Schema Definitions
Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/bacs-gbp/applications

Description

Retrieves all United Kingdom BACS applications referenced by the given criteria in the url. A search criteria can be a combination of the following: - state={state} - Accepted values are "in_progress", "in_review", "on_hold", "approved" "rejected", "live" and "temp_disabled" - createdbefore={date} - createdafter={date} - updatedbefore={date} - updatedafter={date}

Documents file data will be excluded to limit the amount of data on the wire.

Parameters

No parameters

Responses

Code	Description	Schema
200	Application(s) retrieved	Array of BacsGbpApplicationRequest
400	Invalid request	Array of Error
404	Applications not found	Error
500	Unexpected error	Error

Response Schema Definitions
BacsGbpApplicationRequest { Defines a BACS United Kingdom application id : integer description: This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly] merchant_id : integer description: This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly] pricing_id* : string maxLength: 32 description: This is the reference number for the pricing package associated with an application status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description: Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD version* : string description: Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016 timestamp* : string format: date-time description: Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly] } email* : string maxLength: 500 } business* : BacsGbpBusiness { The details of a BACS United Kingdom business company_name* : string maxLength: 64 annual_sales* : number format: float32 description: This is the annual sales volume in GBP. entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description: This is the business entity type website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description: This is the business start date in ISO 8601 format with a timezone registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description: This is the "doing business as" name batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } directors* : array of BacsGbpDirector { Defines a BACS United Kingdom business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description: Defines the birthday in ISO 8601 format with a timezone start_date* : string format: date-time description: Defines the the ownership start date in ISO 8601 format with a timezone percentage : number format: float32 maximum: 100 minimum: 0 description: Defines the percentage, from 0.00 to 100.00, of the company ownership. address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } } bank_account* : UnitedKingdomBankAccount { Defines a United Kingdom bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 address : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } sort_code* : string pattern: ^\d{2}-?\d{2}-?\d{2}$ account_number* : string pattern: ^\d{8}$ bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description: First name of the primary contact for the bank account. last_name : string maxLength: 64 description: Last name of the primary contact for the bank account. email : string maxLength: 500 description: Email of the primary contact for the bank account. phone_number : string maxLength: 15 description: Phone number of the primary contact for the bank account. } } documents : array of BacsGbpFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members direct_debit description: Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Direct Debit Instructions" type* : string Enum (6) jpg jpeg doc docx pdf png description: File type of the document; accepted file formats. notes : string description: Description of the document and the contents that it must contain. base64* : string description: The document data, submitted as a base64 encoded string.. uri : string description: The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly] } } custom_data : object description: Optional custom data, must be a JSON object. Example: {"id": 12345} }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

BacsGbpApplicationRequest { Defines a BACS United Kingdom application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : BacsGbpBusiness { The details of a BACS United Kingdom business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in GBP.

entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description:

This is the business entity type

website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of BacsGbpDirector { Defines a BACS United Kingdom business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : UnitedKingdomBankAccount { Defines a United Kingdom bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 address : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} sort_code* : string pattern: ^\d{2}-?\d{2}-?\d{2}$ account_number* : string pattern: ^\d{8}$ bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description:

First name of the primary contact for the bank account.

last_name : string maxLength: 64 description:

Last name of the primary contact for the bank account.

email : string maxLength: 500 description:

Email of the primary contact for the bank account.

phone_number : string maxLength: 15 description:

Phone number of the primary contact for the bank account.

} } documents : array of BacsGbpFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members direct_debit description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Direct Debit Instructions"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/bacs-gbp/applications/{applicationId}

Description

Updates a United Kingdom BACS application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update	integer
true	body	application	Applicaiton details	BacsGbpApplicationRequest

Parameter Schema Definitions
BacsGbpApplicationRequest { Defines a BACS United Kingdom application id : integer description: This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly] merchant_id : integer description: This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly] pricing_id* : string maxLength: 32 description: This is the reference number for the pricing package associated with an application status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description: Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD version* : string description: Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016 timestamp* : string format: date-time description: Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly] } email* : string maxLength: 500 } business* : BacsGbpBusiness { The details of a BACS United Kingdom business company_name* : string maxLength: 64 annual_sales* : number format: float32 description: This is the annual sales volume in GBP. entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description: This is the business entity type website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description: This is the business start date in ISO 8601 format with a timezone registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description: This is the "doing business as" name batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } directors* : array of BacsGbpDirector { Defines a BACS United Kingdom business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description: Defines the birthday in ISO 8601 format with a timezone start_date* : string format: date-time description: Defines the the ownership start date in ISO 8601 format with a timezone percentage : number format: float32 maximum: 100 minimum: 0 description: Defines the percentage, from 0.00 to 100.00, of the company ownership. address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } } bank_account* : UnitedKingdomBankAccount { Defines a United Kingdom bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 address : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } sort_code* : string pattern: ^\d{2}-?\d{2}-?\d{2}$ account_number* : string pattern: ^\d{8}$ bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description: First name of the primary contact for the bank account. last_name : string maxLength: 64 description: Last name of the primary contact for the bank account. email : string maxLength: 500 description: Email of the primary contact for the bank account. phone_number : string maxLength: 15 description: Phone number of the primary contact for the bank account. } } documents : array of BacsGbpFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members direct_debit description: Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Direct Debit Instructions" type* : string Enum (6) jpg jpeg doc docx pdf png description: File type of the document; accepted file formats. notes : string description: Description of the document and the contents that it must contain. base64* : string description: The document data, submitted as a base64 encoded string.. uri : string description: The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly] } } custom_data : object description: Optional custom data, must be a JSON object. Example: {"id": 12345} }

Parameter Schema Definitions

BacsGbpApplicationRequest { Defines a BACS United Kingdom application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : BacsGbpBusiness { The details of a BACS United Kingdom business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in GBP.

entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description:

This is the business entity type

website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of BacsGbpDirector { Defines a BACS United Kingdom business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : UnitedKingdomBankAccount { Defines a United Kingdom bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 address : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} sort_code* : string pattern: ^\d{2}-?\d{2}-?\d{2}$ account_number* : string pattern: ^\d{8}$ bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description:

First name of the primary contact for the bank account.

last_name : string maxLength: 64 description:

Last name of the primary contact for the bank account.

email : string maxLength: 500 description:

Email of the primary contact for the bank account.

phone_number : string maxLength: 15 description:

Phone number of the primary contact for the bank account.

} } documents : array of BacsGbpFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members direct_debit description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Direct Debit Instructions"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
200	Application updated	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions
Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/bacs-gbp/applications/{applicationId}

Description

Retrieves a United Kingdom BACS application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to retrieve	string

Responses

Code	Description	Schema
200	Application retrieved	BacsGbpApplicationResponse
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions
BacsGbpApplicationResponse { Defines a BACS United Kingdom application id : integer description: This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly] merchant_id : integer description: This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly] pricing_id* : string maxLength: 32 description: This is the reference number for the pricing package associated with an application status : StatusResponse { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] submitted_on : string format: date-time description: Defines the date when the application was put into review in ISO 8601 format with a timezone [ReadOnly] approved_on : string format: date-time description: Defines the date when the application was approved in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description: Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD version* : string description: Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016 timestamp* : string format: date-time description: Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly] } email* : string maxLength: 500 } business* : BacsGbpBusiness { The details of a BACS United Kingdom business company_name* : string maxLength: 64 annual_sales* : number format: float32 description: This is the annual sales volume in GBP. entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description: This is the business entity type website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description: This is the business start date in ISO 8601 format with a timezone registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description: This is the "doing business as" name batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } directors* : array of BacsGbpDirector { Defines a BACS United Kingdom business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description: Defines the birthday in ISO 8601 format with a timezone start_date* : string format: date-time description: Defines the the ownership start date in ISO 8601 format with a timezone percentage : number format: float32 maximum: 100 minimum: 0 description: Defines the percentage, from 0.00 to 100.00, of the company ownership. address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } } bank_account* : UnitedKingdomBankAccount { Defines a United Kingdom bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 address : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description: State/Province/Municipality/Region country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description: Valid ISO 3166-1 country code for US, CA, GB, or a European country postal_code : string maxLength: 7 description: Postal/Zip code } sort_code* : string pattern: ^\d{2}-?\d{2}-?\d{2}$ account_number* : string pattern: ^\d{8}$ bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description: First name of the primary contact for the bank account. last_name : string maxLength: 64 description: Last name of the primary contact for the bank account. email : string maxLength: 500 description: Email of the primary contact for the bank account. phone_number : string maxLength: 15 description: Phone number of the primary contact for the bank account. } } documents : array of BacsGbpFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members direct_debit description: Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Direct Debit Instructions" type* : string Enum (6) jpg jpeg doc docx pdf png description: File type of the document; accepted file formats. notes : string description: Description of the document and the contents that it must contain. base64* : string description: The document data, submitted as a base64 encoded string.. uri : string description: The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly] } } custom_data : object description: Optional custom data, must be a JSON object. Example: {"id": 12345} }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

BacsGbpApplicationResponse { Defines a BACS United Kingdom application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : StatusResponse { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

submitted_on : string format: date-time description:

Defines the date when the application was put into review in ISO 8601 format with a timezone [ReadOnly]

approved_on : string format: date-time description:

Defines the date when the application was approved in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : BacsGbpBusiness { The details of a BACS United Kingdom business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in GBP.

entity_type* : string Enum (9) public_limited private_limited limited_liability_partnership combination_partnership partnership sole_trader community_interest charitable_incorporated other description:

This is the business entity type

website_url : string format: uri maxLength: 128 legal_name* : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

registration_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of BacsGbpDirector { Defines a BACS United Kingdom business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : UnitedKingdomBankAccount { Defines a United Kingdom bank account owner_name* : string maxLength: 64 bank_name* : string maxLength: 32 address : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} sort_code* : string pattern: ^\d{2}-?\d{2}-?\d{2}$ account_number* : string pattern: ^\d{8}$ bank_account_contact : BankAccountContact { Defines the primary contact for the bank account first_name : string maxLength: 64 description:

First name of the primary contact for the bank account.

last_name : string maxLength: 64 description:

Last name of the primary contact for the bank account.

email : string maxLength: 500 description:

Email of the primary contact for the bank account.

phone_number : string maxLength: 15 description:

Phone number of the primary contact for the bank account.

} } documents : array of BacsGbpFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members direct_debit description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Direct Debit Instructions"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

POST

/workflows/bacs-gbp/applications/{applicationId}/documents

Description

Creates a United Kingdom BACS application document for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to create a document in.	integer
true	body	document	Document details	BacsGbpFile

Parameter Schema Definitions
BacsGbpFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members direct_debit description: Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Direct Debit Instructions" type* : string Enum (6) jpg jpeg doc docx pdf png description: File type of the document; accepted file formats. notes : string description: Description of the document and the contents that it must contain. base64* : string description: The document data, submitted as a base64 encoded string.. uri : string description: The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly] }

Parameter Schema Definitions

BacsGbpFile { Defines a document that is required for application approval. name* : string Enum (7) copy_id void_cheque bank_statement certificate registration board_members direct_debit description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)", "List of Board Members (public and NFP companies)" and "Direct Debit Instructions"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

}

Responses

Code	Description	Schema
200	Document created	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions
Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description: The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved" created_on : string format: date-time description: Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly] updated_on : string format: date-time description: Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly] pending_issues : array of Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error } }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

DELETE

/workflows/bacs-gbp/applications/{applicationId}/documents/{documentId}

Description

Deletes a United Kingdom BACS application document for the referenced applicationId and documentId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to delete the document from	integer
true	path	documentId	The name of the document to delete	string

Responses

Code	Description	Schema
204	Documents Updated	Status
400	Invalid request	Array of Error
404	Application or Document not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/bacs-gbp/applications/{applicationId}/status

Description

Updates a United Kingdom BACS application status for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update status for	integer
true	body	status	The status details	Status

Parameter Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Responses

Code	Description	Schema
200	Status Updated	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

Terms and Conditions (BACS GBP)

GET

/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.	string

Responses

Code	Description	Schema
200	Document version info	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

GET

/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.	string
true	path	version	The version of the document.	string

Responses

Code	Description	Schema
200	Document retrieved with identifing properties in HTTP header	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Funds Transfer (ACH USD)

POST

/workflows/ach-usd/applications

Description

Creates a new United States ACH application. The status of the application will be returned in the status object. A Location header that points to the URL of the new resource will be available in the response. The Location header has an application ID that should be used for all future requests to that application.

Parameters

Required	In	Name	Description	Schema
true	body	application	Application details	AchUsdApplicationRequest

Parameter Schema Definitions

AchUsdApplicationRequest { Defines an ACH American application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : AchUsdBusiness { The details of an ACH American business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in USD.

entity_type* : string Enum (8) sole_proprietor partnership limited_partnership joint_venture corporation non_profit publicly_traded charitable_organization description:

This is the business entity type

website_url : string format: uri maxLength: 128 registration_location : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of AchUsdDirector { Defines an ACH American business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : AmericanBankAccount { Defines an American bank account owner_name* : string maxLength: 64 routing_number* : string pattern: ^\d{9}$ account_number* : string pattern: ^\d{1,17}$ } documents : array of AchUsdFile { Defines a document that is required for application approval. name* : string Enum (6) copy_id void_cheque bank_statement certificate registration board_members description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)" and "List of Board Members (public and NFP companies)"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
201	Application created	Status
400	Invalid request	Array of Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/ach-usd/applications

Description

Retrieves all United States ACH applications referenced by the given criteria in the url. A search criteria can be a combination of the following: - state={state} - Accepted values are "in_progress", "in_review", "on_hold", "approved" "rejected", "live" and "temp_disabled" - createdbefore={date} - createdafter={date} - updatedbefore={date} - updatedafter={date}

Documents file data will be excluded to limit the amount of data on the wire.

Parameters

No parameters

Responses

Code	Description	Schema
200	Application(s) retrieved	Array of AchUsdApplicationRequest
400	Invalid request	Array of Error
404	Applications not found	Error
500	Unexpected error	Error

Response Schema Definitions

AchUsdApplicationRequest { Defines an ACH American application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : AchUsdBusiness { The details of an ACH American business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in USD.

entity_type* : string Enum (8) sole_proprietor partnership limited_partnership joint_venture corporation non_profit publicly_traded charitable_organization description:

This is the business entity type

website_url : string format: uri maxLength: 128 registration_location : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of AchUsdDirector { Defines an ACH American business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : AmericanBankAccount { Defines an American bank account owner_name* : string maxLength: 64 routing_number* : string pattern: ^\d{9}$ account_number* : string pattern: ^\d{1,17}$ } documents : array of AchUsdFile { Defines a document that is required for application approval. name* : string Enum (6) copy_id void_cheque bank_statement certificate registration board_members description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)" and "List of Board Members (public and NFP companies)"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/ach-usd/applications/{applicationId}

Description

Updates a United States ACH application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update	integer
true	body	application	Applicaiton details	AchUsdApplicationRequest

Parameter Schema Definitions

AchUsdApplicationRequest { Defines an ACH American application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : AchUsdBusiness { The details of an ACH American business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in USD.

entity_type* : string Enum (8) sole_proprietor partnership limited_partnership joint_venture corporation non_profit publicly_traded charitable_organization description:

This is the business entity type

website_url : string format: uri maxLength: 128 registration_location : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of AchUsdDirector { Defines an ACH American business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : AmericanBankAccount { Defines an American bank account owner_name* : string maxLength: 64 routing_number* : string pattern: ^\d{9}$ account_number* : string pattern: ^\d{1,17}$ } documents : array of AchUsdFile { Defines a document that is required for application approval. name* : string Enum (6) copy_id void_cheque bank_statement certificate registration board_members description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)" and "List of Board Members (public and NFP companies)"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
200	Application updated	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/ach-usd/applications/{applicationId}

Description

Retrieves a United States ACH application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to retrieve	string

Responses

Code	Description	Schema
200	Application retrieved	AchUsdApplicationResponse
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

AchUsdApplicationResponse { Defines an ACH American application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : StatusResponse { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

submitted_on : string format: date-time description:

Defines the date when the application was put into review in ISO 8601 format with a timezone [ReadOnly]

approved_on : string format: date-time description:

Defines the date when the application was approved in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : AchUsdBusiness { The details of an ACH American business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in USD.

entity_type* : string Enum (8) sole_proprietor partnership limited_partnership joint_venture corporation non_profit publicly_traded charitable_organization description:

This is the business entity type

website_url : string format: uri maxLength: 128 registration_location : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of AchUsdDirector { Defines an ACH American business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : AmericanBankAccount { Defines an American bank account owner_name* : string maxLength: 64 routing_number* : string pattern: ^\d{9}$ account_number* : string pattern: ^\d{1,17}$ } documents : array of AchUsdFile { Defines a document that is required for application approval. name* : string Enum (6) copy_id void_cheque bank_statement certificate registration board_members description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)" and "List of Board Members (public and NFP companies)"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

POST

/workflows/ach-usd/applications/{applicationId}/documents

Description

Creates a United States ACH application document for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to create a document in.	integer
true	body	document	Document details	AchUsdFile

Parameter Schema Definitions

AchUsdFile { Defines a document that is required for application approval. name* : string Enum (6) copy_id void_cheque bank_statement certificate registration board_members description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)" and "List of Board Members (public and NFP companies)"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

}

Responses

Code	Description	Schema
200	Document created	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

DELETE

/workflows/ach-usd/applications/{applicationId}/documents/{documentId}

Description

Deletes a United States ACH application document for the referenced applicationId and documentId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to delete the document from	integer
true	path	documentId	The name of the document to delete	string

Responses

Code	Description	Schema
204	Document deleted	Status
400	Invalid request	Array of Error
404	Application or Document not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/ach-usd/applications/{applicationId}/status

Description

Updates a United States ACH application status for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update status for	integer
true	body	status	The status details	Status

Parameter Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Responses

Code	Description	Schema
200	Status Updated	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

Terms and Conditions (ACH USD)

GET

/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.	string

Responses

Code	Description	Schema
200	Document version info	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

GET

/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.	string
true	path	version	The version of the document.	string

Responses

Code	Description	Schema
200	Document retrieved with identifing properties in HTTP header	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Funds Transfer (EFT CAD)

POST

/workflows/eft-cad/applications

Description

Creates a new Canada EFT application. The status of the application will be returned in the status object. A Location header that points to the URL of the new resource will be available in the response. The Location header has an application ID that should be used for all future requests to that application.

Parameters

Required	In	Name	Description	Schema
true	body	application	Applicaiton details	EftCadApplicationRequest

Parameter Schema Definitions

EftCadApplicationRequest { Defines an EFT Canadian application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : EftCadBusiness { The details of an EFT Canadian business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in CAD.

entity_type* : string Enum (8) sole_proprietor partnership limited_partnership joint_venture corporation non_profit publicly_traded charitable_organization description:

This is the business entity type

website_url : string format: uri maxLength: 128 registration_location : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of EftCadDirector { Defines an EFT Canadian business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } documents : array of EftCadFile { Defines a document that is required for application approval. name* : string Enum (6) copy_id void_cheque bank_statement certificate registration board_members description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)" and "List of Board Members (public and NFP companies)"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
201	Application created	Status
400	Invalid request	Array of Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/eft-cad/applications

Description

Retrieves all Canada EFT applications referenced by the given criteria in the url. A search criteria can be a combination of the following: - state={state} - Accepted values are "in_progress", "in_review", "on_hold", "approved" "rejected", "live" and "temp_disabled" - createdbefore={date} - createdafter={date} - updatedbefore={date} - updatedafter={date}

Documents file data will be excluded to limit the amount of data on the wire.

Parameters

No parameters

Responses

Code	Description	Schema
200	Application(s) retrieved	Array of EftCadApplicationRequest
400	Invalid request	Array of Error
404	Applications not found	Error
500	Unexpected error	Error

Response Schema Definitions

EftCadApplicationRequest { Defines an EFT Canadian application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : EftCadBusiness { The details of an EFT Canadian business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in CAD.

entity_type* : string Enum (8) sole_proprietor partnership limited_partnership joint_venture corporation non_profit publicly_traded charitable_organization description:

This is the business entity type

website_url : string format: uri maxLength: 128 registration_location : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of EftCadDirector { Defines an EFT Canadian business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } documents : array of EftCadFile { Defines a document that is required for application approval. name* : string Enum (6) copy_id void_cheque bank_statement certificate registration board_members description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)" and "List of Board Members (public and NFP companies)"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/eft-cad/applications/{applicationId}

Description

Updates a Canada EFT application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update	integer
true	body	application	Applicaiton details	EftCadApplicationRequest

Parameter Schema Definitions

EftCadApplicationRequest { Defines an EFT Canadian application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : EftCadBusiness { The details of an EFT Canadian business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in CAD.

entity_type* : string Enum (8) sole_proprietor partnership limited_partnership joint_venture corporation non_profit publicly_traded charitable_organization description:

This is the business entity type

website_url : string format: uri maxLength: 128 registration_location : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of EftCadDirector { Defines an EFT Canadian business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } documents : array of EftCadFile { Defines a document that is required for application approval. name* : string Enum (6) copy_id void_cheque bank_statement certificate registration board_members description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)" and "List of Board Members (public and NFP companies)"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
200	Application updated	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/eft-cad/applications/{applicationId}

Description

Retrieves a Canada EFT application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to retrieve	string

Responses

Code	Description	Schema
200	Application retrieved	EftCadApplicationResponse
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

EftCadApplicationResponse { Defines an EFT Canadian application id : integer description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : StatusResponse { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

submitted_on : string format: date-time description:

Defines the date when the application was put into review in ISO 8601 format with a timezone [ReadOnly]

approved_on : string format: date-time description:

Defines the date when the application was approved in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : EftApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 } business* : EftCadBusiness { The details of an EFT Canadian business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual sales volume in CAD.

entity_type* : string Enum (8) sole_proprietor partnership limited_partnership joint_venture corporation non_profit publicly_traded charitable_organization description:

This is the business entity type

website_url : string format: uri maxLength: 128 registration_location : string maxLength: 64 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 dba_name* : string maxLength: 32 description:

This is the "doing business as" name

batch_settings* : BatchSettings { The details of a batch requirements frequency* : string Enum (7) daily weekly bi_weekly monthly bi_monthly semi_annually annually average_amount* : number format: float32 maximum_amount* : number format: float32 } address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} directors* : array of EftCadDirector { Defines an EFT Canadian business owner or director first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

start_date* : string format: date-time description:

Defines the ownership start date in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } documents : array of EftCadFile { Defines a document that is required for application approval. name* : string Enum (6) copy_id void_cheque bank_statement certificate registration board_members description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)" and "List of Board Members (public and NFP companies)"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

POST

/workflows/eft-cad/applications/{applicationId}/documents

Description

Creates a Canada EFT application document for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to create a document in.	integer
true	body	document	Document details	EftCadFile

Parameter Schema Definitions

EftCadFile { Defines a document that is required for application approval. name* : string Enum (6) copy_id void_cheque bank_statement certificate registration board_members description:

Name of the document. This will match to one of the list of possible files. This is a read-only attribute. The options are "Copy ID (Owner and/or Principal) - govt issued photo ID", "Void Check or Bank Statement", "Certificate of Incorporation (if applicable)", "Non-Profit Registration Documents (if applicable)" and "List of Board Members (public and NFP companies)"

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

}

Responses

Code	Description	Schema
200	Document created	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

DELETE

/workflows/eft-cad/applications/{applicationId}/documents/{documentId}

Description

Deletes a Canada EFT application document for the referenced applicationId and documentId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to delete the document from	integer
true	path	documentId	The name of the document to delete	string

Responses

Code	Description	Schema
204	Document deleted	Status
400	Invalid request	Array of Error
404	Application or Document not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/eft-cad/applications/{applicationId}/status

Description

Updates a Canada EFT application status for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update status for	integer
true	body	status	The status details	Status

Parameter Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Responses

Code	Description	Schema
200	Status Updated	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

Terms and Conditions (EFT CAD)

GET

/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.	string

Responses

Code	Description	Schema
200	Document version info	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

GET

/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.	string
true	path	version	The version of the document.	string

Responses

Code	Description	Schema
200	Document retrieved with identifing properties in HTTP header	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Credit Card Payments (PSP CAD)

POST

/workflows/psp-cad/applications

Description

Creates a new Canada PSP application. The status of the application will be returned in the status object. A Location header that points to the URL of the new resource will be available in the response. The Location header has an application ID that should be used for all future requests to that application.

Parameters

Required	In	Name	Description	Schema
true	body	application	Application details	PspCadApplicationRequest

Parameter Schema Definitions

PspCadApplicationRequest { Defines a PSP Canadian application id : integer format: int32 description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : PspCadApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 social_insurance_number : string maxLength: 9 description:

This is the social insurance number

date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

resided_over_years : boolean description:

This is used to determine if the applicant has resided at this address for at last 2 years

phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} email* : string maxLength: 500 custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

} business* : PspCadBusiness { The details of a Canadian business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual online processing volume in CAD/USD.

currency* : string Enum (2) CAD USD description:

This is the currency of the annual sales volume

merchant_category* : string Enum (49) 5813 5811 5812 8398 7997 8651 8661 8641 1711 1750 1731 1520 7623 1761 1740 7033 5462 5411 5499 5994 8021 8099 5963 5699 5971 5970 5992 5399 8931 7311 7542 7217 8351 7379 7372 7392 0780 8111 7349 7333 8999 6513 7251 0742 7230 7210 4121 4722 8299 description:

This is the merchant category code

has_existing_account : boolean description:

This determines if the business has an existing Beanstream account

services_description : string maxLength: 500 description:

This is the description of the goods and/or services the merchant sells

entity_type* : string Enum (6) sole_proprietor partnership limited_partnership joint_venture corporation non_profit description:

This is the business entity type

website_url : string format: uri maxLength: 128 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} owners* : array of PspCadOwner { Defines a Canadian business owner first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
201	Application created	Status
400	Invalid request	Array of Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/psp-cad/applications

Description

Retrieves all Canada PSP applications referenced by the given criteria in the url. A search criteria can be a combination of the following: - state={state} - Accepted values are "in_progress", "in_review", "on_hold", "approved" "rejected", "live" and "temp_disabled" - createdbefore={date} - createdafter={date} - updatedbefore={date} - updatedafter={date}

Documents file data will be excluded to limit the amount of data on the wire.

Parameters

No parameters

Responses

Code	Description	Schema
200	Application(s) retrieved	Array of PspCadApplicationRequest
400	Invalid request	Array of Error
404	Applications not found	Error
500	Unexpected error	Error

Response Schema Definitions

PspCadApplicationRequest { Defines a PSP Canadian application id : integer format: int32 description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : PspCadApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 social_insurance_number : string maxLength: 9 description:

This is the social insurance number

date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

resided_over_years : boolean description:

This is used to determine if the applicant has resided at this address for at last 2 years

phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} email* : string maxLength: 500 custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

} business* : PspCadBusiness { The details of a Canadian business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual online processing volume in CAD/USD.

currency* : string Enum (2) CAD USD description:

This is the currency of the annual sales volume

merchant_category* : string Enum (49) 5813 5811 5812 8398 7997 8651 8661 8641 1711 1750 1731 1520 7623 1761 1740 7033 5462 5411 5499 5994 8021 8099 5963 5699 5971 5970 5992 5399 8931 7311 7542 7217 8351 7379 7372 7392 0780 8111 7349 7333 8999 6513 7251 0742 7230 7210 4121 4722 8299 description:

This is the merchant category code

has_existing_account : boolean description:

This determines if the business has an existing Beanstream account

services_description : string maxLength: 500 description:

This is the description of the goods and/or services the merchant sells

entity_type* : string Enum (6) sole_proprietor partnership limited_partnership joint_venture corporation non_profit description:

This is the business entity type

website_url : string format: uri maxLength: 128 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} owners* : array of PspCadOwner { Defines a Canadian business owner first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/psp-cad/applications/{applicationId}

Description

Updates a Canada PSP application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update	integer
true	body	document	Application details	PspCadApplicationRequest

Parameter Schema Definitions

PspCadApplicationRequest { Defines a PSP Canadian application id : integer format: int32 description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : PspCadApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 social_insurance_number : string maxLength: 9 description:

This is the social insurance number

date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

resided_over_years : boolean description:

This is used to determine if the applicant has resided at this address for at last 2 years

phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} email* : string maxLength: 500 custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

} business* : PspCadBusiness { The details of a Canadian business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual online processing volume in CAD/USD.

currency* : string Enum (2) CAD USD description:

This is the currency of the annual sales volume

merchant_category* : string Enum (49) 5813 5811 5812 8398 7997 8651 8661 8641 1711 1750 1731 1520 7623 1761 1740 7033 5462 5411 5499 5994 8021 8099 5963 5699 5971 5970 5992 5399 8931 7311 7542 7217 8351 7379 7372 7392 0780 8111 7349 7333 8999 6513 7251 0742 7230 7210 4121 4722 8299 description:

This is the merchant category code

has_existing_account : boolean description:

This determines if the business has an existing Beanstream account

services_description : string maxLength: 500 description:

This is the description of the goods and/or services the merchant sells

entity_type* : string Enum (6) sole_proprietor partnership limited_partnership joint_venture corporation non_profit description:

This is the business entity type

website_url : string format: uri maxLength: 128 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} owners* : array of PspCadOwner { Defines a Canadian business owner first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
200	Application Updated.	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/psp-cad/applications/{applicationId}

Description

Retrieves a Canada PSP application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to retrieve	string

Responses

Code	Description	Schema
200	Application retrieved	PspCadApplicationResponse
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

PspCadApplicationResponse { Defines a PSP Canadian application id : integer format: int32 description:

This application identifier is used to identify an application. It is auto-generated by the API [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : StatusResponse { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

submitted_on : string format: date-time description:

Defines the date when the application was put into review in ISO 8601 format with a timezone [ReadOnly]

approved_on : string format: date-time description:

Defines the date when the application was approved in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : PspCadApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 social_insurance_number : string maxLength: 9 description:

This is the social insurance number

date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

resided_over_years : boolean description:

This is used to determine if the applicant has resided at this address for at last 2 years

phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} email* : string maxLength: 500 custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

} business* : PspCadBusiness { The details of a Canadian business company_name* : string maxLength: 64 annual_sales* : number format: float32 description:

This is the annual online processing volume in CAD/USD.

currency* : string Enum (2) CAD USD description:

This is the currency of the annual sales volume

merchant_category* : string Enum (49) 5813 5811 5812 8398 7997 8651 8661 8641 1711 1750 1731 1520 7623 1761 1740 7033 5462 5411 5499 5994 8021 8099 5963 5699 5971 5970 5992 5399 8931 7311 7542 7217 8351 7379 7372 7392 0780 8111 7349 7333 8999 6513 7251 0742 7230 7210 4121 4722 8299 description:

This is the merchant category code

has_existing_account : boolean description:

This determines if the business has an existing Beanstream account

services_description : string maxLength: 500 description:

This is the description of the goods and/or services the merchant sells

entity_type* : string Enum (6) sole_proprietor partnership limited_partnership joint_venture corporation non_profit description:

This is the business entity type

website_url : string format: uri maxLength: 128 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

business_number : string maxLength: 32 address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} owners* : array of PspCadOwner { Defines a Canadian business owner first_name* : string maxLength: 64 last_name* : string maxLength: 64 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/psp-cad/applications/{applicationId}/status

Description

Updates Canada PSP application status for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update status for	integer
true	body	status	The status details	Status

Parameter Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Responses

Code	Description	Schema
200	Status Updated	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

Terms and Conditions (PSP CAD)

GET

/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.	string

Responses

Code	Description	Schema
200	Document version info	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

GET

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

Description

Retrieves 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.	string
true	path	version	The version of the document.	string

Responses

Code	Description	Schema
200	Document retrieved with identifing properties in HTTP header	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Credit Card Payments (PSP USD)

POST

/workflows/psp-usd/applications

Description

Creates a new US PSP application. The status of the application will be returned in the status object. A Location header that points to the URL of the new resource will be available in the response. The Location header has an application ID that should be used for all future requests to that application.

Parameters

Required	In	Name	Description	Schema
true	body	application	Application details	PspUsdApplicationRequest

Parameter Schema Definitions

PspUsdApplicationRequest { Defines a PSP US application id : integer format: int32 description:

This application identifier is used to identify an application. [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : PspUsdApplicant { The individual completing the application first_name* : string maxLength: 20 last_name* : string maxLength: 20 social_security_number* : string pattern: ^\d{3}-?\d{2}-?\d{4}$ description:

This is the social security number

date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

citizenship* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

phone_number* : string pattern: ^\d{1,20}$ position* : string Enum (15) owner co_owner president legal_contact secretary_treasurer partner general_manager administrator vice_president director ceo corporate_officer principal cfo coo description:

The position of the applicant

agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} email* : string maxLength: 70 } business* : PspUsdBusiness { The details of a US business company_name* : string maxLength: 24 description:

This is the DBA (Doing Business As) name

legal_name* : string maxLength: 24 description:

This is the business legal name

irs_filing_name : string maxLength: 40 description:

If legal name is > 24 then it is truncated and the irs filing name is populated up to 40 chars

annual_sales* : number format: float32 description:

This is the annual online processing volume in USD.

merchant_category* : string Enum (26) 7997 8699 8641 7941 7922 7994 5192 5499 7995 8099 5969 5968 5977 5732 5992 5999 7399 4816 7372 7392 8999 7299 4722 8299 4899 4814 description:

This is the merchant category code

services_description* : string maxLength: 100 description:

This is the description of the goods and/or services the merchant sells

federal_tax_id* : string pattern: ^\d{9}$ tin_type* : string Enum (3) social_security employment_id other description:

This is the type of federal tax provided

entity_type* : string Enum (8) sole_proprietor partnership limited_liability_corp privately_held_corp publicly_traded_corp international_organization government non_profit description:

This is the business entity type

website_url : string format: uri maxLength: 70 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

average_amount* : number format: float32 description:

This is the average transaction amount in USD.

average_delivery* : string Enum (4) 07 14 30 31 description:

This is the average delivery time in days. 07: Days in Delivery 0 to 7, 14: Days in Delivery 8 to 14, 30: Days in Delivery 15 to 30, 31: Days in Delivery over 30

seasonal_sales : string Enum (2) 1 0 description:

This determines if the sales are seasonal

address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} owners : array of PspUsdOwner { Defines a US business owner first_name* : string maxLength: 20 last_name* : string maxLength: 20 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

social_security_number* : string maxLength: 9 phone_number : string pattern: ^\d{1,20}$ email : string maxLength: 70 citizenship* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} } bank_account* : AmericanBankAccount { Defines an American bank account owner_name* : string maxLength: 64 routing_number* : string pattern: ^\d{9}$ account_number* : string pattern: ^\d{1,17}$ } documents : array of PspUsdFile { Defines a document that is required for application approval. name* : string Enum (3) id_applicant bank_statement pci_saq_document description:

Name of the document.

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
201	Application created	Status
400	Invalid request	Array of Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/psp-usd/applications

Description

Retrieves all US PSP applications referenced by the given criteria in the url. A search criteria can be a combination of the following: - state={state} - Accepted values are "in_progress", "in_review", "on_hold", "approved" "rejected", "live" and "temp_disabled" - createdbefore={date} - createdafter={date} - updatedbefore={date} - updatedafter={date}

Documents file data will be excluded to limit the amount of data on the wire.

Parameters

No parameters

Responses

Code	Description	Schema
200	Application(s) retrieved	Array of PspUsdApplicationRequest
400	Invalid request	Array of Error
404	Applications not found	Error
500	Unexpected error	Error

Response Schema Definitions

PspUsdApplicationRequest { Defines a PSP US application id : integer format: int32 description:

This application identifier is used to identify an application. [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : PspUsdApplicant { The individual completing the application first_name* : string maxLength: 20 last_name* : string maxLength: 20 social_security_number* : string pattern: ^\d{3}-?\d{2}-?\d{4}$ description:

This is the social security number

date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

citizenship* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

phone_number* : string pattern: ^\d{1,20}$ position* : string Enum (15) owner co_owner president legal_contact secretary_treasurer partner general_manager administrator vice_president director ceo corporate_officer principal cfo coo description:

The position of the applicant

agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} email* : string maxLength: 70 } business* : PspUsdBusiness { The details of a US business company_name* : string maxLength: 24 description:

This is the DBA (Doing Business As) name

legal_name* : string maxLength: 24 description:

This is the business legal name

irs_filing_name : string maxLength: 40 description:

If legal name is > 24 then it is truncated and the irs filing name is populated up to 40 chars

annual_sales* : number format: float32 description:

This is the annual online processing volume in USD.

merchant_category* : string Enum (26) 7997 8699 8641 7941 7922 7994 5192 5499 7995 8099 5969 5968 5977 5732 5992 5999 7399 4816 7372 7392 8999 7299 4722 8299 4899 4814 description:

This is the merchant category code

services_description* : string maxLength: 100 description:

This is the description of the goods and/or services the merchant sells

federal_tax_id* : string pattern: ^\d{9}$ tin_type* : string Enum (3) social_security employment_id other description:

This is the type of federal tax provided

entity_type* : string Enum (8) sole_proprietor partnership limited_liability_corp privately_held_corp publicly_traded_corp international_organization government non_profit description:

This is the business entity type

website_url : string format: uri maxLength: 70 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

average_amount* : number format: float32 description:

This is the average transaction amount in USD.

average_delivery* : string Enum (4) 07 14 30 31 description:

This is the average delivery time in days. 07: Days in Delivery 0 to 7, 14: Days in Delivery 8 to 14, 30: Days in Delivery 15 to 30, 31: Days in Delivery over 30

seasonal_sales : string Enum (2) 1 0 description:

This determines if the sales are seasonal

address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} owners : array of PspUsdOwner { Defines a US business owner first_name* : string maxLength: 20 last_name* : string maxLength: 20 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

social_security_number* : string maxLength: 9 phone_number : string pattern: ^\d{1,20}$ email : string maxLength: 70 citizenship* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} } bank_account* : AmericanBankAccount { Defines an American bank account owner_name* : string maxLength: 64 routing_number* : string pattern: ^\d{9}$ account_number* : string pattern: ^\d{1,17}$ } documents : array of PspUsdFile { Defines a document that is required for application approval. name* : string Enum (3) id_applicant bank_statement pci_saq_document description:

Name of the document.

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/psp-usd/applications/{applicationId}

Description

Updates a US PSP application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update	integer
true	body	document	Application details	PspUsdApplicationRequest

Parameter Schema Definitions

PspUsdApplicationRequest { Defines a PSP US application id : integer format: int32 description:

This application identifier is used to identify an application. [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : PspUsdApplicant { The individual completing the application first_name* : string maxLength: 20 last_name* : string maxLength: 20 social_security_number* : string pattern: ^\d{3}-?\d{2}-?\d{4}$ description:

This is the social security number

date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

citizenship* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

phone_number* : string pattern: ^\d{1,20}$ position* : string Enum (15) owner co_owner president legal_contact secretary_treasurer partner general_manager administrator vice_president director ceo corporate_officer principal cfo coo description:

The position of the applicant

agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} email* : string maxLength: 70 } business* : PspUsdBusiness { The details of a US business company_name* : string maxLength: 24 description:

This is the DBA (Doing Business As) name

legal_name* : string maxLength: 24 description:

This is the business legal name

irs_filing_name : string maxLength: 40 description:

If legal name is > 24 then it is truncated and the irs filing name is populated up to 40 chars

annual_sales* : number format: float32 description:

This is the annual online processing volume in USD.

merchant_category* : string Enum (26) 7997 8699 8641 7941 7922 7994 5192 5499 7995 8099 5969 5968 5977 5732 5992 5999 7399 4816 7372 7392 8999 7299 4722 8299 4899 4814 description:

This is the merchant category code

services_description* : string maxLength: 100 description:

This is the description of the goods and/or services the merchant sells

federal_tax_id* : string pattern: ^\d{9}$ tin_type* : string Enum (3) social_security employment_id other description:

This is the type of federal tax provided

entity_type* : string Enum (8) sole_proprietor partnership limited_liability_corp privately_held_corp publicly_traded_corp international_organization government non_profit description:

This is the business entity type

website_url : string format: uri maxLength: 70 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

average_amount* : number format: float32 description:

This is the average transaction amount in USD.

average_delivery* : string Enum (4) 07 14 30 31 description:

This is the average delivery time in days. 07: Days in Delivery 0 to 7, 14: Days in Delivery 8 to 14, 30: Days in Delivery 15 to 30, 31: Days in Delivery over 30

seasonal_sales : string Enum (2) 1 0 description:

This determines if the sales are seasonal

address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} owners : array of PspUsdOwner { Defines a US business owner first_name* : string maxLength: 20 last_name* : string maxLength: 20 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

social_security_number* : string maxLength: 9 phone_number : string pattern: ^\d{1,20}$ email : string maxLength: 70 citizenship* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} } bank_account* : AmericanBankAccount { Defines an American bank account owner_name* : string maxLength: 64 routing_number* : string pattern: ^\d{9}$ account_number* : string pattern: ^\d{1,17}$ } documents : array of PspUsdFile { Defines a document that is required for application approval. name* : string Enum (3) id_applicant bank_statement pci_saq_document description:

Name of the document.

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
200	Application Updated.	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/psp-usd/applications/{applicationId}

Description

Retrieves a US PSP application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to retrieve	string

Responses

Code	Description	Schema
200	Application retrieved	PspUsdApplicationResponse
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

PspUsdApplicationResponse { Defines a PSP US application id : integer format: int32 description:

This application identifier is used to identify an application. [ReadOnly]

merchant_id : integer description:

This merchant identifier is populated when the application is approved and a merchant account has been associated. [ReadOnly]

pricing_id* : string maxLength: 32 description:

This is the reference number for the pricing package associated with an application

status : StatusResponse { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

submitted_on : string format: date-time description:

Defines the date when the application was put into review in ISO 8601 format with a timezone [ReadOnly]

approved_on : string format: date-time description:

Defines the date when the application was approved in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : PspUsdApplicant { The individual completing the application first_name* : string maxLength: 20 last_name* : string maxLength: 20 social_security_number* : string pattern: ^\d{3}-?\d{2}-?\d{4}$ description:

This is the social security number

date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

citizenship* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

phone_number* : string pattern: ^\d{1,20}$ position* : string Enum (15) owner co_owner president legal_contact secretary_treasurer partner general_manager administrator vice_president director ceo corporate_officer principal cfo coo description:

The position of the applicant

agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} email* : string maxLength: 70 } business* : PspUsdBusiness { The details of a US business company_name* : string maxLength: 24 description:

This is the DBA (Doing Business As) name

legal_name* : string maxLength: 24 description:

This is the business legal name

irs_filing_name : string maxLength: 40 description:

If legal name is > 24 then it is truncated and the irs filing name is populated up to 40 chars

annual_sales* : number format: float32 description:

This is the annual online processing volume in USD.

merchant_category* : string Enum (26) 7997 8699 8641 7941 7922 7994 5192 5499 7995 8099 5969 5968 5977 5732 5992 5999 7399 4816 7372 7392 8999 7299 4722 8299 4899 4814 description:

This is the merchant category code

services_description* : string maxLength: 100 description:

This is the description of the goods and/or services the merchant sells

federal_tax_id* : string pattern: ^\d{9}$ tin_type* : string Enum (3) social_security employment_id other description:

This is the type of federal tax provided

entity_type* : string Enum (8) sole_proprietor partnership limited_liability_corp privately_held_corp publicly_traded_corp international_organization government non_profit description:

This is the business entity type

website_url : string format: uri maxLength: 70 start_date* : string format: date-time description:

This is the business start date in ISO 8601 format with a timezone

average_amount* : number format: float32 description:

This is the average transaction amount in USD.

average_delivery* : string Enum (4) 07 14 30 31 description:

This is the average delivery time in days. 07: Days in Delivery 0 to 7, 14: Days in Delivery 8 to 14, 30: Days in Delivery 15 to 30, 31: Days in Delivery over 30

seasonal_sales : string Enum (2) 1 0 description:

This determines if the sales are seasonal

address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} owners : array of PspUsdOwner { Defines a US business owner first_name* : string maxLength: 20 last_name* : string maxLength: 20 date_of_birth* : string format: date-time description:

Defines the birthday in ISO 8601 format with a timezone

social_security_number* : string maxLength: 9 phone_number : string pattern: ^\d{1,20}$ email : string maxLength: 70 citizenship* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

percentage : number format: float32 maximum: 100 minimum: 0 description:

Defines the percentage, from 0.00 to 100.00, of the company ownership.

address* : PspUsdAddress { Defines a PSP USD address address_line1* : string maxLength: 24 address_line2 : string maxLength: 24 city* : string maxLength: 21 region : string maxLength: 2 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code

postal_code : string maxLength: 12 description:

Postal/Zip code

} } bank_account* : AmericanBankAccount { Defines an American bank account owner_name* : string maxLength: 64 routing_number* : string pattern: ^\d{9}$ account_number* : string pattern: ^\d{1,17}$ } documents : array of PspUsdFile { Defines a document that is required for application approval. name* : string Enum (3) id_applicant bank_statement pci_saq_document description:

Name of the document.

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

} } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

POST

/workflows/psp-usd/applications/{applicationId}/documents

Description

Creates a United States PSP application document for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to create a document in.	integer
true	body	document	Document details	PspUsdFile

Parameter Schema Definitions

PspUsdFile { Defines a document that is required for application approval. name* : string Enum (3) id_applicant bank_statement pci_saq_document description:

Name of the document.

type* : string Enum (6) jpg jpeg doc docx pdf png description:

File type of the document; accepted file formats.

notes : string description:

Description of the document and the contents that it must contain.

base64* : string description:

The document data, submitted as a base64 encoded string..

uri : string description:

The URI that allows retrival of the documents using the GET /appplicatins/{id}/documents/{name}. [ReadOnly]

}

Responses

Code	Description	Schema
200	Document created	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

DELETE

/workflows/psp-usd/applications/{applicationId}/documents/{documentId}

Description

Deletes a United States PSP application document for the referenced applicationId and documentId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to delete the document from	integer
true	path	documentId	The name of the document to delete	string

Responses

Code	Description	Schema
204	Document deleted	Status
400	Invalid request	Array of Error
404	Application or Document not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/psp-usd/applications/{applicationId}/status

Description

Updates US PSP application status for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update status for	integer
true	body	status	The status details	Status

Parameter Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Responses

Code	Description	Schema
200	Status Updated	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

Gateway application (GW CDN)

POST

/workflows/gw-cdn/applications

Description

Creates a new Canadian Gateway application. The status of the application will be returned in the status object. A Location header that points to the URL of the new resource will be available in the response. The Location header has an application ID that should be used for all future requests to that application.

Parameters

Required	In	Name	Description	Schema
true	body	application	Application details	GwCdnApplicationRequest

Parameter Schema Definitions

GwCdnApplicationRequest { Defines a Canada Gateway application id : integer format: int32 description:

This application identifier is used to identify an application. [ReadOnly]

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : GwCdnApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } } business* : GwCdnBusiness { The details of an Gateway Canadian business company_name* : string maxLength: 64 merchant_category* : string Enum (49) 5813 5811 5812 8398 7997 8651 8661 8641 1711 1750 1731 1520 7623 1761 1740 7033 5462 5411 5499 5994 8021 8099 5963 5699 5971 5970 5992 5399 8931 7311 7542 7217 8351 7379 7372 7392 0780 8111 7349 7333 8999 6513 7251 0742 7230 7210 4121 4722 8299 description:

This is the merchant category code

website_url : string format: uri maxLength: 128 address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } td_terminal : TdTerminal { TD terminal terminal_number : string minLength: 12 maxLength: 12 visa_number : string minLength: 8 maxLength: 8 mc_number : string minLength: 8 maxLength: 8 } first_data_nashville_terminal : FirstDataNashvilleTerminal { First Data Nashville terminal merchant_id : string minLength: 7 maxLength: 7 terminal_number : string minLength: 6 maxLength: 8 visa_number : string minLength: 11 maxLength: 11 mc_number : string minLength: 11 maxLength: 11 } chase_paymentech_terminal : ChasePaymentechTerminal { Chase Paymentech terminal client_number : string minLength: 4 maxLength: 4 merchant_number : string minLength: 12 maxLength: 12 terminal_number : string minLength: 3 maxLength: 3 net_connect_user_id : string minLength: 6 maxLength: 32 net_connect_pw : string minLength: 6 maxLength: 32 visa_number : string minLength: 7 maxLength: 12 mc_number : string minLength: 7 maxLength: 12 } tsys_terminal : TsysTerminal { TSYS terminal acquirer_bin : string minLength: 6 maxLength: 6 agent_bank_number : string minLength: 6 maxLength: 6 agent_chain_number : string minLength: 6 maxLength: 6 merchant_number : string minLength: 12 maxLength: 12 store_number : string minLength: 4 maxLength: 4 terminal_number : string minLength: 4 maxLength: 4 terminal_id : string minLength: 8 maxLength: 8 visa_number : string minLength: 11 maxLength: 12 mc_number : string minLength: 11 maxLength: 12 } global_terminal : GlobalTerminal { Global terminal acquirer_institution : string minLength: 6 maxLength: 6 terminal_id : string minLength: 10 maxLength: 11 bin_number : string minLength: 6 maxLength: 6 visa_number : string minLength: 11 maxLength: 12 mc_number : string minLength: 11 maxLength: 12 } elavon_terminal : ElavonTerminal { Elavon terminal bank_number : string minLength: 6 maxLength: 6 terminal_id : string minLength: 16 maxLength: 16 visa_number : string minLength: 8 maxLength: 12 mc_number : string minLength: 8 maxLength: 12 } moneris_terminal : MonerisTerminal { Moneris terminal } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
201	Application created	Status
400	Invalid request	Array of Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/gw-cdn/applications

Description

Retrieves all Canadian Gateway applications referenced by the given criteria in the url. A search criteria can be a combination of the following: - state={state} - Accepted values are "in_progress", "in_review", "on_hold", "approved" "rejected", "live" and "temp_disabled" - createdbefore={date} - createdafter={date} - updatedbefore={date} - updatedafter={date}

Documents file data will be excluded to limit the amount of data on the wire.

Parameters

No parameters

Responses

Code	Description	Schema
200	Application(s) retrieved	Array of GwCdnApplicationRequest
400	Invalid request	Array of Error
404	Applications not found	Error
500	Unexpected error	Error

Response Schema Definitions

GwCdnApplicationRequest { Defines a Canada Gateway application id : integer format: int32 description:

This application identifier is used to identify an application. [ReadOnly]

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : GwCdnApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } } business* : GwCdnBusiness { The details of an Gateway Canadian business company_name* : string maxLength: 64 merchant_category* : string Enum (49) 5813 5811 5812 8398 7997 8651 8661 8641 1711 1750 1731 1520 7623 1761 1740 7033 5462 5411 5499 5994 8021 8099 5963 5699 5971 5970 5992 5399 8931 7311 7542 7217 8351 7379 7372 7392 0780 8111 7349 7333 8999 6513 7251 0742 7230 7210 4121 4722 8299 description:

This is the merchant category code

website_url : string format: uri maxLength: 128 address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } td_terminal : TdTerminal { TD terminal terminal_number : string minLength: 12 maxLength: 12 visa_number : string minLength: 8 maxLength: 8 mc_number : string minLength: 8 maxLength: 8 } first_data_nashville_terminal : FirstDataNashvilleTerminal { First Data Nashville terminal merchant_id : string minLength: 7 maxLength: 7 terminal_number : string minLength: 6 maxLength: 8 visa_number : string minLength: 11 maxLength: 11 mc_number : string minLength: 11 maxLength: 11 } chase_paymentech_terminal : ChasePaymentechTerminal { Chase Paymentech terminal client_number : string minLength: 4 maxLength: 4 merchant_number : string minLength: 12 maxLength: 12 terminal_number : string minLength: 3 maxLength: 3 net_connect_user_id : string minLength: 6 maxLength: 32 net_connect_pw : string minLength: 6 maxLength: 32 visa_number : string minLength: 7 maxLength: 12 mc_number : string minLength: 7 maxLength: 12 } tsys_terminal : TsysTerminal { TSYS terminal acquirer_bin : string minLength: 6 maxLength: 6 agent_bank_number : string minLength: 6 maxLength: 6 agent_chain_number : string minLength: 6 maxLength: 6 merchant_number : string minLength: 12 maxLength: 12 store_number : string minLength: 4 maxLength: 4 terminal_number : string minLength: 4 maxLength: 4 terminal_id : string minLength: 8 maxLength: 8 visa_number : string minLength: 11 maxLength: 12 mc_number : string minLength: 11 maxLength: 12 } global_terminal : GlobalTerminal { Global terminal acquirer_institution : string minLength: 6 maxLength: 6 terminal_id : string minLength: 10 maxLength: 11 bin_number : string minLength: 6 maxLength: 6 visa_number : string minLength: 11 maxLength: 12 mc_number : string minLength: 11 maxLength: 12 } elavon_terminal : ElavonTerminal { Elavon terminal bank_number : string minLength: 6 maxLength: 6 terminal_id : string minLength: 16 maxLength: 16 visa_number : string minLength: 8 maxLength: 12 mc_number : string minLength: 8 maxLength: 12 } moneris_terminal : MonerisTerminal { Moneris terminal } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/gw-cdn/applications/{applicationId}

Description

Updates a Canadian Gateway application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update	integer
true	body	document	Application details	GwCdnApplicationRequest

Parameter Schema Definitions

GwCdnApplicationRequest { Defines a Canada Gateway application id : integer format: int32 description:

This application identifier is used to identify an application. [ReadOnly]

status : Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : GwCdnApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } } business* : GwCdnBusiness { The details of an Gateway Canadian business company_name* : string maxLength: 64 merchant_category* : string Enum (49) 5813 5811 5812 8398 7997 8651 8661 8641 1711 1750 1731 1520 7623 1761 1740 7033 5462 5411 5499 5994 8021 8099 5963 5699 5971 5970 5992 5399 8931 7311 7542 7217 8351 7379 7372 7392 0780 8111 7349 7333 8999 6513 7251 0742 7230 7210 4121 4722 8299 description:

This is the merchant category code

website_url : string format: uri maxLength: 128 address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } td_terminal : TdTerminal { TD terminal terminal_number : string minLength: 12 maxLength: 12 visa_number : string minLength: 8 maxLength: 8 mc_number : string minLength: 8 maxLength: 8 } first_data_nashville_terminal : FirstDataNashvilleTerminal { First Data Nashville terminal merchant_id : string minLength: 7 maxLength: 7 terminal_number : string minLength: 6 maxLength: 8 visa_number : string minLength: 11 maxLength: 11 mc_number : string minLength: 11 maxLength: 11 } chase_paymentech_terminal : ChasePaymentechTerminal { Chase Paymentech terminal client_number : string minLength: 4 maxLength: 4 merchant_number : string minLength: 12 maxLength: 12 terminal_number : string minLength: 3 maxLength: 3 net_connect_user_id : string minLength: 6 maxLength: 32 net_connect_pw : string minLength: 6 maxLength: 32 visa_number : string minLength: 7 maxLength: 12 mc_number : string minLength: 7 maxLength: 12 } tsys_terminal : TsysTerminal { TSYS terminal acquirer_bin : string minLength: 6 maxLength: 6 agent_bank_number : string minLength: 6 maxLength: 6 agent_chain_number : string minLength: 6 maxLength: 6 merchant_number : string minLength: 12 maxLength: 12 store_number : string minLength: 4 maxLength: 4 terminal_number : string minLength: 4 maxLength: 4 terminal_id : string minLength: 8 maxLength: 8 visa_number : string minLength: 11 maxLength: 12 mc_number : string minLength: 11 maxLength: 12 } global_terminal : GlobalTerminal { Global terminal acquirer_institution : string minLength: 6 maxLength: 6 terminal_id : string minLength: 10 maxLength: 11 bin_number : string minLength: 6 maxLength: 6 visa_number : string minLength: 11 maxLength: 12 mc_number : string minLength: 11 maxLength: 12 } elavon_terminal : ElavonTerminal { Elavon terminal bank_number : string minLength: 6 maxLength: 6 terminal_id : string minLength: 16 maxLength: 16 visa_number : string minLength: 8 maxLength: 12 mc_number : string minLength: 8 maxLength: 12 } moneris_terminal : MonerisTerminal { Moneris terminal } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Responses

Code	Description	Schema
200	Application Updated.	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

GET

/workflows/gw-cdn/applications/{applicationId}

Description

Retrieves a Canadian Gateway application referenced by the given applicationId.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to retrieve	string

Responses

Code	Description	Schema
200	Application retrieved	GwCdnApplicationResponse
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

GwCdnApplicationResponse { Defines a Canada Gateway application id : integer format: int32 description:

This application identifier is used to identify an application. [ReadOnly]

status : StatusResponse { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

submitted_on : string format: date-time description:

Defines the date when the application was put into review in ISO 8601 format with a timezone [ReadOnly]

approved_on : string format: date-time description:

Defines the date when the application was approved in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} } applicant* : GwCdnApplicant { The individual completing the application first_name* : string maxLength: 64 last_name* : string maxLength: 64 phone_number* : string maxLength: 15 agreement* : Agreement { Defines an terms and conditions agreement between a merchant and Beanstream name* : string description:

Defines the name of the agreement. Use the application type, as is in the url: eg. PSP-CAD

version* : string description:

Defines the version of the agreement. Use the version number that is in the terms document file name. For example http:...com/terms/api/psp-cad-v1.0-062016.htm you would use: 1.0-062016

timestamp* : string format: date-time description:

Defines the date of the application terms and conditions agreeent in ISO 8601 format with a timezone [ReadOnly]

} email* : string maxLength: 500 bank_account* : CanadianBankAccount { Defines a Canadian bank account currency : string Enum (2) CAD USD default: CAD description:

This is the currency of the bank account

owner_name* : string maxLength: 64 transit_number* : string pattern: ^\d{5}$ institution_number* : string pattern: ^\d{3,4}$ account_number* : string pattern: ^\d{4,12}$ } } business* : GwCdnBusiness { The details of an Gateway Canadian business company_name* : string maxLength: 64 merchant_category* : string Enum (49) 5813 5811 5812 8398 7997 8651 8661 8641 1711 1750 1731 1520 7623 1761 1740 7033 5462 5411 5499 5994 8021 8099 5963 5699 5971 5970 5992 5399 8931 7311 7542 7217 8351 7379 7372 7392 0780 8111 7349 7333 8999 6513 7251 0742 7230 7210 4121 4722 8299 description:

This is the merchant category code

website_url : string format: uri maxLength: 128 address* : Address { Defines a generic address address_line1* : string maxLength: 64 address_line2 : string maxLength: 64 city* : string maxLength: 64 region : string maxLength: 64 description:

State/Province/Municipality/Region

country* : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW description:

Valid ISO 3166-1 country code for US, CA, GB, or a European country

postal_code : string maxLength: 7 description:

Postal/Zip code

} } td_terminal : TdTerminal { TD terminal terminal_number : string minLength: 12 maxLength: 12 visa_number : string minLength: 8 maxLength: 8 mc_number : string minLength: 8 maxLength: 8 } first_data_nashville_terminal : FirstDataNashvilleTerminal { First Data Nashville terminal merchant_id : string minLength: 7 maxLength: 7 terminal_number : string minLength: 6 maxLength: 8 visa_number : string minLength: 11 maxLength: 11 mc_number : string minLength: 11 maxLength: 11 } chase_paymentech_terminal : ChasePaymentechTerminal { Chase Paymentech terminal client_number : string minLength: 4 maxLength: 4 merchant_number : string minLength: 12 maxLength: 12 terminal_number : string minLength: 3 maxLength: 3 net_connect_user_id : string minLength: 6 maxLength: 32 net_connect_pw : string minLength: 6 maxLength: 32 visa_number : string minLength: 7 maxLength: 12 mc_number : string minLength: 7 maxLength: 12 } tsys_terminal : TsysTerminal { TSYS terminal acquirer_bin : string minLength: 6 maxLength: 6 agent_bank_number : string minLength: 6 maxLength: 6 agent_chain_number : string minLength: 6 maxLength: 6 merchant_number : string minLength: 12 maxLength: 12 store_number : string minLength: 4 maxLength: 4 terminal_number : string minLength: 4 maxLength: 4 terminal_id : string minLength: 8 maxLength: 8 visa_number : string minLength: 11 maxLength: 12 mc_number : string minLength: 11 maxLength: 12 } global_terminal : GlobalTerminal { Global terminal acquirer_institution : string minLength: 6 maxLength: 6 terminal_id : string minLength: 10 maxLength: 11 bin_number : string minLength: 6 maxLength: 6 visa_number : string minLength: 11 maxLength: 12 mc_number : string minLength: 11 maxLength: 12 } elavon_terminal : ElavonTerminal { Elavon terminal bank_number : string minLength: 6 maxLength: 6 terminal_id : string minLength: 16 maxLength: 16 visa_number : string minLength: 8 maxLength: 12 mc_number : string minLength: 8 maxLength: 12 } moneris_terminal : MonerisTerminal { Moneris terminal } custom_data : object description:

Optional custom data, must be a JSON object. Example: {"id": 12345}

}

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

PUT

/workflows/gw-cdn/applications/{applicationId}/status

Description

Updates Canadian Gateway application status for the referenced applicationId. Returns the status of the application.

Parameters

Required	In	Name	Description	Schema
true	path	applicationId	The id of the application to update status for	integer
true	body	status	The status details	Status

Parameter Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Responses

Code	Description	Schema
200	Status Updated	Status
400	Invalid request	Array of Error
404	Application not found	Error
500	Unexpected error	Error

Response Schema Definitions

Status { Defines information about the application. [ReadOnly] state : string Enum (4) in_progress in_review rejected approved description:

The state of the application. Possible values are "inprogress", "inreview", "rejected", "approved"

created_on : string format: date-time description:

Defines the date when the application was created in ISO 8601 format with a timezone [ReadOnly]

updated_on : string format: date-time description:

Defines the date when the application was modified in ISO 8601 format with a timezone [ReadOnly]

pending_issues : array of Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

} }

Error { Defines an error field : string description:

A field associated with the error

code : string description:

A code associated with the error

}

Terms and Conditions (GW CDN)

GET

/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.	string

Responses

Code	Description	Schema
200	Document version info	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

GET

/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.	string
true	path	version	The version of the document.	string

Responses

Code	Description	Schema
200	Document retrieved with identifing properties in HTTP header	200 Response
400	Invalid request	Array of Error
404	Document not found	Error
500	Unexpected error	Error

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_date:time description: Defines the name of the document returned. }
Error { Defines an error field : string description: A field associated with the error code : string description: A code associated with the error }

Onboarding API

Security

api_key

Operations