Ordo

Ordo Retrieve mandate details API

The Retrieve mandate details API from Ordo — 4 operation(s) for retrieve mandate details.

GitHub OpenAPI

Operations 4

GET /VRPMandate/{mandateId} Retrieves an existing VRP mandate #
GET /VRPMandates Gets all VRP mandates associated with a participant #
GET /VRPTransaction/{vrpTransactionId} Gets a VRP Transaction #
GET /VRPTransactions/{vrpMandateId} Gets VRP Transactions for VRP Mandate and Participant combo #

Documentation

📖
Documentation
https://ordopay.com/products/payments
📖
APIReference
https://docs.myordo.com/docs/introduction-single-payments
📖
Documentation
https://ordopay.com/products/vrp
📖
APIReference
https://docs.myordo.com/docs/introduction-recurring-payment-mandates
📖
Documentation
https://ordopay.com/products/account/data
📖
APIReference
https://docs.myordo.com/docs/introduction-account-data
📖
Documentation
https://ordopay.com/products/account/verify
📖
APIReference
https://docs.myordo.com/docs/client-hosted-account-data
📖
APIReference
https://docs.myordo.com/docs/financial-institution

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ordo/refs/heads/main/openapi/ordo-retrieve-mandate-details-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ordo-retrieve-mandate-details-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ordo-retrieve-mandate-details-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Recurring Payment Mandates Retrieve mandate details API
  version: v1
