Create an MB WAY PayIn

Note – Timeout after 4 minutes

The payment session lasts for 4 minutes, at which point the pay-in fails automatically if no action has been taken by the user.

Caution – No phone number validation

If the phone number provided is of an accepted format but not valid or not attributed to the corresponding MB WAY user, then the pay-in is created but will fail because the user will not receive a push notification from the MB WAY app.

Body parameters

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.

AuthorId

string

required

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

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.

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.

Phone

string

required

Format: Country code without plus symbol, followed by hash symbol (#), followed by the number; only numeric characters and hash symbol

The phone number of the end user to which the MB WAY push notification is sent to authenticate the transaction.

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 from the Hub for more information.

Responses

string

The unique identifier of the object.

Tag

string

Max. length: 255 characters

CreationDate

timestamp

The date and time at which the object was created.

AuthorId

string

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

DebitedFunds

object

Information about the debited funds.

CreditedFunds

object

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

Fees

object

Information about the fees.

Status

string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCode

string

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

ResultMessage

string

The explanation of the result code.

ExecutionDate

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.

Type

string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Nature

string

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.

CreditedWalletId

string

The unique identifier of the credited wallet.

CreditedUserId

string

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

The unique identifier of the user whose wallet is credited.

PaymentType

string

Returned values: MBWAY

The type of pay-in.

ExecutionType

string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

StatementDescriptor

string

Max. length: 10 characters; only alphanumeric and spaces

Phone

string

Format: Country code without plus symbol, followed by hash symbol (#), followed by the number; only numeric characters and hash symbol

The phone number of the end user to which the MB WAY push notification is sent to authenticate the transaction.

{
    "message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "id": "401918a7-aab9-4b55-b09d-45007b96523d",
    "date": 1696931925,
    "type": "param_error",
    "errors": {
        "phone": "The field must match the regular expression '^\\d{1,5}#\\d{4,11}$'."
    }
}

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses