You are viewing the docs for an old API version (v2) → View v2.01

The Transaction object

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

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

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"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/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/transactions/

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

BeforeDate
timestamp

timestamp
optional

To return only resources that have CreationDate BEFORE this date

AfterDate
timestamp

timestamp
optional

To return only resources that have CreationDate AFTER this date

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)

Nature
TransactionNature

TransactionNature:

REGULAR, REPUDIATION, REFUND, SETTLEMENT
optional

Filter for a specific value

Type
TransactionType

TransactionType:

PAYIN, TRANSFER, PAYOUT
optional

Filter for a specific value

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
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../users/:UserId/transactions/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC",
"BeforeDate": 1463440221,
"AfterDate": 1431817821,
"Status": "CREATED,FAILED",
"Nature": "REGULAR,REFUND",
"Type": "PAYIN,PAYOUT",
"ResultCode": "000000,009199"
}
GET .../users//transactions/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": "",
"BeforeDate": ,
"AfterDate": ,
"Status": "",
"Nature": "",
"Type": "",
"ResultCode": ""
}

List a Wallet's Transactions

GET .../v2/ClientId

The ID of your client account

/wallets/WalletId

The ID of a wallet

/transactions/

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

BeforeDate
timestamp

timestamp
optional

To return only resources that have CreationDate BEFORE this date

AfterDate
timestamp

timestamp
optional

To return only resources that have CreationDate AFTER this date

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)

Nature
TransactionNature

TransactionNature:

REGULAR, REPUDIATION, REFUND, SETTLEMENT
optional

Filter for a specific value

Type
TransactionType

TransactionType:

PAYIN, TRANSFER, PAYOUT
optional

Filter for a specific value

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
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../wallets/:WalletId/transactions/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC",
"BeforeDate": 1463440221,
"AfterDate": 1431817821,
"Status": "CREATED,FAILED",
"Nature": "REGULAR,REFUND",
"Type": "PAYIN,PAYOUT",
"ResultCode": "000000,009199"
}
GET .../wallets//transactions/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": "",
"BeforeDate": ,
"AfterDate": ,
"Status": "",
"Nature": "",
"Type": "",
"ResultCode": ""
}

List a Dispute's Transactions

GET .../v2/ClientId

The ID of your client account

/disputes/DisputeId

The Id of a Dispute

/transactions/

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

BeforeDate
timestamp

timestamp
optional

To return only resources that have CreationDate BEFORE this date

AfterDate
timestamp

timestamp
optional

To return only resources that have CreationDate AFTER this date

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)

Nature
TransactionNature

TransactionNature:

REGULAR, REPUDIATION, REFUND, SETTLEMENT
optional

Filter for a specific value

Type
TransactionType

TransactionType:

PAYIN, TRANSFER, PAYOUT
optional

Filter for a specific value

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
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../disputes/:DisputeId/transactions/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC",
"BeforeDate": 1463440221,
"AfterDate": 1431817821,
"Status": "CREATED,FAILED",
"Nature": "REGULAR,REFUND",
"Type": "PAYIN,PAYOUT",
"ResultCode": "000000,009199"
}
GET .../disputes//transactions/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": "",
"BeforeDate": ,
"AfterDate": ,
"Status": "",
"Nature": "",
"Type": "",
"ResultCode": ""
}

List a Client's Transactions

GET .../v2/ClientId

The ID of your client account

/clients/transactions/

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

BeforeDate
timestamp

timestamp
optional

To return only resources that have CreationDate BEFORE this date

AfterDate
timestamp

timestamp
optional

To return only resources that have CreationDate AFTER this date

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)

Nature
TransactionNature

TransactionNature:

REGULAR, REPUDIATION, REFUND, SETTLEMENT
optional

Filter for a specific value

Type
TransactionType

TransactionType:

PAYIN, TRANSFER, PAYOUT
optional

Filter for a specific value

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
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../clients/transactions/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC",
"BeforeDate": 1463440221,
"AfterDate": 1431817821,
"Status": "CREATED,FAILED",
"Nature": "REGULAR,REFUND",
"Type": "PAYIN,PAYOUT",
"ResultCode": "000000,009199"
}
GET .../clients/transactions/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": "",
"BeforeDate": ,
"AfterDate": ,
"Status": "",
"Nature": "",
"Type": "",
"ResultCode": ""
}

List a Client Wallet's Transactions

GET .../v2/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/

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

BeforeDate
timestamp

timestamp
optional

To return only resources that have CreationDate BEFORE this date

AfterDate
timestamp

timestamp
optional

To return only resources that have CreationDate AFTER this date

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)

Nature
TransactionNature

TransactionNature:

REGULAR, REPUDIATION, REFUND, SETTLEMENT
optional

Filter for a specific value

Type
TransactionType

TransactionType:

PAYIN, TRANSFER, PAYOUT
optional

Filter for a specific value

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
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../clients/wallets/:FundsType/:Currency/transactions/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC",
"BeforeDate": 1463440221,
"AfterDate": 1431817821,
"Status": "CREATED,FAILED",
"Nature": "REGULAR,REFUND",
"Type": "PAYIN,PAYOUT",
"ResultCode": "000000,009199"
}
GET .../clients/wallets///transactions/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": "",
"BeforeDate": ,
"AfterDate": ,
"Status": "",
"Nature": "",
"Type": "",
"ResultCode": ""
}

List a PreAuthorization's Transactions

This list includes PreAuthorized PayIns related to the PreAuthorization. Indeed, if a PreAuthorized PayIn fails, you can re-use the same Preauthorization to create a new PayIn while the PreAuthorization has not expired. As soon as a PreAuthorized Payin has succeeded, you cannot use the PreAuthorization anymore - even if the amount was partial.

GET .../v2/ClientId

The ID of your client account

/preauthorizations/PreAuthorizationId

The ID of a card pre-authorisation

/transactions/

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

  • View
  • Code
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../preauthorizations/:PreAuthorizationId/transactions/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC"
}
GET .../preauthorizations//transactions/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": ""
}

List transactions for a BankAccount

GET .../v2/ClientId

The ID of your client account

/bankaccounts/BankAccountId

The bank account ID of a user

/transactions/

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

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
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../bankaccounts/:BankAccountId/transactions/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC",
"ResultCode": "000000,009199",
"Status": "CREATED,FAILED"
}
GET .../bankaccounts//transactions/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": "",
"ResultCode": "",
"Status": ""
}

List transactions for a Card

GET .../v2/ClientId

The ID of your client account

/cards/CardId

The ID of a card

/transactions/

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

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
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../cards/:CardId/transactions/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC",
"Status": "CREATED,FAILED",
"ResultCode": "000000,009199"
}
GET .../cards//transactions/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": "",
"Status": "",
"ResultCode": ""
}

List transactions for a Mandate

GET .../v2/ClientId

The ID of your client account

 /mandates/MandateId

The ID of a Mandate

/transactions/

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

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
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET ... /mandates/:MandateId/transactions/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC",
"Status": "CREATED,FAILED",
"ResultCode": "000000,009199"
}
GET ... /mandates//transactions/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": "",
"Status": "",
"ResultCode": ""
}
Share feedback