v1

latestOpenAPI 3.1.02026-07-2469193340.0 KB

Payment Requests

Request Payment

<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 a duplicate funds collection. To understand more on how to make idempotent requests, please refer to our <a href="https://docs.zeptopayments.com/v20260101/reference/idempotent-requests">Idempotent requests guide</a>.</aside>

post/payment_requests

Headers

Idempotency-Keystring required

Idempotency key to support safe retries for 24h

Request body

descriptionstring required

Description visible to the initiator (payee). The first 9 characters supplied will be visible to the authoriser (payer)

matures_atstring date-time required

Date & time in UTC ISO8601 that the Payment will be processed if the request is approved. (If the request is approved after this point in time, it will be processed straight away)

amountinteger required

Amount in cents to pay the initiator (Min: 1 - Max: 99999999999)

authoriser_contact_idstring required

The Contact the payment will be requested from (Contact.data.id)

your_bank_account_idstring uuid

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

metadataobject

Use for your custom data and certain Zepto customisations. Stored against generated transactions and included in associated webhook payloads.

Example request

{
  "description": "Visible to both initiator and authoriser",
  "matures_at": "2016-12-19 02:10:56 UTC",
  "amount": 99000,
  "authoriser_contact_id": "de86472c-c027-4735-a6a7-234366a27fc7",
  "your_bank_account_id": "9c70871d-8e36-4c3e-8a9c-c0ee20e7c679",
  "metadata": {
    "custom_key": "Custom string",
    "another_custom_key": "Maybe a URL"
  }
}

Response

Created

Example response

{
  "data": {
    "ref": "PR.39p1",
    "initiator_id": "ca7bc5b3-e47f-4153-96fb-bbe326b42772",
    "your_bank_account_id": "9c70871d-8e36-4c3e-8a9c-c0ee20e7c679",
    "authoriser_id": "970e4526-67d9-4ed9-b554-f5cf390ab775",
    "authoriser_contact_id": "de86472c-c027-4735-a6a7-234366a27fc7",
    "contact_initiated": false,
    "schedule_ref": null,
    "status": "approved",
    "status_reason": null,
    "matures_at": "2021-12-25T00:00:00Z",
    "responded_at": null,
    "created_at": "2021-12-19T02:10:56Z",
    "credit_ref": null,
    "payout": {
      "amount": 99000,
      "description": "Premium Package for 4",
      "matures_at": "2021-12-25T00:00:00Z"
    },
    "metadata": {
      "custom_key": "Custom string",
      "another_custom_key": "Maybe a URL"
    }
  }
}