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


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

The 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

​
AuthorId
string
required

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

​
Tag
string

Max. length: 255 characters

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

​
DebitedFunds
object
required

Information about the debited funds.

​
Fees
object
required

Information about the fees.

​
CreditedWalletId
string
required

The unique identifier of the credited wallet.

​
ReturnURL
string
required

Max. length: 255 characters

The URL to which the user is automatically returned after indicating that they have noted their Multibanco payment reference.

​
StatementDescriptor
string

Max. length: 10 characters; only alphanumeric and spaces

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

​
ProfilingAttemptReference
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


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

Was this page helpful?

The Multibanco PayIn objectView a PayIn (Multibanco)