Check Instant Payout eligibility
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
PayoutModeRequestedisINSTANT_PAYMENT
All other currencies return the 130001 UnreachableReason.Code.
Authentication
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.
Path parameters
Request
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.
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 Recipient UserId value as well. Otherwise, Mangopay's Compliance team will reject the payout.
The unique identifier of the Bank Account. This property should not be used by platforms integrating for the first time – send the RecipientId instead.
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
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, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".
Unix timestamp (UTC) of the date and time the object was created.
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 Recipient UserId value as well. Otherwise, Mangopay's Compliance team will reject the payout.
For a payout, the CreditedUserId is always null as the funds are being paid out of the Mangoapy environment.