Onboarding

10 endpoints. Base URL https://api.paymentsonline.io, sandbox https://api.sandbox-paymentsonline.io.

Every request needs payments-api-key and payments-account.

GET/v1/applications/{account_id}

Get a Merchant ApplicationDeprecated

Retrieves the details of an existing merchant application. The application can only be accessed if its status is created or started. Once the application is submitted or active, it is no longer accessible.

Path parameters

account_idstringrequired
The id of the associated connected (i.e. merchant) account.

Responses

200MerchantApplication

accept_terms_and_conditionsbooleanrequired
Indicates whether or not the merchant has accepted the terms and conditions.
business_legal_entityBusinessLegalEntityoptional
Merchant account details
pricing_templatesarray of PricingTemplaterequired
The pricing templates applied to/associated with this merchant application.
product_codesarray of ProductCoderequired
*Deprecated: See pricing_template for account details.* The product codes applied to/associated with this merchant application.
terms_and_conditions_linksarray of TermsAndConditionsDetailoptional
Links to terms and conditions for a merchant application.
updated_atstring date-timeoptional
Time at which the object was last updated.
validation_errorsarray of stringoptional
If an application contains any validation errors they will appear here. If they are not addressed before submission then the submission will fail.

403

404

PUT/v1/applications/{account_id}

Update a Merchant ApplicationDeprecated

Updates a merchant application by overwriting all properties.

Path parameters

account_idstringrequired
The id of the associated connected (i.e. merchant) account.

Request body application/jsonrequired

accept_terms_and_conditionsbooleanrequired
Indicates whether or not the merchant has accepted the terms and conditions.
business_legal_entityBusinessLegalEntityoptional
Merchant account details

Responses

200MerchantApplication

accept_terms_and_conditionsbooleanrequired
Indicates whether or not the merchant has accepted the terms and conditions.
business_legal_entityBusinessLegalEntityoptional
Merchant account details
pricing_templatesarray of PricingTemplaterequired
The pricing templates applied to/associated with this merchant application.
product_codesarray of ProductCoderequired
*Deprecated: See pricing_template for account details.* The product codes applied to/associated with this merchant application.
terms_and_conditions_linksarray of TermsAndConditionsDetailoptional
Links to terms and conditions for a merchant application.
updated_atstring date-timeoptional
Time at which the object was last updated.
validation_errorsarray of stringoptional
If an application contains any validation errors they will appear here. If they are not addressed before submission then the submission will fail.

403

404

POST/v1/applications/{account_id}/submit

Submit a Merchant ApplicationDeprecated

Submits a merchant application for processing. If there are any validation errors, they must be corrected before re-submitting. Once successfully submitted, the application is no longer accessible.

Path parameters

account_idstringrequired
The id of the associated connected (i.e. merchant) account.

Responses

202object

400

403

404

GET/v1/onboarding

Get an Onboarding Application

Retrieves an onboarding application.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

200OnboardingApplication

bank_verificationOnboardingBankVerificationoptional
The bank verification used during onboarding.
canada_visa_mc_processingbooleanoptional
Canadian merchants only. If set to true, the merchant opts into processing visa and mastercard.
legal_entityOnboardingLegalEntityrequired
Merchant account details
pricing_templatesarray of PricingTemplaterequired
The pricing templates applied to/associated with this merchant application.
terms_and_conditions_linksarray of TermsAndConditionsDetailoptional
Links to terms and conditions for a merchant application.
tos_acceptancebooleanrequired
Indicates whether or not the merchant has accepted the terms of service.
updated_atstring date-timeoptional
Time at which the object was last updated.
validation_errorsarray of stringoptional
If an application contains any validation errors they will appear here. If they are not addressed before submission then the submission will fail.

403

404

POST/v1/onboarding

Update an Onboarding Application

Updates an onboarding application by overwriting all properties. You must pass the entire payload each time.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Request body application/jsonrequired

canada_visa_mc_processingbooleanoptional
Canadian merchants only. If set to true, the merchant opts into processing visa and mastercard.
legal_entityOnboardingLegalEntityrequired
Merchant account details
tos_acceptancebooleanrequired
Indicates whether or not the merchant has accepted the terms of service.

Update Onboarding Application Example

