The Multibanco PayIn object

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Max. length: 255 characters

Custom data that you can add to this object.

Unix timestamp (UTC) of the date and time the object was created.

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

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

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

Unix timestamp (UTC) of the date and time the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

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

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

The unique identifier of the user whose wallet is credited.

Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).

If the FlowDescriptor.Beneficiaries is sent in the API request, then:

• The transaction’s CreditedWalletId holder is disregarded in KYC/KYB checks.
• ALL UserId values in the array must be one of:
  • OWNER whose KYCLevel is REGULAR
  • PLATFORM

The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:

• PAYER
• OWNER whose KYCLevel is LIGHT

If the FlowDescriptor.Beneficiaries is not sent in the API request, then the CreditedWalletId holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the CreditedWalletId holder is a PAYER or the same value as one of the FlowDescriptor.Beneficiaries.

Returned values: MULTIBANCO

The payment type of the pay-in.

Returned values: WEB

The execution type of the pay-in.

Max. length: 255 characters

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

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.

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.