Prepare a payment

post

https://api-sandbox.retail.monext.com/v1/checkout/payments/prepare

Currently, this service is only used for APPLE PAY direct integration. This service allows you to prepare a payment session for APPLE PAY.
It enables merchants to retrieve the session data required to display the Apple Pay wallet.

Body Params

paymentMethodId

string

required

1 to 50

Specifies which of the payment methods (acquiring contracts or PSP contracts) shall be used for the payment.

orderReference

string

required

length between 0 and 50

Merchant order reference.
Unique order reference defined by the merchant. This reference is used in our duplicate detection system.

miscData

object

required

'miscData' can be transmit to the payment method partners.
Consult the payment method for each use.
'miscData' is a dictionary values can be of any type (aka free-form object)
Note: The first key of the JSON must be equivalent to the paymentMethodId param. Example:

  "APPLEPAY_01": {
      "displayName": "nameToDisplay",
      "domainName": "webpayment.dev.payline.com",
      "validationURL": "https://apple-pay-gateway-cert.apple.com/paymentservices/startSession"
  }

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

202Accepted

400Bad Request

401Unauthorized

403Forbidden

409Conflict: duplicated payment transaction

422Unprocessable Entity

429Too Many Requests

500Internal Server Error

501Not Implemented

502Bad Gateway ou Proxy Error

503Service Unavailable

504Gateway Time-out