Order processing (1.0.0)

Download OpenAPI specification:Download

Order processing REST API.

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "access-token"

Order

Transaction

Payment Processing

Initiate payment

Initiate payment with an order

Authorizations:
path Parameters
mid
required
integer

The merchant id

orderId
required
string

The order id

Request Body schema: application/json

Request body describing the payment

orderDescription
string <= 100 characters

The OrderDescription can be used in some Soft Descriptor scenarios.

orderDetailDescription
string <= 100 characters

Can sometimes be used in Soft Descriptor scenarios.

paymentMethodId
integer
Default: 1000

The payment method Id. Examples of acceptable values are 1 = 'Nordea', 10 = 'Bank Austria'.

amount
required
object

Currency may be represented by either currency or numericCurrency, not both.

payInfo
object

Additional data related to payment processing.

lineItems
Array of objects

Line items in an order.

autoCapture
boolean

Defaults to false. If set to true the system will automatically capture the payment of the order for card payments. For redirect payments this is simply an indicator to the partner bank whether to withdraw funds automatically or not. Not all partner banks support this.

transactionChannel
required
string
Enum: "Web Online" "Cash Register" "Telephone" "Mail" "FaceToFace" "Digital Wallet" "In-app" "Voice Recognition" "MOTO"

A String with the name of transaction channel used to process the transaction. Case sensitive, space must be included where applicable.

cardInfo
object

Card related information. Although all elements are optional in this data type, some elements are mandatory for some transaction types and for some card types.

cardVerificationInfo
object
cardAuthenticationInfo
object
billingInfo
object

Billing information, such as the invoicing address to a card holder.

shippingInfo
object

Shipping information, such as the invoicing address to a card holder.

bankBillingInfo
object
fraudControl
object
requestId
string <= 50 characters [A-Za-z0-9_-]{0,50}

Request identifier, set by the merchant. Evaluated against [A-Za-z0-9_-]{0,50}

createToken
boolean
Default: false

Should a token be created for the passed PAN

token
string <= 64 characters

Payment instrument Token. Referring to a previously stored payment instrument such as a card number.

browserInfo
object

Information relating to browser and traffic routing.

merchantInfo
object
subMerchantInfo
object
cardPresentAuthInfo
object
recurringInfo
object
fraudScreeningData
object

Additional data related to fraud screening

redirectInfo
object
threeDSecureInfo
object
authenticationVerificationData
string

The verification data of the authentication. To be used in InitiatePaymentRequest.

authenticationApplication
string

The used authentication method. To be used in InitiatePaymentRequest.

storedCredentialInfo
object

Contains data regarding credentials on file feature

Responses

201

Created. Payload is stored and processing is attempted.

400

Bad Request. Will occur on missing or invalid input, where required.

401

Unauthorized

403

Forbidden

post/v2/merchants/{mid}/orders/{orderId}

Acceptance Test

https://api.test.payments.worldline.com/api/v2/merchants/{mid}/orders/{orderId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "orderDescription": "Some descriptive text.",
  • "orderDetailDescription": "Some descriptive text with details.",
  • "paymentMethodId": 1,
  • "amount":
    {
    },
  • "payInfo":
    {
    },
  • "lineItems":
    [
    ],
  • "autoCapture": true,
  • "transactionChannel": "Web Online",
  • "cardInfo":
    {
    },
  • "cardVerificationInfo":
    {
    },
  • "cardAuthenticationInfo":
    {
    },
  • "billingInfo":
    {
    },
  • "shippingInfo":
    {
    },
  • "bankBillingInfo":
    {
    },
  • "fraudControl":
    {
    },
  • "requestId": "123441kljj",
  • "createToken": true,
  • "token": "9000123412341234",
  • "browserInfo":
    {
    },
  • "merchantInfo":
    {
    },
  • "subMerchantInfo":
    {
    },
  • "cardPresentAuthInfo":
    {
    },
  • "recurringInfo":
    {
    },
  • "fraudScreeningData":
    {
    },
  • "redirectInfo":
    {},
  • "threeDSecureInfo":
    {
    },
  • "authenticationVerificationData": "string",
  • "authenticationApplication": "string",
  • "storedCredentialInfo":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "mid": 1234567890,
  • "orderId": "order_123",
  • "orderDetailDescription": "string",
  • "orderDescription": "string",
  • "orderAmount": 49.95,
  • "fulfilmentAmount": 49.95,
  • "capturedAmount": 49.95,
  • "refundedAmount": 49.95,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 49.95,
  • "baseFulfilmentAmount": 49.95,
  • "baseCapturedAmount": 49.95,
  • "baseRefundedAmount": 49.95,
  • "capturable": false,
  • "cancelable": false,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences":
    [