Check Instant Payout eligibility

POST

/v2.01/:ClientId/payouts/reachability

Check whether the destination bank is reachable for SCT Inst payouts.

Note – Endpoint only available for SCT Inst payouts in EUR

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

Check whether the destination bank is reachable for SCT Inst payouts. <Note icon="fa-regular fa-circle-info"> **Note – Endpoint only available for SCT Inst payouts in EUR** You can only use this endpoint to check payouts where: - The currency is `EUR` - The `PayoutModeRequested` is `INSTANT_PAYMENT` All other currencies return the [130001](/errors/codes/130001) `UnreachableReason.Code`. </Note>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

PayoutModeRequestedstringRequired

Allowed values: INSTANT_PAYMENT

The mode of payout, which must be INSTANT_PAYMENT on this reachability endpoint, even if your subsequent payout request uses INSTANT_PAYMENT_ONLY.

AuthorIdstringRequired

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.

DebitedFundsobjectRequired

Information about the debited funds.

FeesobjectRequired

Information about the fees.

DebitedWalletIdstringRequired

The unique identifier of the debited wallet.

BankAccountIdstringOptional

The unique identifier of the Bank Account. This property should not be used by platforms integrating for the first time – send the RecipientId instead.

BankWireRefstringOptional

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.

Response

Success

IsReachableboolean

Whether or not the bank is reachable.

UnreachableReasonobject

Information regarding why the bank is unreachable.

Errors

400

Bad Request Error

$	curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payouts/reachability \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"body": {
>	"PayoutModeRequested": "INSTANT_PAYMENT",
>	"AuthorId": "142036728",
>	"DebitedFunds": {
>	"Currency": "EUR",
>	"Amount": 1200
>	},
>	"Fees": {
>	"Currency": "EUR",
>	"Amount": 12
>	},
>	"DebitedWalletId": "145389978",
>	"BankAccountId": "54682154",
>	"BankWireRef": "invoice 7282"
>	}
>	}'

1	{
2	"InstantPayout": {
3	"IsReachable": true,
4	"UnreachableReason": null
5	}
6	}