> ## Documentation Index > Fetch the complete documentation index at: https://docs2.finverse.com/llms.txt > Use this file to discover all available pages before exploring further. # Get mandate > Retrieve a Mandate object (using a specific `mandate_id`). **Authorization**: `customer_token` ## Response fields Single `Mandate` object, containing information on the Mandate. ### fees (array) Details on the fee(s) to be charged. Returns an empty array if no fees will be charged. ### mandate_details (object) Details describing the mandate. ### payment_schedule (object, optional) RESERVED FOR FUTURE USE - Specifies scheduled auto-payments with the specified amounts and dates. ### transaction_limits (object, optional) Specifies custom limits on payment transactions executed under the Mandate. ### recipient (object), sender (object) The recipient and sender objects include a Payment User object for each of the counterparties of a payment. Refer to the Payment User data model in `GET /payment_users/{payment_user_id}` for details on the Payment User object. Note: Some Payment User metadata fields are omitted for clarity (e.g. `created_at`, `metadata`, `updated_at`). ### recipient_account (object), sender_account (object) The recipient_account and sender_account objects include a Payment Account object for each of the counterparties of a payment. Refer to Payment Account object data model in `GET /payment_users/{user_id}/payment_accounts` for details on the Payment Account object. Note: Some Payment Account metadata fields are omitted for clarity (e.g. `created_at`, `metadata`, `updated_at`). ## OpenAPI ````yaml /api-reference/openapi.json get /mandates/{mandateId} openapi: 3.0.0 info: description: Documentation of the early finverse services title: Finverse Public termsOfService: https://example.com contact: name: Maintainers email: info@finverse.com license: name: unknown license version: 0.0.1 servers: - url: https://api.prod.finverse.net security: - Oauth2: - test tags: - name: public description: Publicly accessible endpoints x-group: Public - name: customer description: Customer app and institution endpoints x-group: Customer - name: link description: Finverse Link flows x-group: Link - name: login_identity description: Login identity lifecycle and metadata x-group: Login identity - name: accounts description: Accounts, balances, and account numbers x-group: Accounts - name: statements description: Statements and composite statements x-group: Statements - name: transactions description: Transaction history x-group: Transactions - name: identity_income description: Identity and income insights x-group: Identity & income - name: payment_links description: Payment link creation and checkout x-group: Payment links - name: mandates description: Direct debit mandates x-group: Mandates - name: payments description: Payment initiation and status x-group: Payment operations - name: payouts description: Payouts and scheduled payouts x-group: Payouts - name: payment_users description: Payment user profiles x-group: Payment users - name: payment_accounts description: Payment accounts for users x-group: Payment accounts - name: payment_methods description: Stored payment methods x-group: Payment methods - name: bills description: Bill presentment x-group: Bills - name: disputes description: Payment disputes x-group: Disputes - name: ledger description: Ledger and statements x-group: Ledger paths: /mandates/{mandateId}: get: tags: - mandates summary: Get mandate description: >- Retrieve a Mandate object (using a specific `mandate_id`). **Authorization**: `customer_token` ## Response fields Single `Mandate` object, containing information on the Mandate. ### fees (array) Details on the fee(s) to be charged. Returns an empty array if no fees will be charged. ### mandate_details (object) Details describing the mandate. ### payment_schedule (object, optional) RESERVED FOR FUTURE USE - Specifies scheduled auto-payments with the specified amounts and dates. ### transaction_limits (object, optional) Specifies custom limits on payment transactions executed under the Mandate. ### recipient (object), sender (object) The recipient and sender objects include a Payment User object for each of the counterparties of a payment. Refer to the Payment User data model in `GET /payment_users/{payment_user_id}` for details on the Payment User object. Note: Some Payment User metadata fields are omitted for clarity (e.g. `created_at`, `metadata`, `updated_at`). ### recipient_account (object), sender_account (object) The recipient_account and sender_account objects include a Payment Account object for each of the counterparties of a payment. Refer to Payment Account object data model in `GET /payment_users/{user_id}/payment_accounts` for details on the Payment Account object. Note: Some Payment Account metadata fields are omitted for clarity (e.g. `created_at`, `metadata`, `updated_at`). operationId: getMandate parameters: - description: mandate id name: mandateId in: path required: true schema: type: string responses: '200': description: Successful content: application/json: schema: $ref: '#/components/schemas/GetMandateResponse' examples: authorization_required: summary: Success (authorization required) value: created_at: '2024-03-28T15:06:10.744Z' fees: [] mandate_details: currency: HKD description: Test Mandate end_date: '2024-12-01' start_date: '2024-03-28' transaction_limits: max_period_amount: 10000 max_period_count: 10 max_transaction_amount: 10000 period: MONTHLY mandate_id: 01HT2SHP6DQJ3A4MTR6V5RVDYR metadata: employer_name: Apple Inc key: value payment_method_id: 01HT2SHPDAFZCHPVCDJ2Z99GX8 recipient: name: Demo App recipient_account: account_id: 01H5VH5YCFDVH80YZ8D0TG3HET account_type: SETTLEMENT_ACCOUNT sender: external_user_id: user_id_1 name: John Doe user_details: - details_type: HK_ID values: - 01HT2SHPCXQNGDGEHTHXTKAB90 user_id: 01GWKTK0380NBRCV1B8D6N0SEH user_type: INDIVIDUAL status: AUTHORIZATION_REQUIRED updated_at: '2024-03-28T15:06:10.730Z' succeeded: summary: Success (succeeded) value: created_at: '2024-03-28T15:04:04.365Z' fees: [] mandate_details: collection_entity_name: Finverse Technologies Limited currency: HKD description: Test Mandate end_date: '2024-12-01' mandate_bank_reference: FV TEAM-MTEW-FV T processor_entity_name: Finverse Technologies Limited start_date: '2024-03-28' transaction_limits: max_period_amount: 10000 max_period_count: 10 max_transaction_amount: 10000 max_transaction_amount_set_by_payer_initial: 5000 period: MONTHLY mandate_id: 01HT2SD8F1CRVSNFCR3R4TD18K metadata: employer_name: Apple Inc key: value payment_method_id: 01HT2SD8NZK60YGMM95AFFJV79 recipient: name: Demo App recipient_account: account_id: 01H5VH5YCFDVH80YZ8D0TG3HET account_type: SETTLEMENT_ACCOUNT sender: external_user_id: user_id_1 name: John Doe user_details: - details_type: HK_ID values: - 01HT2SD8NAETR9JYRNYFZZPECD user_id: 01GWKTK0380NBRCV1B8D6N0SEH user_type: INDIVIDUAL sender_account: account_id: 01HT2SDPDBS8E1RGB8MQAN3EV7 account_number: number: 01HT2SDPK97FE80V0Q1NQBZ562 type: LOCAL account_number_masked: XXX45 account_type: EXTERNAL_ACCOUNT accountholder_name: 01HT2SDPJ3CHRZNX5EBTAERVFF institution_id: testbank-dbs-hk institution_name: Testbank (HK) Payments - Personal user_id: 01GWKTK0380NBRCV1B8D6N0SEH status: SUCCEEDED updated_at: '2024-03-28T15:04:02.660Z' mandate_blocked: summary: Error (mandate blocked) value: fees: [] error: code: PAYMENT_BLOCKED details: >- Sender details do not match expected values. Please try again or contact customer support. error_code: PAYMENT_BLOCKED message: Authorization failed request_id: '{unique_id}' type: PAYMENT_ERROR mandate_details: currency: HKD description: Test Mandate end_date: '2022-12-31' start_date: '2022-11-30' transaction_limits: max_period_amount: 100000 max_period_count: 10 max_transaction_amount: 100000 period: MONTHLY mandate_id: 01GK3440YH7YBX39TEEVKFBK6W metadata: employer_name: Apple Inc key: value recipient: name: Demo App recipient_account: account_id: 01GAFWD2KCVSPSR4P7GPKS3F8M account_type: SETTLEMENT_ACCOUNT sender: external_user_id: user_id_1 name: John Doe user_details: - details_type: HK_ID values: - 01GY2MSEDB1GBP1BA5H31CSEWF user_id: 01GWKTM24X8PFF0QY4M3ABE4D3 user_type: INDIVIDUAL sender_account: account_id: 01GY2MPZ7RV4FPB6D21G554WY8 account_number: number: 01GY2MPZE8XTVNQ5119SNMKGS1 type: LOCAL account_type: EXTERNAL_ACCOUNT accountholder_name: 01GY2MPZDA2A75CA682XWNGVSZ institution_id: testbank-dbs-hk user_id: 01GWKTM24X8PFF0QY4M3ABE4D3 status: FAILED updated_at: '2022-11-30T01:59:51.069Z' sender_account_details_invalid: summary: Error (sender account details invalid) value: fees: [] error: code: MANDATE_SENDER_ACCOUNT_INCORRECT details: '' error_code: MANDATE_SENDER_ACCOUNT_INCORRECT message: The sender's account is incorrect. request_id: '{unique_id}' type: PAYMENT_ERROR mandate_details: currency: HKD description: Test Mandate end_date: '2023-03-01' start_date: '2022-12-03' transaction_limits: max_period_amount: 100000 max_period_count: 10 max_transaction_amount: 100000 period: MONTHLY mandate_id: 01GK3440YH7YBX39TEEVKFBK6W metadata: employer_name: Apple Inc key: value recipient: name: Demo App recipient_account: account_id: 01GAFWD2KCVSPSR4P7GPKS3F8M account_type: SETTLEMENT_ACCOUNT sender: external_user_id: user_id_1 name: John Doe user_details: - details_type: HK_ID values: - 01GY2MSEDB1GBP1BA5H31CSEWF user_id: 01GWKTM24X8PFF0QY4M3ABE4D3 user_type: INDIVIDUAL sender_account: account_id: 01GY2MPZ7RV4FPB6D21G554WY8 account_number: number: 01GY2MPZE8XTVNQ5119SNMKGS1 type: LOCAL account_type: EXTERNAL_ACCOUNT accountholder_name: 01GY2MPZDA2A75CA682XWNGVSZ institution_id: testbank-dbs-hk user_id: 01GWKTM24X8PFF0QY4M3ABE4D3 status: FAILED updated_at: '2022-12-03T04:38:03.139Z' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/ErrBodyModelV2' examples: mandate_not_found: summary: Error (mandate not found) value: error: details: mandate_id not found error_code: RESOURCE_NOT_FOUND message: >- Resource cannot be found. Resource does not exist, has been deleted, or is not accessible. request_id: '{unique_id}' type: API_ERROR '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrBodyModelV2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrBodyModelV2' security: - Oauth2: - mandate:get components: schemas: GetMandateResponse: required: - updated_at - mandate_id - status - recipient - sender - mandate_details properties: created_at: description: Timestamp when the mandate was first created type: string format: date-time error: $ref: '#/components/schemas/FvEmbeddedErrorModel' description: >- Details on why the mandate failed (returned when `status` = `FAILED`). Note: this is used to detail any asynchronous e errors occuring after mandate creation; any synchronous errors (e.g. API validation errors) will instead be returned directly during `POST /mandates`. fees: type: array items: $ref: '#/components/schemas/Fee' description: Details on the fee(s) to be charged mandate_details: $ref: '#/components/schemas/MandateDetailsResponse' description: Details on the mandate mandate_id: description: >- Finverse Mandate ID for this mandate. Always unique. Creating a mandate with different idempotency keys will result in two mandates with different IDs. type: string metadata: description: >- Customer-supplied attributes in key:value format. E.g. `employer_name`: `Apple Inc` type: object additionalProperties: type: string payment_method_id: description: >- Finverse Payment Method ID for this mandate, used to create payments using the mandate (see `POST /`payments). Always unique. Creating a mandate with different idempotency keys will result in two mandates with different IDs. type: string recipient: $ref: '#/components/schemas/MandateRecipient' description: Details on the recipient of the payment recipient_account: $ref: '#/components/schemas/MandateRecipientAccount' description: >- Details on the recipient's account for the payment (i.e. the Customer App's settlement account at Finverse) sender: $ref: '#/components/schemas/GetMandateSender' description: Details on the sender of the payment sender_account: $ref: '#/components/schemas/MandateSenderAccount' description: >- Details on the sender's source institution and account, which is funding the payment status: description: >- Current status of the mandate. Possible values: `AUTHORIZATION_REQUIRED`, `PROCESSING`, `READY_TO_SUBMIT`, `SUBMITTED`, `SUCCEEDED`, `CANCELLED`, `CLOSED`, `FAILED` Note: `CLOSED` occurs when a draft Mandate is created by a Finverse Payment Link (with status `AUTHORIZATION_REQUIRED`), and the user then drops-off or creates a new Payment Method or Mandate. In these cases, Finverse closes the draft Mandate in order to associate a new Payment Method / Mandate with the same Payment Link. type: string enum: - AUTHORIZATION_REQUIRED - AUTHORIZING - PROCESSING - SUBMITTED - SUCCEEDED - FAILED - REVOKED updated_at: description: Timestamp of the last update to the mandate's record type: string format: date-time ErrBodyModelV2: properties: error: $ref: '#/components/schemas/FvErrorModelV2' FvEmbeddedErrorModel: required: - type - error_code - message - details properties: details: type: string error_code: type: string example: CREDENTIALS_INVALID message: type: string type: description: The error type type: string enum: - LINK_ERROR - API_ERROR example: LINKING_ERROR Fee: required: - amount properties: amount: description: Amount of the fee (in minor currency unit) type: integer example: 100 currency: type: string example: HKD description: Currency of the fee (e.g. HKD) paid_by: type: string enum: - RECIPIENT - SENDER example: RECIPIENT description: >- Party who will be charged the fee. Possible values: `RECIPIENT`, `SENDER` paid_by_account_id: description: >- Finverse Payment Account ID of the party who will be charged the fee. This references the `account_id` of either the `recipient_account` or the `sender_account`. type: string example: The payment account ID MandateDetailsResponse: required: - currency properties: collection_entity_name: type: string description: >- Name of the legal entity directly collecting the payment. This name may be displayed to users in the Finverse UI and in email notifications and in the sender's bank statements. For direct debit payments directly collected by the merchant (e.g. SG eGIRO payments), `collection_entity_name` is typically the merchant's legal entity name, configured by Finverse during customer onboarding. Contact [support@finverse.com](mailto:support@finverse.com) to configure your merchant details. For direct debit payments collected through Finverse (e.g. HK eDDA payments), `collection_entity_name` will be the same as `processor_entity_name` currency: description: Currency of the mandate (e.g. HKD) type: string dda_reference: description: >- Unique reference ID for the Direct Debit Authorization registered with the user's bank. The user's bank may quote this reference in notifications to the user, and in direct debit payment records on the user's bank statements. type: string description: description: User-facing description for the mandate type: string end_date: description: >- Expiration date of the mandate, e.g. `2022-12-31`. Payment requests will be allowed up to this date (inclusive). All date inputs assume UTC times (e.g. if `end_date` = `2022-12-31`, then a payment will be allowed until 2022-12-31 at 23:59:59 UTC). `end_date` must be equal to or greater than `start_date` (in UTC). type: string format: date nullable: true mandate_bank_reference: description: >- Bank-generated reference for the mandate, usually shown to senders on their bank notifications or statements. Only returned once mandate has been processed successfully by the sender's bank (i.e. mandate `status`\= `SUCCESSFUL`). type: string payment_schedule: $ref: '#/components/schemas/PaymentSchedule' description: RESERVED FOR FUTURE USE - Specifies scheduled auto-payments processor_entity_name: type: string description: >- Name of the payment processor (if any) through which the payment is collected. This name may be displayed to users in the Finverse UI, in email notifications and in the sender's bank statements. For direct debit payments directly collected by the merchant (e.g. SG eGIRO payments), no `processor_entity_name` is returned. For direct debit payments collected through Finverse (e.g. HK eDDA payments), `processor_entity_name` will be Finverse's legal entity name. start_date: description: >- Start date of the mandate, e.g. `2022-06-01`. Payment requests will be allowed from this date onwards (inclusive). All date inputs assume UTC times (e.g. if `start_date` = `2022-06-01`, then a payment will be allowed starting from 2022-06-01 at 00:00:00 UTC). `start_date` must be equal to or greater than today's date (in UTC). type: string format: date nullable: true transaction_limits: $ref: '#/components/schemas/TransactionLimitsResponse' description: Specifies custom limits per payment transaction MandateRecipient: required: - name properties: name: description: Merchant account name type: string MandateRecipientAccount: required: - account_id - account_type properties: account_id: description: Merchant account ID assigned by Finverse type: string account_type: description: Type of recipient account. type: string enum: - EXTERNAL_ACCOUNT - SETTLEMENT_ACCOUNT example: SETTLEMENT_ACCOUNT GetMandateSender: required: - user_id - external_user_id - user_type properties: external_user_id: description: >- Customer App's user ID, representing the end-user making the payment. type: string name: type: string user_details: description: Sender details which will be used for fraud checking. type: array items: $ref: '#/components/schemas/SenderDetail' user_id: description: A unique identifier generated after creating sender type: string user_type: description: >- Type of account held by the Sender at the Institution. Possible values are INDIVIDUAL, BUSINESS type: string enum: - INDIVIDUAL - BUSINESS MandateSenderAccount: type: object properties: account_id: description: A unique identifier generated after creating sender account type: string example: sender_account_id account_number: $ref: '#/components/schemas/RecipientAccountNumber' description: Bank account number details, including account number in plaintext account_number_masked: description: Masked Account number of the sender’s account type: string account_type: description: Type of sender account. type: string enum: - EXTERNAL_ACCOUNT example: EXTERNAL_ACCOUNT accountholder_name: description: Tokenized accountholder name of the sender's account type: string example: 01EP4A1MZDHKETZFRPF0K62S6S accountholder_name_plaintext: description: Accountholder name in plaintext. type: string example: Chan Li Pak nullable: true bank_code: type: string institution_id: description: Finverse Institution ID for the sender’s institution. type: string example: hsbc-hk institution_name: description: Institution Name for the sender’s institution. type: string example: HSBC metadata: description: >- Additional attributes of the sender account in key:value format (e.g. sender_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 1000 characters respectively. type: object additionalProperties: type: string user_id: description: >- A unique identifier generated after creating sender (Finverse Payment User ID) type: string example: 01GY6H0JA7BS8EVGY56NSHFX2E FvErrorModelV2: required: - type - error_code - message - details - request_id properties: details: type: string error_code: type: string example: CREDENTIALS_INVALID message: type: string request_id: description: The request_id provided in the request header type: string type: description: The error type type: string enum: - LINK_ERROR - API_ERROR example: LINKING_ERROR PaymentSchedule: required: - amount - frequency properties: amount: description: Amount of the scheduled payment in major currency type: integer example: 100 frequency: description: >- Frequency of the scheduled payment. Possible values: `DAILY`, `WEEKLY`, `MONTHLY` type: string enum: - DAILY - WEEKLY - MONTHLY - QUARTERLY - YEARLY TransactionLimitsResponse: properties: max_period_amount: description: >- Maximum cumulative amount (in minor currency unit) of payment transactions (for the specified `period` unit) type: integer minimum: 1 max_period_count: description: >- Maximum number of payment transactions (for the specified `period` unit) type: integer minimum: 1 max_transaction_amount: description: >- Maximum amount per single payment transaction, set by your Customer App (in minor currency units). Note: to avoid your Customer App triggering over-limit payments, Finverse will block any `POST /payments` requests exceeding the `max_transaction_amount` Banks may separately apply their own per transaction limit (see `max_transaction_amount_set_by_payer_initial` below) type: integer minimum: 1 max_transaction_amount_set_by_payer_initial: description: >- Maximum amount per single payment transaction, optionally set by the end-user at the time of direct debit mandate creation, e.g. for eGIRO in Singapore (in minor currency units). Note: Finverse will attempt to submit `POST /payments` requests to banks even when the payment amount exceeds this limit, however you should expect the end-user's bank will reject over-limit payemnt requests, unless the user directly updates their limit through their bank (e.g. through their bank's internet banking portal > eGIRO management page). Finverse separately applies its own per transaction limit (see `max_transaction_limit` above) type: integer nullable: true period: description: Returned if `max_period_amount` or `max_period_count` are set. type: string enum: - DAILY - WEEKLY - MONTHLY - QUARTERLY - YEARLY nullable: true SenderDetail: properties: details_type: description: >- Type of the user identity information submitted. Possible values: `HK_ID`, `PASSPORT`, `HK_BUSINESS_REGISTRATION`, `HK_CERTIFICATE_OF_INCORPORATION`, `ACCOUNTHOLDER_NAME` type: string enum: - HK_ID - PASSPORT - HK_BUSINESS_REGISTRATION - HK_CERTIFICATE_OF_INCORPORATION values: description: >- Value(s) of the user identity information submitted. Min 1 value required, max 10 values. Values in responses are tokenized by Finverse. type: array maxItems: 10 items: type: string RecipientAccountNumber: type: object required: - type - number properties: number: description: >- Account number. Account numbers in responses are tokenized by Finverse. type: string maxLength: 100 minLength: 1 number_plaintext: description: Account number in plaintext type: string maxLength: 100 minLength: 1 nullable: true type: description: 'Type of account number format. Possible values: `IBAN`, `LOCAL`' type: string enum: - LOCAL - IBAN securitySchemes: Oauth2: type: oauth2 flows: clientCredentials: tokenUrl: https://finverse-dev.us.auth0.com/oauth/token scopes: account: Account balance: Balance credit: Credit institution: Institution investment: Investment link: Link test: Test transaction: Transaction ````