Create an Multibanco PayIn

{
    "AuthorId": "204068024",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "CreditedWalletId": "204089031",
    "ReturnURL": "http://www.mangopay.com/docs/please-ignore",
    "Tag": "Created using the Mangopay API Postman collection",
    "StatementDescriptor": "Mangopay"
}  

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.mangopay.MangoPayApi;
import com.mangopay.core.Money;
import com.mangopay.core.enumerations.CurrencyIso;
import com.mangopay.core.enumerations.PayInExecutionType;
import com.mangopay.core.enumerations.PayInPaymentType;
import com.mangopay.entities.PayIn;
import com.mangopay.entities.subentities.PayInExecutionDetailsWeb;
import com.mangopay.entities.subentities.PayInPaymentDetailsMultibanco;

public class CreateMultibancoPayIn {
    public static void main(String[] args) throws Exception {
        MangoPayApi mangopay = new MangoPayApi();
        mangopay.getConfig().setClientId("your-client-id");
        mangopay.getConfig().setClientPassword("your-api-key");

        var userId = "user_m_01HT2NFK7Z2BRQNGNHMY30VVTT";
        var walletId = "wlt_m_01HTHTXEF4BJCTKMXNWMSZ6KP5";

        PayIn multibancoPayin = new PayIn();
        multibancoPayin.setPaymentType(PayInPaymentType.MULTIBANCO);
        multibancoPayin.setExecutionType(PayInExecutionType.WEB);
        multibancoPayin.setAuthorId(userId);
        multibancoPayin.setCreditedWalletId(walletId);
        multibancoPayin.setDebitedFunds(new Money(CurrencyIso.EUR, 1000));
        multibancoPayin.setFees(new Money(CurrencyIso.EUR, 0));
        multibancoPayin.setTag("Created using the Mangopay Java SDK");

        PayInPaymentDetailsMultibanco paymentDetails = new PayInPaymentDetailsMultibanco();
        paymentDetails.setStatementDescriptor("Jul2024");
        multibancoPayin.setPaymentDetails(paymentDetails);

        PayInExecutionDetailsWeb executionDetails = new PayInExecutionDetailsWeb();
        executionDetails.setReturnUrl("https://www.mangopay.com/docs/please-ignore");
        multibancoPayin.setExecutionDetails(executionDetails);

        PayIn createMultibancoPayin = mangopay.getPayInApi().create(multibancoPayin);

        Gson prettyPrint = new GsonBuilder().setPrettyPrinting().create();
        String prettyJson = prettyPrint.toJson(createMultibancoPayin);

        System.out.println(prettyJson);
    }
}

from pprint import pprint
import mangopay

mangopay.client_id='your-client-id'
mangopay.apikey='your-api-key'

from mangopay.api import APIRequest
handler = APIRequest(sandbox=True)

from mangopay.resources import NaturalUser, Money, MultibancoPayIn

natural_user = NaturalUser.get('210513027')

multibanco_payin = MultibancoPayIn(
    author_id = natural_user.id,
    credited_wallet_id = '210514820',
    debited_funds = Money(amount=1000, currency='EUR'),
    fees = Money(amount=0, currency='EUR'),
    return_url = 'https://www.mangopay.com/docs/please-ignore',
    statement_descriptor = 'MGP',
    tag = 'Created using Mangopay Python SDK'
)

create_multibanco_payin = multibanco_payin.save()

pprint(create_multibanco_payin)  

using MangoPay.SDK;
using MangoPay.SDK.Core.Enumerations;
using MangoPay.SDK.Entities;
using MangoPay.SDK.Entities.POST;
using Newtonsoft.Json;

class Program
{
    static async Task Main(string[] args)
    {
        MangoPayApi api = new MangoPayApi();

        api.Config.ClientId = "your-client-id";
        api.Config.ClientPassword = "your-api-key";

        var userId = "user_m_01J2TZ261WZNDM0ZDRWGDYA4GN";
        var walletId = "wlt_m_01J30991BXBB7VF28PBS82EWD3";
        var returnUrl = "https://www.mangopay.com/docs/please-ignore/";

        var payIn = new PayInMultibancoWebPostDTO(userId,
            new Money { Amount = 100, Currency = CurrencyIso.EUR },
            new Money { Amount = 20, Currency = CurrencyIso.EUR },
            walletId, returnUrl,
            "Created using the Mangopay .NET SDK", "MGP");

        var createMultibancoPayIn = await api.PayIns.CreateMultibancoWebAsync(payIn);

        string prettyPrint = JsonConvert.SerializeObject(createMultibancoPayIn, Formatting.Indented);
        Console.WriteLine(prettyPrint);
    }
}

