Resources Enums Models Unions Annotations Clients

organization-onboarding-state 0.19.12

History | Watch

API used for tracking onboarding state of merchants

  • Contact: N/A
  • License: N/A

Resources

organization_onboarding_state

Operations

Method and Path Description
GET /:organization/onboarding/state
PUT /:organization/onboarding/state/activation
PUT /:organization/onboarding/state/deactivation
PUT /:organization/onboarding/state/reject
PUT /channel/:channel/organization/:organization/activate
PUT /channel/:channel/organization/:organization/reject
PUT /channel/:channel/organization/:organization/deactivate

Headers

No headers

Imports

https://app.apibuilder.io/flow/common/latest/service.json
https://app.apibuilder.io/flow/error/latest/service.json

Enums

merchant_disabled_reason

Name Value Description
merchant_deactivated merchant_deactivated
merchant_rejected merchant_rejected

merchant_rejected_reason

Name Value Description
merchant_ubo_is_pep merchant_ubo_is_pep
merchant_catalog_is_unsupportable merchant_catalog_is_unsupportable
merchant_failed_kyb_review merchant_failed_kyb_review

onboarding_blocked_reason

Name Value Description
street_address_is_blank_3pl street_address_is_blank_3pl
street_address_is_po_box_3pl street_address_is_po_box_3pl
business_street_address_is_blank business_street_address_is_blank
business_street_address_is_po_box business_street_address_is_po_box
exception_merchant exception_merchant
application_missing application_missing
missing_logistics_contact_info missing_logistics_contact_info

Interfaces

No interfaces

Models

activation_put_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
placeholder boolean No -

deactivation_put_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
reason string Yes -

deactivate_at date-time-iso8601 No -

in_compliance_review

Example Json: Minimal | Full

Interfaces: None

The merchant is under review

Field Type Required? Default Description Annotations
placeholder boolean No -

merchant_activated

Example Json: Minimal | Full

Interfaces: None

The merchant is activated by partner

Field Type Required? Default Description Annotations
placeholder boolean No -

merchant_deactivated

Example Json: Minimal | Full

Interfaces: None

The merchant is deactivated by partner

Field Type Required? Default Description Annotations
reason string Yes -

deactivate_at date-time-iso8601 No -

merchant_disabled

Example Json: Minimal | Full

Interfaces: None

The merchant is disabled. Their API token is no longer working.

Field Type Required? Default Description Annotations
reason merchant_disabled_reason Yes -

merchant_rejected

Example Json: Minimal | Full

Interfaces: None

The merchant is rejected for onboarding by the compliance team

Field Type Required? Default Description Annotations
reason merchant_rejected_reason Yes -

description string No -

deactivate_at date-time-iso8601 No -

onboarding_state_transition

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

state onboarding_state Yes -

started_at date-time-iso8601 Yes -

organization_onboarding_state

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

organization io.flow.common.v0.models.organization_reference:0.19.12 Yes -

transitions [onboarding_state_transition] Yes -

current_state onboarding_state Yes -

started_at date-time-iso8601 No -

time_blocked long No -

time_in_setup long No -

blocked_since date-time-iso8601 No -

completed_at date-time-iso8601 No -

onboarding_started_at date-time-iso8601 No -

rejection_put_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
reason merchant_rejected_reason Yes -

description string Yes -

setup_blocked

Example Json: Minimal | Full

Interfaces: None

The onboarding process is blocked by an issue that requires escalation

Field Type Required? Default Description Annotations
reasons [onboarding_blocked_reason] Yes -

setup_completed

Example Json: Minimal | Full

Interfaces: None

The onboarding setup is completed and the organization is ready to process order.

Field Type Required? Default Description Annotations
third_party_logistics_guid string No -

setup_in_progress

Example Json: Minimal | Full

Interfaces: None

The merchant is approved for onboarding by the compliance team & onboarding config automation has begun

Field Type Required? Default Description Annotations
placeholder boolean No -

Unions

onboarding_state

Interfaces: None

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
in_compliance_review in_compliance_review Minimal | Full

setup_in_progress setup_in_progress Minimal | Full

merchant_rejected merchant_rejected Minimal | Full

setup_blocked setup_blocked Minimal | Full

setup_completed setup_completed Minimal | Full

merchant_activated merchant_activated Minimal | Full

merchant_deactivated merchant_deactivated Minimal | Full

merchant_disabled merchant_disabled Minimal | Full

Annotations

personal_data

Identifies a field that contains Personal Data, as defined by GDPR. By default, any field marked with this annotation will be kept for 1 year and will be purgeable upon request provided there are no incomplete business activities associated with it.

consumer

Identifies a field that contains data about a consumer [as opposed to an employee of Flow, an organization or a partner].