Skip to main content
POST
/
v2.01
/
{ClientId}
/
payouts
/
reachability
{
    "PayoutModeRequested":"INSTANT_PAYMENT",
    "AuthorId":"142036728",
    "DebitedFunds":{
        "Currency":"EUR",
        "Amount":1200
    },
    "Fees":{
        "Currency":"EUR",
        "Amount":12
    },
    "DebitedWalletId":"145389978",
    "BankAccountId":"54682154",
    "BankWireRef":"invoice 7282"
}  

{
    "InstantPayout": {
        "IsReachable": true,
        "UnreachableReason": null
    }
}

Documentation Index

Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt

Use this file to discover all available pages before exploring further.

Check whether the destination bank is reachable for SCT Inst payouts.
Note – Endpoint only available for SCT Inst payouts in EURYou can only use this endpoint to check payouts where:
  • The currency is EUR
  • The PayoutModeRequested is INSTANT_PAYMENT
All other currencies return the 130001 UnreachableReason.Code.

​
Body parameters

​
PayoutModeRequested
string
required
Allowed values: INSTANT_PAYMENTThe mode of payout, which must be INSTANT_PAYMENT on this reachability endpoint, even if your subsequent payout request uses INSTANT_PAYMENT_ONLY.
​
AuthorId
string
required
The unique identifier of the user at the source of the transaction.
Best practice: When the payout author is different from the bank account owner, the Payout AuthorId value must be different from the Bank Account UserId value as well. Otherwise, Mangopay’s Compliance team will reject the payout.
​
DebitedFunds
object
required
Information about the debited funds.
​
Fees
object
required
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
​
DebitedWalletId
string
required
The unique identifier of the debited wallet.
​
BankAccountId
string
The unique identifier of the Bank Account. This property should not be used by platforms integrating for the first time – send the RecipientId instead.
​
BankWireRef
string
Max. length: 255 characters (< 12 recommended)Custom description to appear on the user’s bank statement along with the platform name. The recommended length is 12 characters – strings longer than this may be truncated depending on the bank.For the full structure of the string, see the Customizing bank statement references article.

​
Responses

​
IsReachable
boolean
Whether or not the bank is reachable.
​
UnreachableReason
object
Information regarding why the bank is unreachable.
{
    "Message":"One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type":"param_error",
    "Id":"33e27bba-bb56-4d64-8574-cc1916a684c7#1661933575",
    "Date":1661933576.0,
    "errors":{
        "PayoutModeRequested":"InstantPayment is disabled"
    }
}  

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "4b7c9558-d32e-44c0-88e2-d2d006141cc3",
    "Date": 1779263675.0,
    "errors": {
        "PayoutModeRequested": "The specified condition was not met for 'Payout Mode Requested'."
    }
}

{
    "InstantPayout": {
        "IsReachable": true,
        "UnreachableReason": null
    }
}  

{
    "PayoutModeRequested":"INSTANT_PAYMENT",
    "AuthorId":"142036728",
    "DebitedFunds":{
        "Currency":"EUR",
        "Amount":1200
    },
    "Fees":{
        "Currency":"EUR",
        "Amount":12
    },
    "DebitedWalletId":"145389978",
    "BankAccountId":"54682154",
    "BankWireRef":"invoice 7282"
}