servers:
- url: https://test.api.ordopay.com/vrp/v1
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: Retrieve mandate details
paths:
  /VRPMandate/{mandateId}:
    get:
      tags:
      - Retrieve mandate details
      summary: Retrieves an existing VRP mandate
      description: Retrieves an existing VRP mandate
      operationId: get-vrpmandate-mandateid
      parameters:
      - name: mandateId
        in: path
        description: VRP Mandate ID
        required: true
        schema:
          type: string
      - name: participantId
        in: header
        description: Format - int32. Format - int32. Format - int32. Participant ID
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/VRPMandateGetResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/VRPMandateGetResponse'
              example:
                vrpMandate:
                  vrpMandateId: string
                  vrpMandateName: string
                  vrpType: SWEEPING
                  createdDate: string
                  status: string
                  validFromDate: string
                  validToDate: string
                  billerParticipantId: 0
                  billerApprovedName: string
                  billerReference: string
                  billerAccountId: string
                  payerParticipantId: 0
                  payerAliasType: EMAIL
                  payerAliasValue: string
                  payerReference: string
                  templateId: string
                  payerRead: true
                  psuAuthenticationMethods: string
                  vrpControlParameters:
                    maximumIndividualAmount: 0
                    maximumIndividualAmountCurrency: string
                    controlParameters:
                    - amount: 0
                      currency: string
                      periodAlignment: string
                      periodType: string
                  updatedDate: string
                  cancelledBy: string
                  refundAccountRequired: true
                vrpURLs:
                  redirectURL: string
                  cancelURL: string
                  errorURL: string
            text/json:
              schema:
                $ref: '#/components/schemas/VRPMandateGetResponse'
              example:
                vrpMandate:
                  vrpMandateId: string
                  vrpMandateName: string
                  vrpType: SWEEPING
                  createdDate: string
                  status: string
                  validFromDate: string
                  validToDate: string
                  billerParticipantId: 0
                  billerApprovedName: string
                  billerReference: string
                  billerAccountId: string
                  payerParticipantId: 0
                  payerAliasType: EMAIL
                  payerAliasValue: string
                  payerReference: string
                  templateId: string
                  payerRead: true
                  psuAuthenticationMethods: string
                  vrpControlParameters:
                    maximumIndividualAmount: 0
                    maximumIndividualAmountCurrency: string
                    controlParameters:
                    - amount: 0
                      currency: string
                      periodAlignment: string
                      periodType: string
                  updatedDate: string
                  cancelledBy: string
                  refundAccountRequired: true
                vrpURLs:
                  redirectURL: string
                  cancelURL: string
                  errorURL: string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
  /VRPMandates:
    get:
      tags:
      - Retrieve mandate details
      summary: Gets all VRP mandates associated with a participant
      description: Gets all VRP mandates associated with a participant
      operationId: get-vrpmandates
      parameters:
      - name: PageNumber
        in: query
        description: Format - int32. Format - int32. Format - int32.
        schema:
          type: integer
          format: int32
      - name: PageSize
        in: query
        description: Format - int32. Format - int32. Format - int32.
        schema:
          type: integer
          format: int32
      - name: participantId
        in: header
        description: Format - int32. Format - int32. Format - int32. Participant ID.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/VRPMandatesResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/VRPMandatesResponse'
              example:
                vrpMandates:
                - vrpMandateId: string
                  vrpMandateName: string
                  vrpType: SWEEPING
                  createdDate: string
                  status: string
                  validFromDate: string
                  validToDate: string
                  billerParticipantId: 0
                  billerApprovedName: string
                  billerReference: string
                  billerAccountId: string
                  payerParticipantId: 0
                  payerAliasType: EMAIL
                  payerAliasValue: string
                  payerReference: string
                  templateId: string
                  payerRead: true
                  psuAuthenticationMethods: string
                  vrpControlParameters:
                    maximumIndividualAmount: 0
                    maximumIndividualAmountCurrency: string
                    controlParameters:
                    - amount: 0
                      currency: string
                      periodAlignment: string
                      periodType: string
                  updatedDate: string
                  cancelledBy: string
                  refundAccountRequired: true
            text/json:
              schema:
                $ref: '#/components/schemas/VRPMandatesResponse'
              example:
                vrpMandates:
                - vrpMandateId: string
                  vrpMandateName: string
                  vrpType: SWEEPING
                  createdDate: string
                  status: string
                  validFromDate: string
                  validToDate: string
                  billerParticipantId: 0
                  billerApprovedName: string
                  billerReference: string
                  billerAccountId: string
                  payerParticipantId: 0
                  payerAliasType: EMAIL
                  payerAliasValue: string
                  payerReference: string
                  templateId: string
                  payerRead: true
                  psuAuthenticationMethods: string
                  vrpControlParameters:
                    maximumIndividualAmount: 0
                    maximumIndividualAmountCurrency: string
                    controlParameters:
                    - amount: 0
                      currency: string
                      periodAlignment: string
                      periodType: string
                  updatedDate: string
                  cancelledBy: string
                  refundAccountRequired: true
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
  /VRPTransaction/{vrpTransactionId}:
    get:
      tags:
      - Retrieve mandate details
      summary: Gets a VRP Transaction
      description: Gets a VRP Transaction
      operationId: get-vrptransaction-vrptransactionid
      parameters:
      - name: vrpTransactionId
        in: path
        description: VRP Transaction ID
        required: true
        schema:
          type: string
      - name: participantId
        in: header
        description: Format - int32. Format - int32. Format - int32. Participant ID
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/VRPTransactionPostResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/VRPTransactionPostResponse'
              example:
                vrpTransaction:
                  vrpTransactionId: string
                  vrpMandateId: string
                  billerParticipantId: 0
                  payerAliasType: EMAIL
                  payerAliasValue: string
                  amount: 0
                  currency: string
                  aspspTransactionId: string
                  paymentDate: string
                  status: string
                  paymentStatus: string
                  billerReference: string
                  createdDate: string
                  updatedDate: string
            text/json:
              schema:
                $ref: '#/components/schemas/VRPTransactionPostResponse'
              example:
                vrpTransaction:
                  vrpTransactionId: string
                  vrpMandateId: string
                  billerParticipantId: 0
                  payerAliasType: EMAIL
                  payerAliasValue: string
                  amount: 0
                  currency: string
                  aspspTransactionId: string
                  paymentDate: string
                  status: string
                  paymentStatus: string
                  billerReference: string
                  createdDate: string
                  updatedDate: string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
  /VRPTransactions/{vrpMandateId}:
    get:
      tags:
      - Retrieve mandate details
      summary: 'Gets VRP Transactions for VRP Mandate

        and Participant combo'
      description: 'Gets VRP Transactions for VRP Mandate

        and Participant combo'
      operationId: get-vrptransactions-vrpmandateid
      parameters:
      - name: vrpMandateId
        in: path
        description: VRP Mandate ID
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: Format - int32. Format - int32. Format - int32. Page size
        schema:
          type: integer
          format: int32
          default: 0
      - name: pageNumber
        in: query
        description: Format - int32. Format - int32. Format - int32. Page number
        schema:
          type: integer
          format: int32
          default: 0
      - name: participantId
        in: header
        description: Format - int32. Format - int32. Format - int32. Participant ID
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/VRPTransactionPostResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/VRPTransactionPostResponse'
              example:
                vrpTransaction:
                  vrpTransactionId: string
                  vrpMandateId: string
                  billerParticipantId: 0
                  payerAliasType: EMAIL
                  payerAliasValue: string
                  amount: 0
                  currency: string
                  aspspTransactionId: string
                  paymentDate: string
                  status: string
                  paymentStatus: string
                  billerReference: string
                  createdDate: string
                  updatedDate: string
            text/json:
              schema:
                $ref: '#/components/schemas/VRPTransactionPostResponse'
              example:
                vrpTransaction:
                  vrpTransactionId: string
                  vrpMandateId: string
                  billerParticipantId: 0
                  payerAliasType: EMAIL
                  payerAliasValue: string
                  amount: 0
                  currency: string
                  aspspTransactionId: string
                  paymentDate: string
                  status: string
                  paymentStatus: string
                  billerReference: string
                  createdDate: string
                  updatedDate: string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
components:
  schemas:
    VRPMandatesResponse:
      type: object
      properties:
        vrpMandates:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VRPMandateResponse'
      additionalProperties: false
    VRPURLs:
      type: object
      properties:
        redirectURL:
          type:
          - string
          - 'null'
        cancelURL:
          type:
          - string
          - 'null'
        errorURL:
          type:
          - string
          - 'null'
      additionalProperties: false
    VRPTransactionPostResponse:
      type: object
      properties:
        vrpTransaction:
          $ref: '#/components/schemas/VRPTransactionResponse'
      additionalProperties: false
    VRPMandateGetResponse:
      type: object
      properties:
        vrpMandate:
          $ref: '#/components/schemas/VRPMandateResponse'
        vrpURLs:
          $ref: '#/components/schemas/VRPURLs'
      additionalProperties: false
    PayerAliasType:
      enum:
      - EMAIL
      - PHONE
      type: string
    VRPMandateResponse:
      type: object
      properties:
        vrpMandateId:
          type:
          - string
          - 'null'
        vrpMandateName:
          type:
          - string
          - 'null'
        vrpType:
          $ref: '#/components/schemas/VRPType'
        createdDate:
          type: string
          format: date-time
        status:
          type:
          - string
          - 'null'
        validFromDate:
          type:
          - string
          - 'null'
          format: date-time
        validToDate:
          type:
          - string
          - 'null'
          format: date-time
        billerParticipantId:
          type: integer
          format: int32
        billerApprovedName:
          type:
          - string
          - 'null'
        billerReference:
          type:
          - string
          - 'null'
        billerAccountId:
          type:
          - string
          - 'null'
        payerParticipantId:
          type: integer
          format: int32
        payerAliasType:
          $ref: '#/components/schemas/PayerAliasType'
        payerAliasValue:
          type:
          - string
          - 'null'
        payerReference:
  

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ordo/refs/heads/main/openapi/ordo-retrieve-mandate-details-api-openapi.yml