Payouts

Check Instant Payout eligibility

Changed on

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 UnreachableReason.Code. </Note>

post/v2.01/{ClientId}/payouts/reachability

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/payouts/reachability
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

Request body

PayoutModeRequestedstring required

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.

AuthorIdstring 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 Recipient UserId value as well. Otherwise, Mangopay's Compliance team will reject the payout.

DebitedWalletIdstring required

The unique identifier of the debited wallet.

BankAccountIdstring

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

BankWireRefstring

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 <a href="/bank-statements">Customizing bank statement references</a> article.

Response

Success

Idstring

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

The unique identifier of the object.

Tagstring

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}".

CreationDateinteger

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

AuthorIdstring

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.

CreditedUserIdunknown

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id check_instant_payout_eligibility removed and replaced with payouts_check_instant_payout_eligibility