---
title: "Get a Payment Request"
method: GET
path: "/payment_requests/{payment_request_ref}"
tags: ["Payment Requests"]
---

# Get a Payment Request

`GET /payment_requests/{payment_request_ref}`

## Path parameters

- `payment_request_ref` string, required

## Response `200`

OK

- GetAPaymentRequestResponse
  - `data` object, required
    - `ref` string, required — The Payment Request reference (PR.*) (Min: 4 - Max: 8)
    - `initiator_id` string, uuid, required — Your bank account ID where the funds will settle (Min: 36 - Max: 36)
    - `your_bank_account_id` string, uuid, required — Your bank account ID where the funds will settle (alias of `initiator_id`) (Min: 36 - Max: 36)
    - `authoriser_id` string, uuid, required — The debtor's bank account ID (Min: 36 - Max: 36)
    - `authoriser_contact_id` string, uuid, required — The contact ID representing the debtor within Zepto (Min: 36 - Max: 36)
    - `schedule_ref` string, nullable, required — The schedule that generated the Payment request if applicable (Min: 0 - Max: 8)
    - `status` 'approved' | 'cancelled', required — The status of the Payment Request
    - `status_reason` 'The balance of the nominated bank account for this Payment Request is not available.' | 'The nominated bank account for this Payment Request has insufficient funds.' | 'null', nullable, required — Only used when the `status` is `declined` due to prechecking. (Min: 0 - Max: 280)
    - `matures_at` string, date-time, required — The date-time when the Payment Request is up for processing (Min: 20 - Max: 20)
    - `responded_at` string, date-time, required — The date-time when the Payment Request status changed (Min: 0 - Max: 20)
    - `created_at` string, date-time, required — The date-time when the Payment Request was created (Min: 20 - Max: 20)
    - `credit_ref` string — The resulting credit entry reference (available once approved) (Min: 4 - Max: 8)
    - `payout` object, required
      - `amount` integer, required — Amount in cents (Min: 1 - Max: 99999999999)
      - `description` string, required — Payment Request description (Min: 1 - Max: 280)
      - `matures_at` string, date-time, required — The date-time when the Payment Request is up for processing (Min: 20 - Max: 20)
    - `metadata` object — Your custom keyed data

---

[API](https://skmtc.net/zeptopayments/apis/zepto-api.md) · [All operations](https://skmtc.net/zeptopayments/apis/zepto-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zeptopayments/zepto-api/revisions/6353e9b9af6f/schema)