Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
View a Settlement Transfer
<?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 months
An 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
The unique identifier of the settlement transfer.
Responses
The unique identifier of the object.
Max. length: 255 characters
Custom 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.
The date and time at which the object was created.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
Information about the debited funds. Please note that:
- The
Currencymust be identical to that of the initial transaction. - The
Amountcannot exceed the initial’s transaction minus the fees.
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Information about the fees. Please note that:
- The
Currencymust be identical to that of the initial transaction. - The
Amountcannot exceed the initial’s transaction.
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
The unique identifier of the user at the source of the transaction.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the credited funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
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.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
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.
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”).
The unique identifier of the debited wallet.
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);
}
Was this page helpful?
<?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"
}