Skip to main content

​
Description

The Satispay PayIn object allows platforms to process payments made with the Satispay payment method.
Note – Activation requiredTo activate Satispay for your platform (including Sandbox), contact Mangopay via the Dashboard.

​
Attributes

​
string
The unique identifier of the object.
​
string
Max. length: 255 charactersCustom data that you can add to this object.
​
Unix timestamp
The date and time at which the object was created.
​
string
The unique identifier of the user at the source of the transaction.
​
object
Information about the debited funds.
​
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
object
Information about the fees.
​
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
string
The explanation of the result code.
​
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.
​
string
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.
​
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.
​
string
The unique identifier of the credited wallet.
​
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
​
string
Returned values: SATISPAYThe type of pay-in.
​
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.
​
string
Max. length: 255 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
​
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.
​
string
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of residence of the user, which can be those of the EEA plus CH, GB, and TR.
​
string
The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.

Guide

Learn more about Satispay