Get details of a mandate

get/payment-provider-mandates/{paymentMethod}/{mandate_reference}

Get details of a mandate for a given payment provider

SecuritybearerAuth
Request
path Parameters
paymentMethod
required
string (PaymentMethod)

Payment Method

Enum: "CHEQUE" "DIRECT_DEBIT" "CANCELLED_DD" "CREDIT_CARD" "PAYPAL" "BACS" "POST_OFFICE_PAYMENT_CARD" "EZYPAY" "GO_CARDLESS" "GC_INSTANT_BANK_PAYMENTS" "STRIPE" "FINASTRA" "FAST_PAY" "OTHER"
mandate_reference
required
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Mandate reference

query Parameters
contractOwnerId
integer <int64> (IdParam) >= 1

Filter by contract owner id

Example: contractOwnerId=1
Responses
200

Payment provider mandate

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Response samples
application/json
{
  • "mandateReference": "string",
  • "createdAt": "string",
  • "emailAddress": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "companyName": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "addressLine3": "string",
  • "city": "string",
  • "region": "string",
  • "postcode": "string",
  • "countryCode": "string",
  • "telephoneNumber": "string",
  • "status": "NEW"
}