Create a new Contact

Create a new Contact.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

The abstract contact view used by `ContactPersonalView` and `ContactBusinessView`

string <uuid>

required

The contact identifier

type

enum<string>

required

Contact Types: personalor business

Allowed values:

personalbusiness

currency

string

required

The currency of contact.
Two-letter ISO 3166-2 country code

country

string

required

Country where the business was registered.
Two-letter ISO 3166-2 country code

display_name

string

required

The contact display name

category

enum<string>

ContactCategory

required

The contact category: sender, recipient or all

Allowed values:

recipientsenderall

bank

object

ContactBankAccountDetail

optional

Bank Detail information of a Recipient.

ewallet

object

ContactEwalletDetail

optional

The Ewallet information details of an Recipient.

cash

object

ContactCashPickupDetail

optional

The Cash Pickup information details of an Recipient.

personal

object

ContactPersonal

optional

Abstract Personal Contact information used in ContactPersonalView and ContactPersonalModel.

Examples

personal-examplebusiness-example

{
  "id": "7b048f91-0521-4f02-8e45-51eb8658822e",
  "type": "personal",
  "category": "recipient",
  "currency": "VND",
  "country": "VN",
  "display_name": "VND - Bao Bao Truong",
  "personal": {
    "first_name": "Bao",
    "middle_name": "Bao",
    "last_name": "Truong",
    "other_name": "",
    "gender": "female",
    "date_of_birth": null,
    "nationality": "VN",
    "email": "xxx@test.com",
    "mobile_number": "903123456",
    "mobile_number_prefix": "+84",
    "country_of_birth": null,
    "occupation": null,
    "industry_category": null,
    "industry_sub_category": null,
    "identification": {
      "id_type": "passport",
      "id_number": "AA1234567"
    },
    "address": {
      "line1": "243C Chi Trai, Ward 1, District 3",
      "line2": "",
      "city": "Hanoi",
      "state_or_province": "Hanoi",
      "country": "VN",
      "postal": "700000"
    }
  },
  "bank": {
    "bank_name": "Military Commercial Joint Stock bank (MB)",
    "bank_country": "VN",
    "bank_account_currency": "VND",
    "bank_account_name": "BAO BAO TRUONG",
    "bank_account_number": "12341236001",
    "ts_bank_code": "TSVN0020",
    "swift_bic_code": "",
    "bank_code": null,
    "sort_code": "",
    "iban_code": "",
    "bsb_code": "",
    "zengin_code": "",
    "ifsc_code": null,
    "cnaps_code": null,
    "aba_routing_number": ""
  },
  "ewallet": {
    "ewallet_provider": null,
    "ewallet_account_name": null,
    "ewallet_account_number": null
  },
  "cash": {
    "cash_provider": null
  }
}

🟠400Bad Request

🟠401Unauthorized

🟠429429

🔴500Server Error

Request

Request samples

Responses