# Get details of a mandate

Get details of a mandate for a given payment provider

Endpoint: GET /payment-provider-mandates/{paymentMethod}/{mandateReference}
Version: 1.37
Security: bearerAuth

## Path parameters:

  - `paymentMethod` (string, required)
    Payment Method
    Enum: "CHEQUE", "DIRECT_DEBIT", "CANCELLED_DD", "CANCELLED_CARD", "CREDIT_CARD", "PAYPAL", "BACS", "POST_OFFICE_PAYMENT_CARD", "EZYPAY", "GO_CARDLESS", "GC_INSTANT_BANK_PAYMENTS", "STRIPE", "STRIPE_CARD", "STRIPE_DD", "FINASTRA", "FAST_PAY", "OTHER"

  - `mandateReference` (string, required)
    Mandate reference

## Query parameters:

  - `thirdPartyCustomerReference` (string)
    Reference to a customer in a third party system. For example, Stripe Customer ID (mandatory if a Stripe mandate is provided), or optional references like GO_CARDLESS Customer Reference or FINASTRA Account Number

  - `contractOwnerId` (integer)
    Filter by contract owner id
    Example: 1

## Response 200 fields (application/json):

  - `mandateReference` (string, required)
    Mandate reference. If GO_CARDLESS, only accepted Created, Pending Submission, Submitted, Active, Reinstated, Customer approval granted and Customer approval skipped

  - `thirdPartyCustomerReference` (string)
    Reference to a customer in a third party system. For example, Stripe Customer ID (mandatory if a Stripe mandate is provided), or optional references like GO_CARDLESS Customer Reference or FINASTRA Account Number

  - `createdAt` (string)
    Created at

  - `emailAddress` (string)
    Email address

  - `firstName` (string)
    First name

  - `lastName` (string)
    Last name

  - `companyName` (string)
    Company name

  - `addressLine1` (string)
    Address line 1

  - `addressLine2` (string)
    Address line 2

  - `addressLine3` (string)
    Address line 3

  - `city` (string)
    City

  - `region` (string)
    Region

  - `postcode` (string)
    Postcode

  - `countryCode` (string)
    Country code

  - `telephoneNumber` (string)
    Telephone number

  - `status` (string)
    Invoice payment status
    Enum: "NEW", "INACTIVE", "CREATED", "CUSTOMER_APPROVAL_GRANTED", "CUSTOMER_APPROVAL_SKIPPED", "ACTIVE", "CANCELLED", "FAILED", "TRANSFERRED", "EXPIRED", "SUBMITTED", "RESUBMISSION_REQUESTED", "PENDING_SUBMISSION", "REINSTATED", "REPLACED", "PENDING_CUSTOMER_APPROVAL", "CONSUMED", "BLOCKED", "UNKNOWN"


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields