Skip to main content
GET
/
v2.01
/
{ClientId}
/
settlements
/
{SettlementId}
<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $settlementTransferId = '199394630';

    $response = $api->Disputes->GetSettlementTransfer($settlementTransferId);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}  

{
    "Id": "159220385",
    "Tag": null,
    "CreationDate": 1672677972,
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 999
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "AuthorId": "146476890",
    "CreditedUserId": null,
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 999
    },
    "Status": "SUCCEEDED",
    "ExecutionDate": 1672677972,
    "Type": "TRANSFER",
    "Nature": "SETTLEMENT",
    "CreditedWalletId": "CREDIT_EUR",
    "DebitedWalletId": "148968396",
    "RepudiationId": "159196330"
}
Note – Settlement transfer data retained for 13 monthsAn API call to retrieve a settlement transfer whose CreationDate is older than 13 months may return 404 Not Found.For more information, see the Data availability periods article.

​
Path parameters

​
SettlementId
string
The unique identifier of the settlement transfer.

​
Responses

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
ResultCode
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
ResultMessage
string
The explanation of the result code.
​
DebitedFunds
object
Information about the debited funds. Please note that:
  • The Currency must be identical to that of the initial transaction.
  • The Amount cannot exceed the initial’s transaction minus the fees.
​
Fees
object
Information about the fees. Please note that:
  • The Currency must be identical to that of the initial transaction.
  • The Amount cannot exceed the initial’s transaction.
​
AuthorId
string
The unique identifier of the user at the source of the transaction.
​
CreditedUserId
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
​
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
ExecutionDate
Unix timestamp
The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.
​
Type
string
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.
​
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
​
CreditedWalletId
string
The unique identifier of the wallet. In the specific case of the Client Wallet object, this value is returned by the Mangopay API in the form of the funds type and the currency (e.g., “FEES_EUR”).
​
DebitedWalletId
string
The unique identifier of the debited wallet.
​
RepudiationId
string
The unique identifier of the repudiation.
{
    "Id": "159220385",
    "Tag": null,
    "CreationDate": 1672677972,
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 999
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "AuthorId": "146476890",
    "CreditedUserId": null,
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 999
    },
    "Status": "SUCCEEDED",
    "ExecutionDate": 1672677972,
    "Type": "TRANSFER",
    "Nature": "SETTLEMENT",
    "CreditedWalletId": "CREDIT_EUR",
    "DebitedWalletId": "148968396",
    "RepudiationId": "159196330"
}  

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $settlementTransferId = '199394630';

    $response = $api->Disputes->GetSettlementTransfer($settlementTransferId);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}