{
  "legal_entity": {
    "mcc": "7542",
    "region": "US",
    "address": {
      "street": "123 Main Street",
      "street2": "1",
      "city": "NYC",
      "state": "NY",
      "postal_code": "11004",
      "country": "US"
    },
    "website": "https://example.com",
    "is_501c3": false,
    "structure": "limited_liability_company",
    "legal_name": "Legal Name",
    "principals": [
      {
        "email": "test@example.com",
        "phone": "18007778378",
        "address": {
          "street": "123 Main Street",
          "street2": "1",
          "city": "NYC",
          "state": "NY",
          "postal_code": "11004",
          "country": "US"
        },
        "id_number": "123456789",
        "job_title": "chief_executive_officer",
        "last_name": "LastName",
        "first_name": "FirstName",
        "is_applicant": true,
        "date_of_birth": "1999-03-04",
        "is_control_prong": true,
        "previous_address": null,
        "percent_ownership": 75
      }
    ],
    "bank_account": {
      "type": "checking",
      "bank_name": "Bank Of America",
      "account_number": "123456789012",
      "routing_number": "011000138",
      "account_holder_name": "Account Holder"
    },
    "support_email": "test@example.com",
    "support_phone": "18007778378",
    "tax_id_number": "123456780",
    "charity_document": null,
    "processing_volume": {
      "currency": "usd",
      "high_ticket_amount": 1000000,
      "monthly_processing_volume": 1000000,
      "monthly_transaction_count": 1000,
      "average_transaction_amount_card": 100,
      "average_transaction_amount_debit": 100
    },
    "number_of_terminals": null,
    "patriot_act_details": {
      "business_license": null,
      "articles_of_incorporation": {
        "state": "AZ",
        "issued_at": "1999-10-10"
      }
    },
    "product_description": "A product description",
    "statement_descriptor": "A descriptor",
    "date_of_incorporation": "1999-08-09",
    "existing_processor_name": "I've never processed payments before",
    "percent_business_to_business": 51,
    "days_billed_prior_to_shipment": 0,
    "average_refund_days": 30,
    "card_checkout_method_breakdown": {
      "percent_swiped": 0,
      "percent_e_commerce": 100,
      "percent_manual_card_not_present": 0
    },
    "partner_of_record_id": null
  },
  "tos_acceptance": true
}

Responses

201OnboardingApplication

bank_verificationOnboardingBankVerificationoptional
The bank verification used during onboarding.
canada_visa_mc_processingbooleanoptional
Canadian merchants only. If set to true, the merchant opts into processing visa and mastercard.
legal_entityOnboardingLegalEntityrequired
Merchant account details
pricing_templatesarray of PricingTemplaterequired
The pricing templates applied to/associated with this merchant application.
terms_and_conditions_linksarray of TermsAndConditionsDetailoptional
Links to terms and conditions for a merchant application.
tos_acceptancebooleanrequired
Indicates whether or not the merchant has accepted the terms of service.
updated_atstring date-timeoptional
Time at which the object was last updated.
validation_errorsarray of stringoptional
If an application contains any validation errors they will appear here. If they are not addressed before submission then the submission will fail.

403

404

GET/v1/onboarding/esignature/{document_id}/signer/{id}

Get Esignature Signer

Retrieves an Esignature Signer.

Path parameters

idstringrequired
document_idstringrequired

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

200EsignatureSigner

emailstringrequired
The email of the Esignature Signer.
embeddedbooleanrequired
Whether or not the Esignature Signer is signing an embedded document (other Esignature Signers will sign via email).
esignature_document_idstringrequired
Unique identifier for corresponding Esignature Document of the Esignature Signer.
idstringrequired
Unique identifier for the object.
namestringrequired
The name of the Esignature Signer.
statusstring (sent | viewed | completed)required
The status of the Esignature Signer.

403

404

POST/v1/onboarding/esignature/{document_id}/signer/{id}/resend

Resend Esignature Document email

Resend an Esignature Document email to a specific Esignature Signer.

Path parameters

idstringrequired
document_idstringrequired

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

200

201

403

404

GET/v1/onboarding/mcc

Get MCC Descriptions

Retrieves descriptions for all valid merchant category codes (MCC).

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

200array of MccDescription

404

POST/v1/onboarding/signing-links

Regenerate Signing Links

Returns an array of Signing Links if the merchant signature has not been acquired yet.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Request body application/jsonrequired

redirect_urlstringoptional
The redirect URL to send the merchant to after signing the application. This is optional and will default to the application's redirect URL if not provided.

Responses

201array of SigningLink

403Forbidden

404Not Found

POST/v1/onboarding/submit

Submit an Onboarding Application

Submits an onboarding application to be processed. If any validation errors exist, they must be corrected before re-submitting. Returns an array of Signing Links if a merchant signature is required.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Request body application/jsonrequired

redirect_urlstringoptional
The redirect URL to send the merchant to after signing the application. This is optional and will default to the application's redirect URL if not provided.

Submit Onboarding Application Example

{
  "redirect_url": "https://example.com/redirect"
}

Responses

201SubmitApplicationResponse

signing_linksarray of SigningLinkrequired

403Forbidden

404Not Found