Get mandate

curl --request GET \
  --url https://api.prod.finverse.net/mandates/{mandateId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.finverse.net/mandates/{mandateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.finverse.net/mandates/{mandateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.finverse.net/mandates/{mandateId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.finverse.net/mandates/{mandateId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
}

Mandates

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).

GET

mandates

{mandateId}

Get mandate

curl --request GET \
  --url https://api.prod.finverse.net/mandates/{mandateId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.finverse.net/mandates/{mandateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.finverse.net/mandates/{mandateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.finverse.net/mandates/{mandateId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.finverse.net/mandates/{mandateId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

mandateId

string

required

mandate id

Response

Successful

mandate_details

object

required

Details on the mandate

Show child attributes

mandate_id

string

required

Finverse Mandate ID for this mandate. Always unique. Creating a mandate with different idempotency keys will result in two mandates with different IDs.

recipient

object

required

Details on the recipient of the payment

Show child attributes

sender

object

required

Details on the sender of the payment

Show child attributes

status

enum<string>

required

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.

Available options:

AUTHORIZATION_REQUIRED,

AUTHORIZING,

PROCESSING,

SUBMITTED,

SUCCEEDED,

FAILED,

REVOKED

updated_at

string<date-time>

required

Timestamp of the last update to the mandate's record

created_at

string<date-time>

Timestamp when the mandate was first created

error

object

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.

Show child attributes

fees

object[]

Details on the fee(s) to be charged

Show child attributes

metadata

object

Customer-supplied attributes in key:value format. E.g. employer_name: Apple Inc

Show child attributes

payment_method_id

string

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.

recipient_account

object

Details on the recipient's account for the payment (i.e. the Customer App's settlement account at Finverse)

Show child attributes

sender_account

object

Details on the sender's source institution and account, which is funding the payment

Show child attributes