Worldline Payment APIs

https://docs.na.worldline-solutions.com/api-reference
Admin
Worldline Payment APIs enable developers to integrate payment processing capabilities including...
Tokens:26,345
Snippets:244
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Card Response Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Example of a successful response when retrieving card details.

```json
{
  "code": 0,
  "message": "string",
  "customer_code": "string",
  "card": {
    "card_id": 0,
    "function": "string",
    "name": "string",
    "number": "5100000010001004",
    "expiry_month": "02",
    "expiry_year": "17",
    "card_type": "AM",
    "limited_use_card_token": "string"
  }
}
```

--------------------------------

### Create Card Request Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Example of a request payload for creating a card profile.

```json
{
  "card": {
    "name": "string",
    "number": "string",
    "expiry_month": "02",
    "expiry_year": "17",
    "cvd": "123"
  },
  "token": {
    "name": "string",
    "code": "string"
  },
  "comment": "string",
  "validate": false
}
```

--------------------------------

### Request Payload Example

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

An example of a JSON payload for a payment request, illustrating various fields for order details, customer information, payment methods, and security configurations.

```json
{
  "order_number": "string",
  "amount": 0.1,
  "payment_method": "card",
  "ship_same_as_ord": false,
  "device_channel": "02",
  "language": "str",
  "customer_ip": "string",
  "term_url": "string",
  "comments": "string",
  "billing": {
    "name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "city": "string",
    "province": "string",
    "country": "AD",
    "postal_code": "string",
    "phone_number": "string",
    "phone_country_code": "string",
    "phone_type": "m",
    "email_address": "string"
  },
  "shipping": {
    "name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "city": "string",
    "province": "string",
    "country": "AD",
    "postal_code": "string",
    "phone_number": "string",
    "phone_country_code": "str",
    "email_address": "string"
  },
  "custom": {
    "ref1": "string",
    "ref2": "string",
    "ref3": "string",
    "ref4": "string",
    "ref5": "string"
  },
  "card": {
    "number": "5100000010001004",
    "name": "string",
    "expiry_month": "02",
    "expiry_year": "18",
    "cvd": "123",
    "3d_secure": {
      "browser": {
        "accept_header": "string",
        "java_enabled": true,
        "language": "string",
        "color_depth": 0,
        "screen_height": 0,
        "screen_width": 0,
        "time_zone": 0,
        "user_agent": "string",
        "javascript_enabled": true
      },
      "enabled": true,
      "version": 0,
      "auth_required": true,
      "disable_method_url": true,
      "threeDS_server_transaction_id": "string",
      "xid": "string",
      "cavv": "string",
      "eci": 0
    },
    "visa_checkout_call_id": "string",
    "complete": true
  },
  "apple_pay": {
    "passthrough": true,
    "apple_pay_merchant_id": "string",
    "payment_token": "string",
    "complete": true
  },
  "google_pay": {
    "name": "string",
    "3d_secure": {
      "browser": {
        "accept_header": "string",
        "java_enabled": true,
        "language": "string",
        "color_depth": 0,
        "screen_height": 0,
        "screen_width": 0,
        "time_zone": 0,
        "user_agent": "string",
        "javascript_enabled": true
      },
      "enabled": true,
      "version": 0,
      "auth_required": true,
      "disable_method_url": true,
      "threeDS_server_transaction_id": "string",
      "xid": "string",
      "cavv": "string",
      "eci": 0
    },
    "transaction_payload": "string",
    "complete": true
  },
  "payment_profile": {
    "3d_secure": {
      "browser": {
        "accept_header": "string",
        "java_enabled": true,
        "language": "string",
        "color_depth": 0,
        "screen_height": 0,
        "screen_width": 0,
        "time_zone": 0,
        "user_agent": "string",
        "javascript_enabled": true
      },
      "enabled": true,
      "version": 0,
      "auth_required": true,
      "disable_method_url": true,
      "threeDS_server_transaction_id": "string",
      "xid": "string",
      "cavv": "string",
      "eci": 0
    },
    "complete": true,
    "customer_code": "string",
    "card_id": 0
  },
  "token": {
    "complete": false,
    "code": "string",
    "name": "string",
    "3d_secure": {
      "browser": {
        "accept_header": "string",
        "java_enabled": true,
        "language": "string",
        "color_depth": 0,
        "screen_height": 0,
        "screen_width": 0,
        "time_zone": 0,
        "user_agent": "string",
        "javascript_enabled": true
      },
      "enabled": true,
      "version": 0,
      "auth_required": true,
      "disable_method_url": true,
      "threeDS_server_transaction_id": "string",
      "xid": "string",
      "cavv": "string",
      "eci": 0
    },
    "visa_checkout_call_id": "string"
  },
  "3d_secure": {
    "complete": false,
    "threeDS_session_data": "string",
    "auth_required": true,
    "disable_method_url": true,
    "threeDS_server_transaction_id": "string"
  },
  "recurring_payment": true,
  "level2": {
    "customer_code": "string",
    "order_tax1_price": 0.1,
    "order_tax2_price": 0.1
  },
  "card_on_file": {
    "type": "not_card_on_file",
    "series_id": 0
  },
  "processor_token": {
    "payment_token": "stringstringstr",
    "expiry_month": "st",
    "expiry_year": "st"
  }
}
```

--------------------------------

### Response Sample: 200 OK

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Example of a JSON response for a successful tokenization request.

```json
{
  "token": "string",
  "code": "string",
  "version": 0,
  "message": "string"
}
```

--------------------------------

### Request Sample: Payload

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Example of a JSON payload for the tokenization request.

```json
{
  "number": "string",
  "expiry_month": "02",
  "expiry_year": "17",
  "cvd": "123"
}
```

--------------------------------

### Response Sample - Get Cards

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON response for retrieving cards associated with a profile.

```json
{
  "code": 0,
  "message": "string",
  "customer_code": "string",
  "card": [
    {
      "card_id": 0,
      "function": "string",
      "name": "string",
      "number": "5100000010001004",
      "expiry_month": "02",
      "expiry_year": "17",
      "card_type": "AM",
      "limited_use_card_token": "string"
    }
  ]
}
```

--------------------------------

### Get Profile Response Sample (200 OK)

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON response for successfully retrieving a profile.

```json
{
  "code": 0,
  "message": "string",
  "customer_code": "string",
  "status": "string",
  "last_transaction": "2019-08-24T14:15:22Z",
  "modified_date": "2019-08-24T14:15:22Z",
  "language": "str",
  "velocity_group": "string",
  "profile_group": "string",
  "account_ref": "string",
  "card": {
    "name": "string",
    "number": "string",
    "expiry_month": "02",
    "expiry_year": "17",
    "card_type": "AM",
    "limited_use_card_token": "string"
  },
  "billing": {
    "name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "city": "string",
    "province": "string",
    "country": "AD",
    "postal_code": "string",
    "phone_number": "string",
    "phone_country_code": "str",
    "phone_type": "m",
    "email_address": "string"
  },
  "custom": {
    "ref1": "string",
    "ref2": "string",
    "ref3": "string",
    "ref4": "string",
    "ref5": "string"
  }
}
```

--------------------------------

### Void Payment Request Payload

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Example payload for voiding a payment transaction.

```json
{
  "amount": 0.1,
  "order_number": "string"
}
```

--------------------------------

### Get Recurring Payment Account Response Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

This is a sample JSON response for retrieving a recurring payment account.

```json
{
  "account_id": 0,
  "state": "Active",
  "language": "str",
  "payment": {
    "amount": 0.1,
    "disable_tax1": true,
    "disable_tax2": true,
    "process_back_payments": true
  },
  "billing": {
    "name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "city": "string",
    "province": "string",
    "country": "AD",
    "postal_code": "string",
    "phone_number": "string",
    "phone_country_code": "str",
    "email_address": "string"
  },
  "card": {
    "card_type": "AM",
    "name": "string",
    "expiry_year": "st",
    "expiry_month": "st"
  },
  "custom": {
    "order_number": "string",
    "comments": "string",
    "ref1": "string",
    "ref2": "string",
    "ref3": "string",
    "ref4": "string",
    "ref5": "string"
  },
  "schedule": {
    "period": "string",
    "increment": 0,
    "start_date": "2019-08-24T14:15:22Z",
    "second_billing": "2019-08-24T14:15:22Z",
    "expiry_date": "2019-08-24T14:15:22Z",
    "never_expires": true,
    "bill_at_end_of_month": true,
    "upcoming_transactions": [
      {
        "billing_date": "2019-08-24T14:15:22Z",
        "billing_end": "2019-08-24T14:15:22Z",
        "amount": 0.1,
        "total_amount": 0.1,
        "tax1": 0.1,
        "tax2": 0.1
      }
    ]
  }
}
```

--------------------------------

### Create Profile Response Sample (200 OK)

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON response for a successful profile creation.

```json
{
  "code": 0,
  "message": "string",
  "customer_code": "string",
  "validation": {
    "id": "string",
    "approved": 0,
    "message_id": 0,
    "message": "string",
    "auth_code": "string",
    "trans_date": "string",
    "order_number": "Transaction Id",
    "type": "P",
    "amount": 0.1,
    "cvd_id": 0
  },
  "limited_use_card_token": "string"
}
```

--------------------------------

### Create Profile Request Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON payload for creating a new profile.

```json
{
  "card": {
    "name": "string",
    "number": "string",
    "expiry_month": "02",
    "expiry_year": "17",
    "cvd": "123"
  },
  "bank_account": {
    "account_number": "string",
    "bank_account_holder": "string",
    "bank_account_type": "st",
    "branch_number": "strin",
    "institution_number": "str",
    "routing_number": "stringstr"
  },
  "create_from_id": {
    "create_from_id": 0
  },
  "token": {
    "name": "string",
    "code": "string"
  },
  "billing": {
    "name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "city": "string",
    "province": "string",
    "country": "AD",
    "postal_code": "string",
    "phone_number": "string",
    "phone_country_code": "str",
    "phone_type": "m",
    "email_address": "string"
  },
  "custom": {
    "ref1": "string",
    "ref2": "string",
    "ref3": "string",
    "ref4": "string",
    "ref5": "string"
  },
  "customer_code": "string",
  "language": "str",
  "comment": "string",
  "validate": false
}
```

--------------------------------

### Reports Search Query Request Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON payload for searching transactions.

```json
{
  "name": "Search",
  "start_date": "string",
  "end_date": "string",
  "start_row": 0,
  "end_row": 0,
  "criteria": [
    {
      "field": 0,
      "operator": "%3D",
      "value": "string"
    }
  ]
}
```

--------------------------------

### Merchant Response Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON response for merchant data.

```json
{
  "data": [
    {
      "merchant_id": 0,
      "merchant_name": "string",
      "website": "string",
      "address": {
        "street_address": "string",
        "province": "string",
        "country": "string",
        "postal_code": "string"
},
      "merchant_status": {
        "status": "Active",
        "state": "Created",
        "live_date": "2019-08-24",
        "created_date": "2019-08-24",
        "authorized_date": "2019-08-24",
        "temp_disabled_date": "2019-08-24",
        "last_enabled_date": "2019-08-24",
        "disabled_date": "2019-08-24"
},
      "processor": {
        "processor_name": "string",
        "currency": "str"
},
      "batch": {
        "batch_limit": 0.1,
        "batch_line_limit": 0.1,
        "eft_credit_lag": 0
},
      "settlement": {
        "credit_lag": 0
},
      "cards": {
        "mastercard_enabled": false,
        "visa_enabled": false,
        "amex_enabled": false,
        "discover_enabled": false,
        "diners_enabled": false,
        "jcb_enabled": false,
        "mastercard_debit_enabled": false,
        "visa_debit_enabled": false
},
      "features": {
        "checkout_enabled": false,
        "payment_profile_enabled": false,
        "recurring_billing_enabled": false,
        "credit_card_batch_enabled": false,
        "eft_ach_enabled": false,
        "visa_src_enabled": false
}
}
]

}
```

--------------------------------

### Payments Continue Request Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON payload for continuing a payment process.

```json
{
  "payment_method": "string"
}
```

--------------------------------

### Transaction Record Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON response for a transaction record.

```json
{
  "records": [
    {
      "row_id": 0,
      "trn_id": 0,
      "trn_date_time": "string",
      "trn_type": "string",
      "trn_order_number": "string",
      "trn_payment_method": "string",
      "trn_comments": "string",
      "trn_masked_card": "string",
      "trn_amount": 0,
      "trn_returns": 0,
      "trn_completions": 0,
      "trn_voided": 0,
      "trn_response": 0,
      "trn_card_type": "string",
      "trn_batch_no": 0,
      "trn_avs_result": "string",
      "trn_cvd_result": 0,
      "trn_cavv_result": "string",
      "trn_card_expiry": "string",
      "message_id": 0,
      "message_text": "string",
      "trn_card_owner": "string",
      "trn_ip": "string",
      "trn_approval_code": "string",
      "trn_reference": 0,
      "b_name": "string",
      "b_email": "string",
      "b_phone": "string",
      "b_phone_type": "m",
      "b_address1": "string",
      "b_address2": "string",
      "b_city": "string",
      "b_province": "string",
      "b_postal": "string",
      "b_country": "string",
      "s_name": "string",
      "s_email": "string",
      "s_phone": "string",
      "s_address1": "string",
      "s_address2": "string",
      "s_city": "string",
      "s_province": "string",
      "s_postal": "string",
      "s_country": "string",
      "ref1": "string",
      "ref2": "string",
      "ref3": "string",
      "ref4": "string",
      "ref5": "string",
      "product_name": "string",
      "product_id": "string",
      "customer_code": "string",
      "currency_abbr": "str",
      "merchant_id": 0,
      "merchant_name": "string",
      "entry_method": "N",
      "authorizing_merchant_id": 0,
      "version_3ds": 0,
      "flow_type_3ds": "F",
      "status_3ds": "Success",
      "cof_type": "first_installment",
      "reason_merchant_3ds": "string",
      "reason_cardholder_3ds": "string",
      "downgraded_3ds": true,
      "device_channel": 2,
      "method_url_3ds": "string"
    }
  ]
}
```

--------------------------------

### Merchant Report Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON response for a merchant report.

```json
{
  "data": [
    {
      "merchant_id": 0,
      "merchant_name": "string",
      "website": "string",
      "address": {
        "street_address": "string",
        "province": "string",
        "country": "string",
        "postal_code": "string"
      },
      "merchant_status": {
        "status": "Active",
        "state": "Created",
        "live_date": "2019-08-24",
        "created_date": "2019-08-24",
        "authorized_date": "2019-08-24",
        "temp_disabled_date": "2019-08-24",
        "last_enabled_date": "2019-08-24",
        "disabled_date": "2019-08-24"
      },
      "processor": {
        "processor_name": "string",
        "currency": "str"
      },
      "batch": {
        "batch_limit": 0.1,
        "batch_line_limit": 0.1,
        "eft_credit_lag": 0
      },
      "settlement": {
        "credit_lag": 0
      },
      "cards": {
        "mastercard_enabled": false,
        "visa_enabled": false,
        "amex_enabled": false,
        "discover_enabled": false,
        "diners_enabled": false,
        "jcb_enabled": false,
        "mastercard_debit_enabled": false,
        "visa_debit_enabled": false
      },
      "features": {
        "checkout_enabled": false,
        "payment_profile_enabled": false,
        "recurring_billing_enabled": false,
        "credit_card_batch_enabled": false,
        "eft_ach_enabled": false,
        "visa_src_enabled": false
      }
    }
  ]
}
```

--------------------------------

### Statement Report Response Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON response for statement data.

```json
{
  "data": [
    {
      "billing_period": "2019-08-24",
      "parent_id": 0,
      "parent_name": "string",
      "statement_id": 0,
      "merchant_id": 0,
      "merchant_name": "string",
      "fee_type": "string",
      "fee_volume": 0,
      "fee_rate": 0.1,
      "fee_amount": 0.1,
      "commission_rate": 0.1,
      "commission_amount": 0.1
}
]

}
```

--------------------------------

### Commissions Report Response Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON response for the Commissions Report.

```json
{
  "data": [
    {
      "row_id": 0,
      "payout_id": 0,
      "amount": "string",
      "start_datetime": "2019-08-24",
      "end_datetime": "2019-08-24",
      "expected_settlement_date": "2019-08-24",
      "statement_id": 0,
      "status": 0
}
]

}
```

--------------------------------

### Settlement Report Response Sample

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

Sample JSON response for settlement data.

```json
{
  "data": [
    {
      "merchant_id": 0,
      "transactions_date": "2019-08-24",
      "currency": "str",
      "settlement_net_amount": 0.1,
      "settlement_state": "Scheduled",
      "settlement_date": "2019-08-24",
      "approved_transaction_count": 0,
      "declined_transaction_count": 0,
      "sale_amount_total": 0.1,
      "returned_amount_total": 0.1,
      "chargebacks_count": 0,
      "chargebacks_amount_total": 0.1,
      "card_transaction_approved_rate": 0.1,
      "card_transaction_declined_rate": 0.1,
      "card_discount_rate": 0.1,
      "gst_tax_rate": 0.1,
      "approved_transaction_fee_total": 0.1,
      "declined_transaction_fee_total": 0.1,
      "discount_rate_fee_total": 0.1,
      "chargeback_fee_total": 0.1,
      "gst_tax_fee_total": 0.1,
      "reserves_held": 0.1,
      "reserves_released": 0.1,
      "reserves_forward": 0.1
}
]

}
```

--------------------------------

### 200 Response Sample for 3D Secure Payments

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

This is a sample JSON response for a successful (200) 3D Secure payment continuation.

```json
{
  "id": 0,
  "authorizing_merchant_id": 0,
  "approved": 0,
  "message_id": 0,
  "message": "string",
  "auth_code": "string",
  "created": "2019-08-24T14:15:22Z",
  "device_channel": "02",
  "amount": 0.1,
  "order_number": "string",
  "type": "string",
  "comments": "string",
  "batch_number": "string",
  "total_refunds": 0.1,
  "total_completions": 0.1,
  "payment_method": "string",
  "card": {
    "card_type": "AM",
    "last_four": "stri",
    "cvd_result": 0,
    "address_match": 0,
    "avs_result": "string",
    "expiry_month": "st",
    "expiry_year": "st",
    "cavv_result": "string",
    "processor_token": {
      "payment_token": "stringstringstr",
      "reporting_token": "string",
      "status": "success",
      "source": "string",
      "source_data": {
        "td_token_status": "s"
      }
    }
  },
  "payment_profile": {
    "complete": true,
    "customer_code": "string",
    "card_id": 0
  },
  "billing": {
    "name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "city": "string",
    "province": "string",
    "country": "AD",
    "postal_code": "string",
    "phone_number": "string",
    "phone_country_code": "str",
    "phone_type": "m",
    "email_address": "string"
  },
  "shipping": {
    "name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "city": "string",
    "province": "string",
    "country": "AD",
    "postal_code": "string",
    "phone_number": "string",
    "phone_country_code": "str",
    "email_address": "string"
  },
  "3d_secure": {
    "version": "string",
    "flow_type": "string",
    "status": "string",
    "reason_merchant": "string",
    "reason_cardholder": "string",
    "downgraded": true,
    "method_url": "string"
  },
  "custom": {
    "ref1": "string",
    "ref2": "string",
    "ref3": "string",
    "ref4": "string",
    "ref5": "string"
  },
  "adjusted_by": [
    {
      "id": 0,
      "type": "string",
      "approval": 0,
      "message": "string",
      "amount": 0.1,
      "created": "string",
      "url": "string"
    }
  ],
  "links": [
    {
      "ref": "string",
      "href": "string",
      "method": "string"
    }
  ]
}
```

--------------------------------

### 200 Response Sample for Payments

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

This is a sample JSON response for a successful payment transaction (HTTP 200).

```json
{
  "id": "string",
  "authorizing_merchant_id": 0,
  "approved": "string",
  "message_id": 0,
  "message": "string",
  "auth_code": "string",
  "created": "2019-08-24T14:15:22Z",
  "order_number": "Transaction Id",
  "type": "P",
  "risk_score": 0.1,
  "amount": 0.1,
  "payment_method": "card",
  "custom": {
    "ref1": "string",
    "ref2": "string",
    "ref3": "string",
    "ref4": "string",
    "ref5": "string"
  },
  "card": {
    "card_type": "AM",
    "last_four": "stri",
    "card_bin": "string",
    "cvd_result": 0,
    "eci": 0,
    "address_match": 0,
    "postal_result": 0,
    "avs": {
      "id": "0",
      "message": "string",
      "processed": true
    },
    "processor_token": {
      "payment_token": "stringstringstr",
      "reporting_token": "string",
      "status": "success",
      "source": "string",
      "source_data": {
        "td_token_status": "s"
      }
    },
    "cavv_result": "string",
    "status_id": 0,
    "status": "1",
    "error_id": 0,
    "error": "1"
  },
  "3d_secure": {
    "status": "string",
    "downgraded": true,
    "reason_merchant": "string",
    "reason_cardholder": "string",
    "method_url": "string"
  },
  "merchant_data": "string",
  "contents": "string",
  "links": [
    {
      "ref": "string",
      "href": "string",
      "method": "string"
    }
  ],
  "card_on_file": {
    "type": "not_card_on_file",
    "series_id": 0
  }
}
```

--------------------------------

### Request Body for Return Payment

Source: https://docs.na.worldline-solutions.com/api-reference#tag/Payments

This is the JSON payload required to initiate a payment return.

```json
{
  "order_number": "string",
  "amount": 0.1
}
```
Tokens:
Raw