​
Description

The Pay by Bank PayIn object allows platforms to process open banking payments, where the user authenticates directly with their bank to confirm the payment. Read more →

​
Attributes

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Tag
string
Max. length: 255 charactersCustom 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.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
AuthorId
string
The unique identifier of the user at the source of the transaction.
​
DebitedFunds
object
Information about the debited funds.
​
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
Fees
object
Information about the fees.
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
ResultCode
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
ResultMessage
string
The explanation of the result code.
​
ExecutionDate
Unix timestamp
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.
​
Type
string
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.
​
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
​
CreditedWalletId
string
The unique identifier of the credited wallet.
​
CreditedUserId
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
​
PaymentType
string
Returned values: PAY_BY_BANKThe type of pay-in.
​
ExecutionType
string
Returned values: WEBThe execution type of the mandate.
​
ReturnURL
string
Max. length: 255 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
​
RedirectURL
string
The URL to which to redirect the user to complete the payment.Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
​
StatementDescriptor
string
Max. length: 10 characters; only alphanumeric and spacesCustom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.
​
Country
string
Allowed values: AT, DE, DK, EE, ES, FI, FR, GB, IE, IT, LV, LT, NL, NO, PL, PT.The country of residence of the user.
​
BIC
string
The BIC of the user’s bank account, which is only returned if it was sent.If both the IBAN and BIC are provided, one of the two authentication steps required by certain banks may be avoided.
​
IBAN
string
The IBAN of the user’s bank account, which is only returned if it was sent.If both the IBAN and BIC are provided, one of the two authentication steps required by certain banks may be avoided.
​
PaymentFlow
string
Allowed values: WEB, APPDefault value: WEBThe platform environment of the post-payment flow. The PaymentFlow value combines with the ReturnURL to manage the redirection behavior after payment:
  • Set the value to APP to send the user to your platform’s mobile app
  • Set the value to WEB to send the user to a web browser
In both cases you need to provide the relevant ReturnURL, whether to your app or website.
​
BankName
string
Allowed values: One of the supported bank names.The name of the bank, which is only returned if it was sent.If the BankName is provided, the user doesn’t have to select their bank when they are redirected.
​
Culture
string
Allowed values: DA, CS, DE, EN, ET, ES, FI, FR, IT, LT, LV, NL, NO, PL, PT, SVDefault value: ENThe language in which the Tink open banking page is to be displayed.
​
Scheme
string
Allowed values: One of the supported schemes for the Country.Default value: The listed instant scheme for the Country. If Country is DK, there is no default and the Scheme must be specified.The scheme to use to process the payment. Note that some banks may charge additional fees to the user for instant payment schemes.
​
ProcessingStatus
string
Possible values: PENDING_SUCCEEDEDParameter that is only returned once the bank wire has been successfully authenticated and initiated by the user but has not yet been received by Mangopay. When the funds are received, the Status changes from CREATED to SUCCEEDED and the ProcessingStatus is no longer returned.For non-instant schemes, processing can take up to 72 hours but is typically completed within 2 days.