Payouts

View a Payout

Changed on

This endpoint returns basic information about a payout request, without some feature-specific details. Platforms integrating for the first time should use the GET View a Payout and check mode applied endpoint.

<Note icon="fa-regular fa-circle-info"> **Note – Payout data retained for 13 months**

An API call to retrieve a payout whose CreationDate is older than 13 months may return 404 Not Found.

For more information, see the <a href="/api-reference/overview/data-availability-periods">Data availability periods</a> article. </Note>

get/v2.01/{ClientId}/payouts/{PayoutId}

Request

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

Path parameters

ClientIdstring required

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

PayoutIdstring required

The unique identifier of the payout.

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
Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestring

The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.

ResultMessagestring

The explanation of the result code.

ExecutionDateinteger

Unix timestamp (UTC) of the date and time the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.
CreditedWalletIdunknown
DebitedWalletIdstring

The unique identifier of the debited wallet.

PaymentTypestring

Returned values: BANK_WIRE

The payment type of the payout.

BankAccountIdstring

The unique identifier of the bank account.

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.

RecipientIdstring

The unique identifier of the Recipient object to which the payout is being requested. This property should be used by platforms integrating for the first time (and not the BankAccountId).

Changes