Intergiro developer portal

# Beneficiaries

The Intergiro Business API allows you to effortlessly retrieve the beneficiaries you've previously added. Whenever you initiate a new transaction to a beneficiary, their details are securely stored for your convenience, ensuring seamless access whenever needed.

To manage the saved beneficiaries, you need to access the Beneficiaries tab in the Customer Portal to exclude recipients you no longer need.

TIP

To access beneficiary information through the API, it's important to ensure that your API key is granted the necessary permissions. Your API key should be configured with the Create Payments permission to retrieve the beneficiaries.

# View all beneficiaries

Use GET /v1/beneficiaries to retrieve all your existing beneficiaries, including the beneficiary’s ID, name, bank account details, currency, payment rail and if the beneficiary has trusted status or not.

List beneficiaries request example:

 




GET /v1/beneficiaries

Content-Type: application/json
Authorization: Bearer <access_token>

Response:

 


















HTTP 200 OK

{
    "data": [
        {
            "id": "2191f48a-3d2a-474b-82e7-fa309bd76d43",
            "name": "John Doe",
            "trusted": true,
            "account": {
                "account_bic": "FTCSSESS",
				"account_iban": "SE2697700000010003827446",
				"currency": "EUR",
				"payment_rail": "sepa"
            }
        }
    ],
    "has_more": false
}

# View beneficiary by ID

Alternatively, you can fetch those details for one specific account by providing the account's ID.

Get beneficiary request example:

 




GET /v1/beneficiaries/:id

Content-Type: application/json
Authorization: Bearer <access_token>

Response:

 













HTTP 200 OK

{
    "id": "2191f48a-3d2a-474b-82e7-fa309bd76d43",
    "name": "John Doe",
    "trusted": true,
    "account": {
        "account_bic": "FTCSSESS",
        "account_iban": "SE2697700000010003827446",
        "currency": "EUR",
        "payment_rail": "sepa"
    }
}

# Trusted beneficiaries

trusted indicates whether you can automate transfers through API without a payment authentication step (SCA) or not.

You can mark any beneficiary as 'Trusted' during a payment authentication in the Customer Portal. When one or multiple beneficiaries are marked as 'Trusted', we will not require authentication for future payments to these accounts, facilitating a fully automated payment flow for these beneficiaries.

Filter Trusted beneficiaries

You can use trusted query filter only trusted beneficiaries. For instructions on how to create payments to Trusted Beneficiaries please check Payments.

How to trust a beneficiary

  1. Create any payment via the API and navigate to the API payment approval page in the Customer Portal to authenticate the payment (required step for all payments to ensure compliance to PSD2 SCA regulations).
  2. While processing the payment approval, you will be provided with the option to add those beneficiaries to a trusted list.
  3. If the "Trust beneficiaries" option is enabled during this step, all subsequent payments to these same beneficiaries can proceed directly without the need for authentication.

← Webhooks →