Contacts

Create Contact

Creates a new contact with ACH, wire, or check payment details, international payment details, or one or more crypto addresses.

post/contacts

Request

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Request body

nicknamestring required

A nickname or display name for the contact (1-300 characters).

emailstring email nullable

The email address of the contact.

Example request

{
  "international": {
    "company_name": "Catnip Coffee GmbH",
    "bank_name": "Deutsche Bank",
    "account_number": "12345678",
    "iban": "DE89370400440532013000",
    "bic_swift": "DEUTDEFF",
    "routing_code_value": "200000"
  }
}

Response

Successful Response

idstring uuid required

The unique identifier of the contact.

nicknamestring required

A nickname or display name for the contact.

emailstring email nullable

The email address of the contact.

supported_payment_methodsCustomerApiPaymentMethodType[] required

List of payment methods supported by this contact.

last_payment_reason'audio_visual_services' | 'bill_payment' | 'business_expenses' | 'construction' | 'donation_charitable_contribution' | 'education_training' | 'family_support' | 'freight' | 'goods_purchased' | 'investment_capital' | 'investment_proceeds' | 'living_expenses' | 'loan_credit_repayment' | 'medical_services' | 'pension' | 'personal_remittance' | 'professional_business_services' | 'real_estate' | 'taxes' | 'technical_services' | 'transfer_to_own_account' | 'travel' | 'wages_salary' | 'other_services'

Changes

No recorded changes to this operation across all 1 revision of this API.