Documentation Powered by ReDoc

Order processing (1.0.0)

Download OpenAPI specification:Download

URL: https://developer.payments.worldline.com

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:
bearerAuth
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'.

required
object

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

object

Additional data related to payment processing.

Array of objects[ items ]

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.

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.

object
object
object

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

object

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

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

orderScopeReferenceTransactionId
number

Use to indicate that this request is to be processed in the same order scope as the transaction id provided.

object

Information relating to browser and traffic routing.

object
object
object
object
object

Additional data related to fraud screening

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

object

Contains data regarding credentials on file feature

schemeToken
boolean
Default: false

Defaults to false. Set to true if network or scheme token like MDES or VTS will be used.

cardServiceCryptogram
string

This field will be used to pass the cryptogram we receive in case of scheme tokenization or wallet.

Responses

Request samples

Content type
application/json
{
  • "orderDescription": "description",
  • "orderDetailDescription": "detailed desc",
  • "paymentMethodId": 1,
  • "amount": {
    },
  • "payInfo": {
    },
  • "lineItems": [
    ],
  • "autoCapture": true,
  • "transactionChannel": "Web Online",
  • "cardInfo": {
    },
  • "cardVerificationInfo": {
    },
  • "cardAuthenticationInfo": {
    },
  • "billingInfo": {
    },
  • "shippingInfo": {
    },
  • "bankBillingInfo": {
    },
  • "fraudControl": {
    },
  • "requestId": "request-id-101",
  • "createToken": true,
  • "token": "9000033649121111",
  • "orderScopeReferenceTransactionId": 10059432245,
  • "browserInfo": {
    },
  • "merchantInfo": {
    },
  • "subMerchantInfo": {
    },
  • "cardPresentAuthInfo": {
    },
  • "recurringInfo": {
    },
  • "fraudScreeningData": {
    },
  • "redirectInfo": {},
  • "threeDSecureInfo": {
    },
  • "authenticationVerificationData": "string",
  • "authenticationApplication": "string",
  • "storedCredentialInfo": {
    },
  • "schemeToken": true,
  • "cardServiceCryptogram": "string"
}

Response samples

Content type
application/json
{
  • "mid": 1570616552,
  • "orderId": "order_example_1",
  • "orderDetailDescription": "detailed desc",
  • "orderDescription": "description",
  • "orderAmount": 10.5,
  • "fulfilmentAmount": 10.5,
  • "capturedAmount": 0,
  • "refundedAmount": 0,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 10.5,
  • "baseFulfilmentAmount": 10.5,
  • "baseCapturedAmount": 0,
  • "baseRefundedAmount": 0,
  • "capturable": true,
  • "cancelable": true,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences": [
    ]
}

Completes one order given merchant id and order id

Completes a redirect transactions of a payment order given a merchant id and order id. If the Payment Method is returning data, this must be passed on in this call.

Authorizations:
bearerAuth
path Parameters
mid
required
integer

The merchant id

orderId
required
string

The order id

Request Body schema: application/json

Request body describing the complete

redirectParameterString
string

Parameter string that may be needed in order to successfully complete payment

Responses

Request samples

Content type
application/json
{
  • "redirectParameterString": "A=X&B=Y"
}

Response samples

Content type
application/json
{
  • "mid": 1570616552,
  • "orderId": "order_example_1",
  • "orderDetailDescription": "detailed desc",
  • "orderDescription": "description",
  • "orderAmount": 10.5,
  • "fulfilmentAmount": 10.5,
  • "capturedAmount": 0,
  • "refundedAmount": 0,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 10.5,
  • "baseFulfilmentAmount": 10.5,
  • "baseCapturedAmount": 0,
  • "baseRefundedAmount": 0,
  • "capturable": true,
  • "cancelable": true,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences": [
    ]
}

Reporting

Get one order given merchant id and order id

Get one order given merchant id and order id

Authorizations:
bearerAuth
path Parameters
mid
required
integer

The merchant id

orderId
required
string

The order id

Responses

Response samples

Content type
application/json
{
  • "mid": 1570616552,
  • "orderId": "order_example_1",
  • "orderDetailDescription": "detailed desc",
  • "orderDescription": "description",
  • "orderAmount": 10.5,
  • "fulfilmentAmount": 10.5,
  • "capturedAmount": 0,
  • "refundedAmount": 0,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 10.5,
  • "baseFulfilmentAmount": 10.5,
  • "baseCapturedAmount": 0,
  • "baseRefundedAmount": 0,
  • "capturable": true,
  • "cancelable": true,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences": [
    ]
}

Transaction Management

Cancels one order given merchant id and order id

Cancels one order given merchant id and order id

Authorizations:
bearerAuth
path Parameters
mid
required
integer

The merchant id

orderId
required
string

The order id

Responses

Response samples

Content type
application/json
{
  • "mid": 1570616552,
  • "orderId": "order_example_1",
  • "orderDetailDescription": "detailed desc",
  • "orderDescription": "description",
  • "orderAmount": 10.5,
  • "fulfilmentAmount": 10.5,
  • "capturedAmount": 0,
  • "refundedAmount": 0,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 10.5,
  • "baseFulfilmentAmount": 10.5,
  • "baseCapturedAmount": 0,
  • "baseRefundedAmount": 0,
  • "capturable": true,
  • "cancelable": true,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences": [
    ]
}

Captures one order given merchant id and order id

Captures one order given merchant id and order id

Authorizations:
bearerAuth
path Parameters
mid
required
integer

The merchant id

orderId
required
string

The order id

Request Body schema: application/json

Request body describing the capture

object

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

executionDate
string

Later execution date for the capture. Evaluated in UTC as ISO datetime

Responses

Request samples

Content type
application/json
{
  • "amount": {
    },
  • "executionDate": "2019-12-13T11:59:34.320Z"
}

Response samples

Content type
application/json
{
  • "mid": 1570616552,
  • "orderId": "order_example_1",
  • "orderDetailDescription": "detailed desc",
  • "orderDescription": "description",
  • "orderAmount": 10.5,
  • "fulfilmentAmount": 10.5,
  • "capturedAmount": 0,
  • "refundedAmount": 0,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 10.5,
  • "baseFulfilmentAmount": 10.5,
  • "baseCapturedAmount": 0,
  • "baseRefundedAmount": 0,
  • "capturable": true,
  • "cancelable": true,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences": [
    ]
}

Refunds one order given merchant id and order id

Refunds one order given merchant id and order id

Authorizations:
bearerAuth
path Parameters
mid
required
integer

The merchant id

orderId
required
string

The order id

Request Body schema: application/json

Request body describing the refund

object

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

object

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

unlimitedRefund
boolean

Set to true only if unlimited refund is intended.

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

object

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

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

token
string <= 64 characters

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

Responses

Request samples

Content type
application/json
{
  • "amount": {
    },
  • "baseAmount": {
    },
  • "unlimitedRefund": true,
  • "transactionChannel": "Web Online",
  • "billingInfo": {
    },
  • "bankBillingInfo": {
    },
  • "cardInfo": {
    },
  • "token": "9000033649121111"
}

Response samples

Content type
application/json
{
  • "mid": 1570616552,
  • "orderId": "order_example_1",
  • "orderDetailDescription": "detailed desc",
  • "orderDescription": "description",
  • "orderAmount": 10.5,
  • "fulfilmentAmount": 10.5,
  • "capturedAmount": 0,
  • "refundedAmount": 0,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 10.5,
  • "baseFulfilmentAmount": 10.5,
  • "baseCapturedAmount": 0,
  • "baseRefundedAmount": 0,
  • "capturable": true,
  • "cancelable": true,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences": [
    ]
}

Initiate an original credit

Initiate an original credit

Authorizations:
bearerAuth
path Parameters
mid
required
integer

The merchant id

orderId
required
string

The order id

Request Body schema: application/json

Request body describing the original credit

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

required
object

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

object

Tax, if set, either of them may be used, not both.

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

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

object

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

token
string <= 64 characters

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

object
object

Responses

Request samples

Content type
application/json
{
  • "orderDescription": "description",
  • "orderDetailDescription": "detail desc",
  • "paymentMethodId": 1001,
  • "amount": {
    },
  • "tax": {
    },
  • "transactionChannel": "Web Online",
  • "bankBillingInfo": {
    },
  • "cardInfo": {
    },
  • "billingInfo": {
    },
  • "token": "9000033649121111",
  • "merchantInfo": {
    },
  • "subMerchantInfo": {
    }
}

Response samples

Content type
application/json
{
  • "mid": 1570616552,
  • "orderId": "order_example_1",
  • "orderDetailDescription": "detailed desc",
  • "orderDescription": "description",
  • "orderAmount": 10.5,
  • "fulfilmentAmount": 10.5,
  • "capturedAmount": 0,
  • "refundedAmount": 0,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 10.5,
  • "baseFulfilmentAmount": 10.5,
  • "baseCapturedAmount": 0,
  • "baseRefundedAmount": 0,
  • "capturable": true,
  • "cancelable": true,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences": [
    ]
}

Tokenization

Creates or returns a token for provided data

Creates or returns a token for provided data

Authorizations:
bearerAuth
path Parameters
mid
required
integer

The merchant id

Request Body schema: application/json

Request body describing the token

orderId
string <= 50 characters
token
string <= 35 characters

Payment instrument Token.

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.

encryptedCardPayload
string

Base64-encoded encrypted card information. If present, this element takes precedence over any other card information elements in the request.

Responses

Request samples

Content type
application/json
{
  • "orderId": "order_example_1",
  • "token": "9000033649121111",
  • "cardInfo": {
    },
  • "encryptedCardPayload": "ewogICAgImtleU1hbmFnZW1lbnQiOiAKICAgIHsKICAgICAgICAibWFzdGVyS2V5SWQiOiAiVEFDQ01LMSIsCiAgICAgICAgIm1hc3RlcktleVZlcnNpb24iOiAiTUtWMSIsCiAgICAgICAgInNlc3Npb25LZXlFbmNyeXB0aW9uQWxnb3JpdGhtIjogIkFFUyIsCiAgICAgICAgImluaXRpYWxpemF0aW9uVmVjdG9yIjogIm1qLXVfZ1lUckZHMVQzV3pfNE9YN3c9PSIsCiAgICAgICAgImVuY3J5cHRlZFNlc3Npb25LZXkiOiAiTXpjeU16TkZPRGt3UWpBeE1EUkZPVUpET1RRelJEQkZORFZGUVVVMVFUYz0iCiAgICB9LAogICAgImRhdGFFbmNyeXB0aW9uIjogCiAgICB7CiAgICAgICAgImRhdGFFbmNyeXB0aW9uQWxnb3JpdGhtIjogIkFFUyIsCiAgICAgICAgImtleVNpemUiOiAxMjgsCiAgICAgICAgImluaXRpYWxpemF0aW9uVmVjdG9yIjogIl9tS3ltb181UE16VDRza3VNYjh4Rnc9PSIsCiAgICAgICAgImJ5dGVQYWRkaW5nIjogIk5VTDgiLAogICAgICAgICJlbmNyeXB0ZWREYXRhIjogImFyY08tWjhkNm4zS05qYlp0MWJhNVVPLUE1bHRKdHk0N3BuQkV0WF9aM009IgogICAgfQp9"
}

Response samples

Content type
application/json
{
  • "transactionReferences": [
    ]
}

Strong Customer Authentication

Initiate an authentication

Call Initiate Authentication to determine whether cardholder authentication is necessary or not, which is indicated in the Authentication Status attribute of the response.

Authorizations:
bearerAuth
path Parameters
mid
required
integer

The merchant id

orderId
required
string

The order id

Request Body schema: application/json

Request body describing the initiate authentication

object

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

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.

token
string <= 64 characters

Payment instrument Token. Referring to a previously stored payment instrument such as a card number. Do not use if providing cardInfo data and vice versa.

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.

object

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

object

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

object

Information relating to browser and traffic routing.

object
object
object
merchantUrl
string

Fully qualified URL to the merchant's website or customer service. Includning "http://" or "https://".

object

Responses

Request samples

Content type
application/json
{
  • "amount": {
    },
  • "cardInfo": {
    },
  • "token": "9000033649121111",
  • "orderDescription": "description",
  • "orderDetailDescription": "detailed desc",
  • "billingInfo": {
    },
  • "shippingInfo": {
    },
  • "browserInfo": {
    },
  • "merchantInfo": {
    },
  • "subMerchantInfo": {
    },
  • "recurringInfo": {
    },
  • "merchantUrl": "https://someurltoredirectbackto.com/callbacks",
  • "threeDSecureInfo": {
    }
}

Response samples

Content type
application/json
{
  • "mid": 1570616552,
  • "orderId": "order_example_1",
  • "orderDetailDescription": "detailed desc",
  • "orderDescription": "description",
  • "orderAmount": 10.5,
  • "fulfilmentAmount": 10.5,
  • "capturedAmount": 0,
  • "refundedAmount": 0,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 10.5,
  • "baseFulfilmentAmount": 10.5,
  • "baseCapturedAmount": 0,
  • "baseRefundedAmount": 0,
  • "capturable": true,
  • "cancelable": true,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences": [
    ]
}

Continue an authentication on given merchant id and order id

Continue Authentication is conditionally required as a step after the Initiate Authentication.

Authorizations:
bearerAuth
path Parameters
mid
required
integer

The merchant id

orderId
required
string

The order id

Responses

Response samples

Content type
application/json
{
  • "mid": 1570616552,
  • "orderId": "order_example_1",
  • "orderDetailDescription": "detailed desc",
  • "orderDescription": "description",
  • "orderAmount": 10.5,
  • "fulfilmentAmount": 10.5,
  • "capturedAmount": 0,
  • "refundedAmount": 0,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 10.5,
  • "baseFulfilmentAmount": 10.5,
  • "baseCapturedAmount": 0,
  • "baseRefundedAmount": 0,
  • "capturable": true,
  • "cancelable": true,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences": [
    ]
}

Complete authentication on given merchant id and order id

Complete authentication to determine the Authentication Status result.

Authorizations:
bearerAuth
path Parameters
mid
required
integer

The merchant id

orderId
required
string

The order id

Request Body schema: application/json

Request body describing the complete authentication

authenticationResultParameter
required
string

Formatted parameter string containing result of authentication.

Responses

Request samples

Content type
application/json
{
  • "authenticationResultParameter": "ewogICAiYWNzUmVmZXJlbmNlTnVtYmVyIiA6ICJBQ1NFbXUyIiwKICAgImFjc1RyYW5zSUQiIDogIjAwMDAwMDAwLTAwMDUtNWE1YS04MDAwLTAxNzA2NzM3NTdkNyIsCiAgICJtZXNzYWdlVHlwZSIgOiAiQ1JlcyIsCiAgICJtZXNzYWdlVmVyc2lvbiIgOiAiMi4xLjAiLAogICAidGhyZWVEU1NlcnZlclRyYW5zSUQiIDogIjFiY2QzNTE4LTk3ZmItNWNkMC04MDAwLTAwMDAwMDAwZjAyMyIsCiAgICJ0cmFuc1N0YXR1cyIgOiAiWSIKfQ"
}

Response samples

Content type
application/json
{
  • "mid": 1570616552,
  • "orderId": "order_example_1",
  • "orderDetailDescription": "detailed desc",
  • "orderDescription": "description",
  • "orderAmount": 10.5,
  • "fulfilmentAmount": 10.5,
  • "capturedAmount": 0,
  • "refundedAmount": 0,
  • "currency": "EUR",
  • "baseCurrency": "EUR",
  • "baseOrderAmount": 10.5,
  • "baseFulfilmentAmount": 10.5,
  • "baseCapturedAmount": 0,
  • "baseRefundedAmount": 0,
  • "capturable": true,
  • "cancelable": true,
  • "refundable": false,
  • "completable": false,
  • "dccIndicator": false,
  • "timestamp": "2019-11-05T10:05:43.569Z",
  • "transactionReferences": [
    ]
}