The Transaction object

Parameters

DebitedFunds
Money

Money:

View Sub-parameters

Information about the funds that are being debited

DebitedFunds.Currency
Currency

Currency:

AED, AUD, CAD, CHF, CZK, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR

The currency - should be ISO_4217 format

DebitedFunds.Amount
int

int

An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)

CreditedFunds
Money

Money:

View Sub-parameters

Details about the funds that are being credited (DebitedFunds – Fees = CreditedFunds)

CreditedFunds.Currency
Currency

Currency:

AED, AUD, CAD, CHF, CZK, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR

The currency - should be ISO_4217 format

CreditedFunds.Amount
int

int

An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)

Fees
Money

Money:

View Sub-parameters

Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)

Fees.Currency
Currency

Currency:

AED, AUD, CAD, CHF, CZK, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR

The currency - should be ISO_4217 format

Fees.Amount
int

int

An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)

DebitedWalletId
string

string:

Maximum length is 255 characters

The ID of the wallet that was debited

CreditedWalletId
string

string:

Maximum length is 255 characters

The ID of the wallet where money will be credited

AuthorId
string

string:

Maximum length is 255 characters

A user's ID

CreditedUserId
string

string:

Maximum length is 255 characters

The user ID who is credited (defaults to the owner of the wallet)

Nature
TransactionNature

TransactionNature:

REGULAR, REPUDIATION, REFUND, SETTLEMENT

The nature of the transaction

Status
TransactionStatus

TransactionStatus:

CREATED, SUCCEEDED, FAILED

The status of the transaction

ExecutionDate
timestamp

timestamp

When the transaction happened

ResultCode
string

string:

Maximum length is 255 characters

The result code

ResultMessage
string

string:

Maximum length is 255 characters

A verbal explanation of the ResultCode

Type
TransactionType

TransactionType:

PAYIN, TRANSFER, PAYOUT

The type of the transaction

{
"DebitedFunds": {
"Currency": "EUR",
"Amount": 12
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 12
},
"Fees": {
"Currency": "EUR",
"Amount": 12
},
"DebitedWalletId": "8519987",
"CreditedWalletId": "8494559",
"AuthorId": "8494514",
"CreditedUserId": "8494514",
"Nature": "REGULAR",
"Status": "SUCCEEDED",
"ExecutionDate": 1463496101,
"ResultCode": "000000",
"ResultMessage": "The transaction was successful",
"Type": "PAYIN"
}

List a User's Transactions

GET .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/transactions/
  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../users/:UserId/transactions/ HTTP/1.1
GET .../users//transactions/ HTTP/1.1

List a Wallet's Transactions

GET .../v2.01/ClientId

The ID of your client account

/wallets/WalletId

The ID of a wallet

/transactions/
  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../wallets/:WalletId/transactions/ HTTP/1.1
GET .../wallets//transactions/ HTTP/1.1

List a Dispute's Transactions

GET .../v2.01/ClientId

The ID of your client account

/disputes/DisputeId

The Id of a Dispute

/transactions/
  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../disputes/:DisputeId/transactions/ HTTP/1.1
GET .../disputes//transactions/ HTTP/1.1

List a Client Wallet's Transactions

GET .../v2.01/ClientId

The ID of your client account

/clients/wallets/FundsType

The type of funds in the wallet

/Currency

The currency - should be ISO_4217 format

/transactions/
  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../clients/wallets/:FundsType/:Currency/transactions/ HTTP/1.1
GET .../clients/wallets///transactions/ HTTP/1.1

List a PreAuthorization's Transactions

This list includes PreAuthorized PayIns related to the PreAuthorization.

GET .../v2.01/ClientId

The ID of your client account

/preauthorizations/PreAuthorizationId

The ID of a card pre-authorisation

/transactions/
  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../preauthorizations/:PreAuthorizationId/transactions/ HTTP/1.1
GET .../preauthorizations//transactions/ HTTP/1.1

List transactions for a BankAccount

GET .../v2.01/ClientId

The ID of your client account

/bankaccounts/BankAccountId

The bank account ID of a user

/transactions/

Get parameters

ResultCode
string

string:

Maximum length is 255 characters
optional

The result code of the transaction (you can filter your transactions list by multiple ResultCode values, each one must be separated by a comma)

Status
TransactionStatus

TransactionStatus:

CREATED, SUCCEEDED, FAILED
optional

The status of the transaction (you can filter your transactions list by multiple Status values, each one must be separated by a comma)

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../bankaccounts/:BankAccountId/transactions/ HTTP/1.1
Get Parameters :
{
"ResultCode": "000000,009199",
"Status": "CREATED,FAILED"
}
GET .../bankaccounts//transactions/ HTTP/1.1
Get Parameters :
{
"ResultCode": "",
"Status": ""
}

List transactions for a Card

GET .../v2.01/ClientId

The ID of your client account

/cards/CardId

The ID of a card

/transactions/

Get parameters

Status
TransactionStatus

TransactionStatus:

CREATED, SUCCEEDED, FAILED
optional

The status of the transaction (you can filter your transactions list by multiple Status values, each one must be separated by a comma)

ResultCode
string

string:

Maximum length is 255 characters
optional

The result code of the transaction (you can filter your transactions list by multiple ResultCode values, each one must be separated by a comma)

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../cards/:CardId/transactions/ HTTP/1.1
Get Parameters :
{
"Status": "CREATED,FAILED",
"ResultCode": "000000,009199"
}
GET .../cards//transactions/ HTTP/1.1
Get Parameters :
{
"Status": "",
"ResultCode": ""
}

List transactions for a Mandate

GET .../v2.01/ClientId

The ID of your client account

 /mandates/MandateId

The ID of a Mandate

/transactions/

Get parameters

Status
TransactionStatus

TransactionStatus:

CREATED, SUCCEEDED, FAILED
optional

The status of the transaction (you can filter your transactions list by multiple Status values, each one must be separated by a comma)

ResultCode
string

string:

Maximum length is 255 characters
optional

The result code of the transaction (you can filter your transactions list by multiple ResultCode values, each one must be separated by a comma)

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET ... /mandates/:MandateId/transactions/ HTTP/1.1
Get Parameters :
{
"Status": "CREATED,FAILED",
"ResultCode": "000000,009199"
}
GET ... /mandates//transactions/ HTTP/1.1
Get Parameters :
{
"Status": "",
"ResultCode": ""
}
Share feedback