> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paycashless.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Verify payout

> Retrieve a payout by reference



## OpenAPI

````yaml GET /v1/payouts/verify/{reference}
openapi: 3.0.0
info:
  title: Paycashless API
  version: 1.1.0
servers:
  - url: https://api.paycashless.com
    description: Production
security: []
paths:
  /v1/payouts/verify/{reference}:
    get:
      tags:
        - payouts
      description: Retrieve a payout by reference
      parameters:
        - schema:
            type: string
            description: The reference of the payout to verify
          required: true
          description: The reference of the payout to verify
          name: reference
          in: path
        - schema:
            type: string
            minLength: 1
            description: SHA-512 HMAC signature of the request payload using the API secret
            example: >-
              5e73d044c44d733fcf819ad3409aaaddca840d421b69cb0b04e2c750fc62ece7526d36296237663ad1f06f62a730c0466516507196b3ce6567493cc52a7cf63d
          required: true
          description: SHA-512 HMAC signature of the request payload using the API secret
          name: Request-Signature
          in: header
        - schema:
            type: string
            pattern: ^\d{10}$
            description: UNIX timestamp when the request was created (in seconds)
            example: '1712336881'
          required: true
          description: UNIX timestamp when the request was created (in seconds)
          name: Request-Timestamp
          in: header
      responses:
        '200':
          description: Payout retrieved by reference
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  reference:
                    type: string
                  amount:
                    type: integer
                  currency:
                    type: string
                    enum:
                      - NGN
                      - USD
                  status:
                    type: string
                    enum:
                      - pending
                      - succeeded
                      - failed
                      - reversed
                      - sent
                      - cancelled
                  destinationAccountNumber:
                    type: string
                  destinationBankId:
                    type: string
                  fee:
                    type: integer
                  vat:
                    type: integer
                  networkSessionId:
                    type: string
                    nullable: true
                  requiresConfirmation:
                    type: boolean
                  confirmationState:
                    type: string
                    enum:
                      - pending
                      - confirmed
                      - rejected
                  callbackUrl:
                    type: string
                    nullable: true
                  receiptEmail:
                    type: string
                    nullable: true
                  narration:
                    type: string
                    nullable: true
                  metadata:
                    type: object
                    nullable: true
                    additionalProperties:
                      anyOf:
                        - type: string
                        - type: number
                  failureCode:
                    type: string
                    nullable: true
                  failureMessage:
                    type: string
                    nullable: true
                  liveMode:
                    type: boolean
                  initiation:
                    type: object
                    properties:
                      actor:
                        type: string
                        enum:
                          - user
                          - api_key
                      ip:
                        type: string
                        nullable: true
                      user:
                        type: object
                        properties:
                          email:
                            type: string
                            nullable: true
                        required:
                          - email
                      apiKey:
                        type: object
                        properties:
                          description:
                            type: string
                        required:
                          - description
                    required:
                      - actor
                      - ip
                  approval:
                    type: object
                    nullable: true
                    properties:
                      approvedBy:
                        type: string
                      approvedAt:
                        type: string
                        format: date-time
                    required:
                      - approvedBy
                      - approvedAt
                  cancellation:
                    type: object
                    nullable: true
                    properties:
                      cancelledBy:
                        type: string
                      cancelledAt:
                        type: string
                        format: date-time
                    required:
                      - cancelledBy
                      - cancelledAt
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                required:
                  - id
                  - reference
                  - amount
                  - currency
                  - status
                  - destinationAccountNumber
                  - destinationBankId
                  - fee
                  - vat
                  - networkSessionId
                  - requiresConfirmation
                  - confirmationState
                  - callbackUrl
                  - receiptEmail
                  - narration
                  - metadata
                  - failureCode
                  - failureMessage
                  - liveMode
                  - initiation
                  - approval
                  - cancellation
                  - createdAt
                  - updatedAt

````