v1

latestOpenAPI 3.1.02026-07-2469193340.0 KB

Contacts

Add a Contact

Use this endpoint when you want to pay somebody.

<aside class="notice"> A Contact added this way cannot be debited. </aside>

post/contacts/anyone

Request body

namestring required

The name of the Contact (140 max. characters, ASCII characters only)

emailstring required

The email of the Contact (256 max. characters)

branch_codestring required

The bank account BSB of the Contact

account_numberstring required

The bank account number of the Contact

metadataMetadata

Use for your custom data and certain Zepto customisations.

Example request

{
  "name": "Hunter Thompson",
  "email": "hunter@batcountry.com",
  "branch_code": "123456",
  "account_number": "13048322",
  "metadata": {
    "custom_key": "Custom string",
    "another_custom_key": "Maybe a URL"
  }
}

Response

Created

dataobject required

Example response

{
  "data": {
    "id": "6a7ed958-f1e8-42dc-8c02-3901d7057357",
    "name": "Hunter Thompson",
    "email": "hunter@batcountry.com",
    "type": "anyone",
    "metadata": {
      "custom_key": "Custom string",
      "another_custom_key": "Maybe a URL"
    },
    "bank_account": {
      "id": "55afddde-4296-4daf-8e49-7ba481ef9608",
      "account_number": "13048322",
      "branch_code": "123456",
      "bank_name": "National Australia Bank",
      "state": "active",
      "iav_provider": null,
      "iav_status": null,
      "blocks": {
        "debits_blocked": false,
        "credits_blocked": false
      }
    },
    "links": {
      "add_bank_connection": "https://go.sandbox.zeptopayments.com/invite_contact/thomas-morgan-1/1030bfef-cef5-4938-b10b-5841cafafc80"
    }
  }
}