{
    "Id": "wt_6a417de9-5f14-4fed-a8f5-abd7faab21a1",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1696942514,
    "AuthorId": "204068024",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "204089031",
    "CreditedUserId": "204068024",
    "PaymentType": "MULTIBANCO",
    "ExecutionType": "WEB",
    "ReturnURL": "http://www.mangopay.com/docs/please-ignore?transactionId=wt_6a417de9-5f14-4fed-a8f5-abd7faab21a1",
    "RedirectURL": "https://r3.girogate.de/ti/dumbdummy?tx=2137942516&rs=gsc5nItfY1gGGgcNnp1DsiioN90OC23j&cs=198796349738e9ee004aa2e45f3a0e3ee1b49f83927253c15080e8ac1120c207",
    "StatementDescriptor": "Mangopay"
}  

POST

v2.01

{ClientId}

payins

payment-methods

multibanco

{
    "AuthorId": "204068024",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "CreditedWalletId": "204089031",
    "ReturnURL": "http://www.mangopay.com/docs/please-ignore",
    "Tag": "Created using the Mangopay API Postman collection",
    "StatementDescriptor": "Mangopay"
}  

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.mangopay.MangoPayApi;
import com.mangopay.core.Money;
import com.mangopay.core.enumerations.CurrencyIso;
import com.mangopay.core.enumerations.PayInExecutionType;
import com.mangopay.core.enumerations.PayInPaymentType;
import com.mangopay.entities.PayIn;
import com.mangopay.entities.subentities.PayInExecutionDetailsWeb;
import com.mangopay.entities.subentities.PayInPaymentDetailsMultibanco;

public class CreateMultibancoPayIn {
    public static void main(String[] args) throws Exception {
        MangoPayApi mangopay = new MangoPayApi();
        mangopay.getConfig().setClientId("your-client-id");
        mangopay.getConfig().setClientPassword("your-api-key");

        var userId = "user_m_01HT2NFK7Z2BRQNGNHMY30VVTT";
        var walletId = "wlt_m_01HTHTXEF4BJCTKMXNWMSZ6KP5";

        PayIn multibancoPayin = new PayIn();
        multibancoPayin.setPaymentType(PayInPaymentType.MULTIBANCO);
        multibancoPayin.setExecutionType(PayInExecutionType.WEB);
        multibancoPayin.setAuthorId(userId);
        multibancoPayin.setCreditedWalletId(walletId);
        multibancoPayin.setDebitedFunds(new Money(CurrencyIso.EUR, 1000));
        multibancoPayin.setFees(new Money(CurrencyIso.EUR, 0));
        multibancoPayin.setTag("Created using the Mangopay Java SDK");

        PayInPaymentDetailsMultibanco paymentDetails = new PayInPaymentDetailsMultibanco();
        paymentDetails.setStatementDescriptor("Jul2024");
        multibancoPayin.setPaymentDetails(paymentDetails);

        PayInExecutionDetailsWeb executionDetails = new PayInExecutionDetailsWeb();
        executionDetails.setReturnUrl("https://www.mangopay.com/docs/please-ignore");
        multibancoPayin.setExecutionDetails(executionDetails);

        PayIn createMultibancoPayin = mangopay.getPayInApi().create(multibancoPayin);

        Gson prettyPrint = new GsonBuilder().setPrettyPrinting().create();
        String prettyJson = prettyPrint.toJson(createMultibancoPayin);

        System.out.println(prettyJson);
    }
}

from pprint import pprint
import mangopay

mangopay.client_id='your-client-id'
mangopay.apikey='your-api-key'

from mangopay.api import APIRequest
handler = APIRequest(sandbox=True)

from mangopay.resources import NaturalUser, Money, MultibancoPayIn

natural_user = NaturalUser.get('210513027')

multibanco_payin = MultibancoPayIn(
    author_id = natural_user.id,
    credited_wallet_id = '210514820',
    debited_funds = Money(amount=1000, currency='EUR'),
    fees = Money(amount=0, currency='EUR'),
    return_url = 'https://www.mangopay.com/docs/please-ignore',
    statement_descriptor = 'MGP',
    tag = 'Created using Mangopay Python SDK'
)

create_multibanco_payin = multibanco_payin.save()

pprint(create_multibanco_payin)  

using MangoPay.SDK;
using MangoPay.SDK.Core.Enumerations;
using MangoPay.SDK.Entities;
using MangoPay.SDK.Entities.POST;
using Newtonsoft.Json;

