Create Collected Account

Create Collected Account.

Request

Request header:

POST https://api.ipaymy.com/v2/payment_collections/collected_account
Host: api.ipaymy.com
Accept: application/json

Request body:

{
  "id": 0,
  "business_type": 0,
  "business_industry": 0,
  "first_name": "",
  "last_name": "",
  "recipient_email": "",
  "confirm_recipient_email": "",
  "account_id": 0,
  "registration_number": "",
  "company_name": "",
  "currency_id": 0,
  "country_id": 0,
  "bank_id": 0,
  "bank_bsb_id": 0,
  "bank_code": "",
  "bsb_code": "",
  "account_number": "",
  "bank_documents": [""],
  "default_statement_descriptor": "",
  "default_fee_payer": 0,
  "default_int_fee_payer": 0,
  "default_crypto_rate_payer": 0,
  "requester_national_rate": 0,
  "requester_oversea_rate": 0,
  "requester_crypto_rate": 0,
  "requester_rates": [
    {
      "brand_id": 0,
      "national": 0,
      "international": 0,
      "fee_payer": 0,
      "int_fee_payer": 0,
      "crypto_rate": 0,
      "crypto_rate_payer": 0
    }
  ],
  "purpose_id": 0,
  "company_sms_name": "",
  "confirmed_account_number": "",
  "draft": true,
  "to_create_or_upload_invoice": "create | upload | sms | none",
  "gst_registration_number": "",
  "company_address_line_1": "",
  "company_address_line_2": "",
  "branding_color": "",
  "company_logo": "",
  "confirmed_tnc": true,
  "confirmed_policy": true,
  "is_secondary": true,
  "commission_rate": 0,
  "recipient_name": "",
  "bank_raw_swift_code": "",
  "required_verification_fields": [""],
  "b_acra_bizfile": [""],
  "b_poba": [""],
  "b_structured_chart": [""],
  "b_letter_of_authorization": [""],
  "business_operating_model": "",
  "customer_serve": "",
  "business_website": "",
  "average_invoice_number": 0,
  "myinfo_biz": {
    "person": {
      "nationality": {
        "code": "",
        "desc": ""
      }
    },
    "entity": {
      "basic-profile": {
        "uen": {
          "value": ""
        },
        "entity-name": {
          "value": ""
        },
        "entity-type": {
          "value": ""
        },
        "entity-status": {
          "value": ""
        },
        "primary-activity": {
          "code": "",
          "desc": ""
        },
        "secondary-activity": {
          "code": "",
          "desc": ""
        },
        "registration-date": {
          "value": ""
        },
        "company-type": {
          "code": "",
          "desc": ""
        },
        "ownership": {
          "code": "",
          "desc": ""
        },
        "country-of-incorporation": {
          "code": "",
          "desc": ""
        }
      },
      "addresses": {
        "addresses-list": [
          {
            "history-name": {
              "value": ""
            },
            "history-name-effective-date": {
              "value": ""
            }
          }
        ],
        "lastupdated": "",
        "source": "",
        "classification": ""
      }
    }
  }
}

Response

Response body:

{
  "data": {
    "id": 690
  },
  "error": 0
}

Response codes:

• 200: Good stuff, and the response body should be easy to parse.
• 422: Typically malformed JSON, such as an integer in place of the required alphanumeric string, or a missing key. Check the response body for further details.