Create a PayPal PayIn

Body parameters

Tag

string

Max. length: 255 characters

Custom 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.

AuthorId

string

required

The unique identifier of the user at the source of the transaction.

DebitedFunds

object

required

Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.

Fees

object

required

Information about the fees.

CreditedWalletId

string

required

The unique identifier of the credited wallet.

ReturnURL

string

required

Max. length: 255 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

StatementDescriptor

string

Max. length: 10 characters; only alphanumeric and spaces

Custom 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.

Shipping

object

Required if ShippingPreference is SET_PROVIDED_ADDRESS.

Information about the end user’s shipping address, managed by ShippingPreference.

LineItems

array

required

object

Information about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount (negative amounts not allowed).

Culture

string

Allowed values: One of the supported languages in the ISO 639-1 format: AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.

The language in which the PayPal payment page is to be displayed.

ShippingPreference

string

Allowed values: SET_PROVIDED_ADDRESS, GET_FROM_FILE, NO_SHIPPING

Information about the shipping address behavior on the PayPal payment page:

SET_PROVIDED_ADDRESS - The address provided in the Shipping parameter is displayed and is not editable. If this value is sent, the Shipping parameter is required.
GET_FROM_FILE – The Shipping parameter is ignored and the end user can choose from registered addresses.
NO_SHIPPING – No shipping address section is displayed.

Reference

string

Max. length: 127 characters (truncated after)

The platform’s order reference for the transaction.

ProfilingAttemptReference

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 from the Hub for more information.

Responses

string

The unique identifier of the object.

Tag

string

Max. length: 255 characters

CreationDate

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. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.

CreditedFunds

object

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Fees

object

Information about the fees.

Status

string

Returned values: CREATED, SUCCEEDED, FAILED

The 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

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, PAYOUT

The type of the transaction.

Nature

string

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The 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.

PaymentType

string

Returned values: PAYPAL

The type of pay-in.

ExecutionType

string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

ReturnURL

string

Max. length: 255 characters

The 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 spaces

Shipping

object

Information about the end user’s shipping address, managed by ShippingPreference.

LineItems

array

object

Information about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount (negative amounts not allowed).

Culture

string

Returned values: One of the supported languages in the ISO 639-1 format: AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.

The language in which the PayPal payment page is to be displayed.

ShippingPreference

string

Returned values: SET_PROVIDED_ADDRESS, GET_FROM_FILE, NO_SHIPPING

Information about the shipping address behavior on the PayPal payment page:

SET_PROVIDED_ADDRESS - The address provided in the Shipping parameter is displayed and is not editable. If this value is sent, the Shipping parameter is required.
GET_FROM_FILE – The Shipping parameter is ignored and the end user can choose from registered addresses.
NO_SHIPPING – No shipping address section is displayed.

PaypalBuyerAccountEmail

string

The email address registered on the PayPal account used to make the payment.

Reference

string

Max. length: 127 characters (truncated after)

The platform’s order reference for the transaction.

Trackings

array

object

Shipping information of the LineItems added to the pay-in object.

CancelURL

string

The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the RedirectURL.

PaypalOrderID

string

PayPal’s unique identifier for the order.

BuyerCountry

string

The country of the buyer.

BuyerFirstname

string

The first name of the buyer.

BuyerPhone

string

The mobile phone number of the buyer.

BuyerLastname

string

The last name of the buyer.

PaypalPayerID

string

The PayPal identifier of the buyer.

{
    "message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "id": "ec5265c3-4c41-47fe-a7f5-5f6bfc6cc34c",
    "date": 1694613912,
    "type": "param_error",
    "errors": {
        "shipping": "The shipping address is required when `ShippingPreference=SET_PROVIDED_ADDRESS`"
    }
}

{
    "message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "id": "58bf1a12-65e0-4298-a1cb-62dc800bcf84",
    "date": 1699366251,
    "type": "param_error",
    "errors": {
        "debitedAmount": "DebitedAmount has to be equal to the total amount of all the line items."
    }
}

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses