The PayIn object
The table below describes the different PayIn methods available with the MANGOPAY API, and which capabilities are available for each. Note that for certain card payments, there may be an extra step for 3D-Secure to be completed - you can read more about the triggers for this step here.
The appropriate test cards/data can be found here.
PayIn Web | PayIn Direct | 3DSecure | Refund | Currency | Payment Type | |
---|---|---|---|---|---|---|
CB/Visa/Mastercard ![]() |
Yes | Yes | Yes | Yes | All | Card |
Maestro ![]() |
Yes | Yes | Always 3DS | Yes | EUR | Card |
Diners ![]() |
Yes | Yes | No | Yes | EUR | Card |
MasterPass ![]() |
Yes | No | No | Yes | All | Card |
Przelewy24 ![]() |
Yes | No | No | Yes | PLN | Card |
iDeal ![]() |
Yes | No | No | Yes | EUR | Card |
Bancontact/Mister Cash ![]() |
Yes | Yes | Always 3DS | Yes | EUR | Card |
PayLib ![]() |
Yes | No | No | Yes | EUR | Card |
Sofort ![]() |
Yes | No | No | Yes | EUR | Direct Debit |
Giropay ![]() |
Yes | No | No | Yes | EUR | Direct Debit |
Direct Debit ![]() |
No | Yes | No | Yes | EUR/GBP | Direct Debit |
Bankwire ![]() |
No | Yes | No | No | All | Bankwire |
Parameters
Id
string:
Maximum length is 255 characters
The item's ID
CreationDate
timestamp
When the item was created
Tag
string:
Maximum length is 255 characters
Custom data that you can add to this item
DebitedFunds
Money:
View Sub-parameters
Information about the funds that are being debited
DebitedFunds.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
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:
View Sub-parameters
Details about the funds that are being credited (DebitedFunds – Fees = CreditedFunds)
CreditedFunds.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
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:
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:
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
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:
Maximum length is 255 characters
The ID of the wallet that was debited
CreditedWalletId
string:
Maximum length is 255 characters
The ID of the wallet where money will be credited
AuthorId
string:
Maximum length is 255 characters
A user's ID
CreditedUserId
string:
Maximum length is 255 characters
The user ID who is credited (defaults to the owner of the wallet)
Nature
TransactionNature:
REGULAR, REPUDIATION, REFUND, SETTLEMENT
The nature of the transaction
Status
TransactionStatus:
CREATED, SUCCEEDED, FAILED
The status of the transaction
ExecutionDate
timestamp
When the transaction happened
ResultCode
string:
Maximum length is 255 characters
The result code
ResultMessage
string:
Maximum length is 255 characters
A verbal explanation of the ResultCode
Type
TransactionType:
PAYIN, TRANSFER, PAYOUT
The type of the transaction
PaymentType
PayInPaymentType:
CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIRE
The payment type of the payin
The type of pay-in
ExecutionType
PayInExecutionType:
WEB, DIRECT, EXTERNAL_INSTRUCTION
The execution type of the payin
The type of execution for the payin