class Program
{
    static async Task Main(string[] args)
    {
        MangoPayApi api = new MangoPayApi();

        api.Config.ClientId = "your-client-id";
        api.Config.ClientPassword = "your-api-key";

        var userId = "user_m_01J2TZ261WZNDM0ZDRWGDYA4GN";
        var walletId = "wlt_m_01J30991BXBB7VF28PBS82EWD3";
        var returnUrl = "https://www.mangopay.com/docs/please-ignore/";

        var payIn = new PayInMultibancoWebPostDTO(userId,
            new Money { Amount = 100, Currency = CurrencyIso.EUR },
            new Money { Amount = 20, Currency = CurrencyIso.EUR },
            walletId, returnUrl,
            "Created using the Mangopay .NET SDK", "MGP");

        var createMultibancoPayIn = await api.PayIns.CreateMultibancoWebAsync(payIn);

        string prettyPrint = JsonConvert.SerializeObject(createMultibancoPayIn, Formatting.Indented);
        Console.WriteLine(prettyPrint);
    }
}

{
    "Id": "wt_6a417de9-5f14-4fed-a8f5-abd7faab21a1",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1696942514,
    "AuthorId": "204068024",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "204089031",
    "CreditedUserId": "204068024",
    "PaymentType": "MULTIBANCO",
    "ExecutionType": "WEB",
    "ReturnURL": "http://www.mangopay.com/docs/please-ignore?transactionId=wt_6a417de9-5f14-4fed-a8f5-abd7faab21a1",
    "RedirectURL": "https://r3.girogate.de/ti/dumbdummy?tx=2137942516&rs=gsc5nItfY1gGGgcNnp1DsiioN90OC23j&cs=198796349738e9ee004aa2e45f3a0e3ee1b49f83927253c15080e8ac1120c207",
    "StatementDescriptor": "Mangopay"
}  

Note – Timeout after 7 daysThe payment session lasts for 7 days, at which point the pay-in fails automatically if no action has been taken by the user.

Body parameters

string

required

The unique identifier of the user at the source of the transaction.

string

Max. length: 255 charactersCustom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.

object

required

Information about the debited funds.

Show properties

string

required

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the funds.

integer

required

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

object

required

Information about the fees.

Show properties

string

required

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the fees.

integer

required

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

string

required

The unique identifier of the credited wallet.

string

required

Max. length: 255 charactersThe URL to which the user is automatically returned after indicating that they have noted their Multibanco payment reference.

string

Max. length: 10 characters; only alphanumeric and spacesCustom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.

string

The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.

Responses

200 - Created

string

Max length: 128 characters (see data formats for details)The unique identifier of the object.

string

Unix timestamp

The date and time at which the object was created.

string

The unique identifier of the user at the source of the transaction.

object

Information about the debited funds.

Show properties

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the funds.

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

object

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Show properties

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the funds.

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

object

Information about the fees.

Show properties

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the fees.

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

string

Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.

string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

string

The explanation of the result code.

Unix timestamp

The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.

string

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe nature of the transaction, providing more information about the context in which the transaction occurred:

REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.
REPUDIATION – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).
REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).
SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle a lost dispute.

string

The unique identifier of the credited wallet.

string

Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.

string

Returned values: MULTIBANCOThe type of pay-in.

string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.

string

Max. length: 255 charactersThe URL to which the user is automatically returned after indicating that they have noted their Multibanco payment reference.

string

The URL to which to redirect the user to obtain their Multibanco payment reference.Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.

string

{
    "Id": "wt_6a417de9-5f14-4fed-a8f5-abd7faab21a1",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1696942514,
    "AuthorId": "204068024",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "204089031",
    "CreditedUserId": "204068024",
    "PaymentType": "MULTIBANCO",
    "ExecutionType": "WEB",
    "ReturnURL": "http://www.mangopay.com/docs/please-ignore?transactionId=wt_6a417de9-5f14-4fed-a8f5-abd7faab21a1",
    "RedirectURL": "https://r3.girogate.de/ti/dumbdummy?tx=2137942516&rs=gsc5nItfY1gGGgcNnp1DsiioN90OC23j&cs=198796349738e9ee004aa2e45f3a0e3ee1b49f83927253c15080e8ac1120c207",
    "StatementDescriptor": "Mangopay"
}  

