ZEzeptopayments
Payments

Make a Payment

Changed on

To enable custom payment flows, the required payment channel can be selected by setting the channel attribute to one of the following combinations:

<ul> <li>["new_payments_platform"] - for faster payments 24/7/365</li> <li>["direct_entry"] - for slower traditional payments</li> <li>["new_payments_platform", "direct_entry"] - enables automatic channel switching if a payment fails on the NPP</li> </ul> <aside class="notice">We now require supplying an <code>Idempotency-Key</code> header when performing this request to ensure you can safely retry the action in case of an issue. If the header value is different to one provided previously, we will be treating a request as a new operation which may lead to duplicate payments. To understand more on how to make idempotent requests, please refer to our <a href="https://docs.zeptopayments.com/v20260901/reference/idempotent-requests">Idempotent requests guide</a>.</aside>
post/payments

Request

  • Base URL
    https://api.sandbox.zeptopayments.com
  • URL
    https://api.sandbox.zeptopayments.com/payments
  • Auth
    OAuth 2
    Authorization code: /oauth/authorize
    Token URL: /oauth/token

Headers

Idempotency-Keystring required

Idempotency key to support safe retries for 24h

Request body

descriptionstring required

User description. Only visible to the payer. ASCII-printable characters and unicode emojis are accepted.

matures_atstring date-time required

Date & time in UTC ISO8601 the Payment should be processed. (Can not be earlier than the start of current day in Sydney AEST/AEDT)

your_bank_account_idstring required

Specify where we should take the funds for this transaction. If omitted, your primary bank account will be used.

metadataMetadata

Use for your custom data and certain Zepto customisations.

Example request

{
  "description": "The SuperPackage",
  "matures_at": "2021-06-13T00:00:00Z",
  "your_bank_account_id": "83623359-e86e-440c-9780-432a3bc3626f",
  "channels": [
    "new_payments_platform"
  ],
  "payouts": [
    {
      "amount": 30000,
      "description": "A tandem skydive jump SB23094",
      "recipient_contact_id": "48b89364-1577-4c81-ba02-96705895d457",
      "metadata": {
        "invoice_ref": "BILL-0001",
        "invoice_id": "c80a9958-e805-47c0-ac2a-c947d7fd778d",
        "custom_key": "Custom string",
        "another_custom_key": "Maybe a URL"
      }
    }
  ],
  "metadata": {
    "custom_key": "Custom string",
    "another_custom_key": "Maybe a URL"
  }
}

Response

Created

dataobject required

Example response

{
  "data": {
    "ref": "PB.1",
    "your_bank_account_id": "83623359-e86e-440c-9780-432a3bc3626f",
    "channels": [
      "new_payments_platform"
    ],
    "payouts": [
      {
        "ref": "D.1",
        "recipient_contact_id": "48b89364-1577-4c81-ba02-96705895d457",
        "batch_description": "The SuperPackage",
        "matures_at": "2016-09-13T23:50:44Z",
        "created_at": "2016-09-10T23:50:44Z",
        "status": "maturing",
        "amount": 30000,
        "description": "A tandem skydive jump SB23094",
        "from_id": "83623359-e86e-440c-9780-432a3bc3626f",
        "to_id": "21066764-c103-4e7f-b436-4cee7db5f400",
        "category_purpose_code": "PENS",
        "end_to_end_id": "FFC6D34847134E4D8BF4B9B41BDC94C8",
        "metadata": {
          "invoice_ref": "BILL-0001",
          "invoice_id": "c80a9958-e805-47c0-ac2a-c947d7fd778d",
          "custom_key": "Custom string",
          "another_custom_key": "Maybe a URL"
        }
      }
    ],
    "metadata": {
      "custom_key": "Custom string",
      "another_custom_key": "Maybe a URL"
    }
  }
}

Changes