Skip to content
glorieux edited this page Aug 2, 2013 · 2 revisions

The Transfer Object

Property Type More
Id Integer
AuthorId Integer
CreditedUserId Integer
DebitedFunds Money Hash { Currency: 'EUR', Amount: 10 }
CreditedFunds Money Hash { Currency: 'EUR', Amount: 10 }
Fees Money Hash { Currency: 'EUR', Amount: 10 }
Status String either ‘CREATED’, ‘SUCCEEDED’ or ‘FAILED'
ResultCode Integer
ExecutionDate Date
DebitedWalletID Integer
CreditedWalletId Integer
Tag String
CreationDate Time

Creating a Transfer

Arguments

  • transfer: A Hash:
    • AuthorId
    • CreditedUserId
    • DebitedFunds
    • Fees
    • DebitedWalletId
    • CreditedWalletId
    • Tag

Results

A Transfer Object

Example

MangoPay::Transfer.create({
  AuthorId: 43233,
  CreditedUserId: 43123,
  DebitedFunds: { Currency: 'EUR', Amount: 500},
  Fees: { Currency: 'EUR', Amout: 0},
  DebitedWalletId: 43244,
  CreditedWalletId: 54341,
  Tag: 'Test Transfer'
})

Retrieving a Transfer

Arguments

  • transfer_id: the id of the transfer you want to fetch

Results

A Transfer Object

Example

MangoPay::Transfer.fetch(434384)

Refunding a Transfer

Arguments

  • transfer_id: the id of the transfer you want to refund
  • refund: A hash:
    • Tag
    • AuthorId
    • DebitedFunds
    • Fees

Returns

A Refund Object

Example

MangoPay::Transfer.refund(430293, {
  AuthorId: 313212
})