{
    "AuthorId": "204068024",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "CreditedWalletId": "204089031",
    "ReturnURL": "http://www.mangopay.com/docs/please-ignore",
    "Tag": "Created using the Mangopay API Postman collection",
    "StatementDescriptor": "Mangopay"
}  

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.mangopay.MangoPayApi;
import com.mangopay.core.Money;
import com.mangopay.core.enumerations.CurrencyIso;
import com.mangopay.core.enumerations.PayInExecutionType;
import com.mangopay.core.enumerations.PayInPaymentType;
import com.mangopay.entities.PayIn;
import com.mangopay.entities.subentities.PayInExecutionDetailsWeb;
import com.mangopay.entities.subentities.PayInPaymentDetailsMultibanco;

public class CreateMultibancoPayIn {
    public static void main(String[] args) throws Exception {
        MangoPayApi mangopay = new MangoPayApi();
        mangopay.getConfig().setClientId("your-client-id");
        mangopay.getConfig().setClientPassword("your-api-key");

        var userId = "user_m_01HT2NFK7Z2BRQNGNHMY30VVTT";
        var walletId = "wlt_m_01HTHTXEF4BJCTKMXNWMSZ6KP5";

        PayIn multibancoPayin = new PayIn();
        multibancoPayin.setPaymentType(PayInPaymentType.MULTIBANCO);
        multibancoPayin.setExecutionType(PayInExecutionType.WEB);
        multibancoPayin.setAuthorId(userId);
        multibancoPayin.setCreditedWalletId(walletId);
        multibancoPayin.setDebitedFunds(new Money(CurrencyIso.EUR, 1000));
        multibancoPayin.setFees(new Money(CurrencyIso.EUR, 0));
        multibancoPayin.setTag("Created using the Mangopay Java SDK");

        PayInPaymentDetailsMultibanco paymentDetails = new PayInPaymentDetailsMultibanco();
        paymentDetails.setStatementDescriptor("Jul2024");
        multibancoPayin.setPaymentDetails(paymentDetails);

        PayInExecutionDetailsWeb executionDetails = new PayInExecutionDetailsWeb();
        executionDetails.setReturnUrl("https://www.mangopay.com/docs/please-ignore");
        multibancoPayin.setExecutionDetails(executionDetails);

        PayIn createMultibancoPayin = mangopay.getPayInApi().create(multibancoPayin);

        Gson prettyPrint = new GsonBuilder().setPrettyPrinting().create();
        String prettyJson = prettyPrint.toJson(createMultibancoPayin);

        System.out.println(prettyJson);
    }
}

from pprint import pprint
import mangopay

mangopay.client_id='your-client-id'
mangopay.apikey='your-api-key'

from mangopay.api import APIRequest
handler = APIRequest(sandbox=True)

from mangopay.resources import NaturalUser, Money, MultibancoPayIn

natural_user = NaturalUser.get('210513027')

multibanco_payin = MultibancoPayIn(
    author_id = natural_user.id,
    credited_wallet_id = '210514820',
    debited_funds = Money(amount=1000, currency='EUR'),
    fees = Money(amount=0, currency='EUR'),
    return_url = 'https://www.mangopay.com/docs/please-ignore',
    statement_descriptor = 'MGP',
    tag = 'Created using Mangopay Python SDK'
)

create_multibanco_payin = multibanco_payin.save()

pprint(create_multibanco_payin)  

using MangoPay.SDK;
using MangoPay.SDK.Core.Enumerations;
using MangoPay.SDK.Entities;
using MangoPay.SDK.Entities.POST;
using Newtonsoft.Json;

class Program
{
    static async Task Main(string[] args)
    {
        MangoPayApi api = new MangoPayApi();

        api.Config.ClientId = "your-client-id";
        api.Config.ClientPassword = "your-api-key";

        var userId = "user_m_01J2TZ261WZNDM0ZDRWGDYA4GN";
        var walletId = "wlt_m_01J30991BXBB7VF28PBS82EWD3";
        var returnUrl = "https://www.mangopay.com/docs/please-ignore/";

        var payIn = new PayInMultibancoWebPostDTO(userId,
            new Money { Amount = 100, Currency = CurrencyIso.EUR },
            new Money { Amount = 20, Currency = CurrencyIso.EUR },
            walletId, returnUrl,
            "Created using the Mangopay .NET SDK", "MGP");

        var createMultibancoPayIn = await api.PayIns.CreateMultibancoWebAsync(payIn);

        string prettyPrint = JsonConvert.SerializeObject(createMultibancoPayIn, Formatting.Indented);
        Console.WriteLine(prettyPrint);
    }
}

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

Create an Multibanco PayIn

Body parameters

Responses

​Body parameters

​Responses

Body parameters

Responses