{

Methods

List available payment methods.

List payment methods of an Order

Returns a list of all available payment methods of an order.

GET /ps/api/public/v1/merchants/{merchant_key}/orders/{order_key}/payments/methods

Identifiers

Name Type Description
merchant_key MerchantKey The key of the merchant.
order_key OrderKey The key of the order.

Parameters

Not applicable.

Request

Not applicable.

Response

Array of:

Field Type M Description
method Enum(50) M The payment method, e.g. IDEAL, BANCONTACT, SEPA_DIRECT_DEBIT or MASTERCARD.
bancontact_details Block C The payment details for a Bancontact payment method. Only present when Bancontact Mobile QR is enabled.
+ qr_url Url M The URL to the Bancontact Mobile QR image.
+ intent_url Url M The URL for a Bancontact Mobile intent button; does not have to start with http.
ideal_details Block C The payment details for an iDEAL payment method.
+ issuers Block[] M The list of available issuing banks.
+ + id Enum(50) M The id of the issuing bank, e.g. RABONL2U
+ + name String(1, 255) M The name of the issuing bank, e.g. Rabobank.
+ qr_url Url O The URL to the iDEAL QR image. Only present when IDeal QR is enabled.
sepa_direct_debit_details Block C The payment details for an SEPA_DIRECT_DEBIT payment method.
+ mandates Block[] O The list of active mandates for the shopper.
+ + id String(1, 255) M The mandate id.
+ + type Enum(16) M The type of mandate, i.e. ONE_OFF or RECURRING
+ + scheme Enum(16) M The mandate scheme, i.e. CORE or B2B
google_pay_details Block C The payment details for GOOGLE_PAY payment method.
+ server_url Url M The URL to the Mobile Pay Server. The Url in example is not a full Url. For more detail, check here.
+ merchant_country Country M The country of the merchant.
+ gateway_id String(64) M Payment Processor Id of CM.com as registered with Google.
+ environment Enum(64) M The environment the Google Pay's client should use. For testing on lower environments, TEST should be used. For production, environment will be PRODUCTION.
+ merchant_id String(64) C The Google merchant identifier issued by Google. Mandatory for production environment, but optional for other environments.
+ allowed_card_networks String(1, 64)[] M The allowed card networks for Payment via Google Pay.
apple_pay_details Block C The payment details for APPLE_PAY payment method.
+ server_url Url M The URL to the Mobile Pay Server. The Url in example is not a full Url. For more detail, check here.
+ merchant_country Country M The country of the merchant.
+ supported_networks String(1, 64)[] M The supported card networks for Payment via Apple Pay.

HTTP Status

Status Meaning
200 (OK) Success.
400 (Bad Request) The request was not valid.
401 (Unauthorized) Authorization header missing or invalid.
403 (Forbidden) The merchant key is not allowed.
404 (Not Found) The order key was not found.

Order Details example

> curl \
    -X GET \
    --header 'Authorization: Basic RG9jZGF0YVBGOkJXazJhZkpV' \
    https://testsecure.docdatapayments.com/ps/api/public/v1/merchants/4ef08825-993a-424d-a769-3ee97116a1b6/orders/94D261BBF80E4AC7212B127D3BD2E279/payments/methods

< Http 200 Ok
<    '[
        {
            "method" : "VISA"
        },
        {
            "method" : "MASTERCARD"
        },

        {
            "method" : "IDEAL",
            "ideal_details" : {
                "issuers"   : [
                    {
                        id   : "ABNA",
                        name : "ABN AMRO"
                    },
                    {
                        id   : "RABO",
                        name : "Rabobank"
                    },
                    {
                        id   : "INGB",
                        name : "ING"
                    }
                ],
                "qr_url"        : "https://qrcode.ideal.nl/codes/5d6b159b-41ab-48eb-b379-da18ddea06d"
            }
        },
        {
            "method" : "BANCONTACT",
            "bancontact_details"    : {
                "qr_url"    : "https://testtma-assets.docdatapayments.com/qr?data=BEP%3A%2F%2F1TESTTMA.DOCDATAPAYMENTS.COM%2FBEP%24QLI7W4RDFDZMH4Z5FCAJ7DZV",
                "intent_url"    : "bepgenapp://DoTx?TransId=1TESTTMA.DOCDATAPAYMENTS.COM/BEP$QLI7W4RDFDZMH4Z5FCAJ7DZV"
            }
        },
        {
            "method" : "SEPA_DIRECT_DEBIT",
            "sepa_direct_debit_details" : {
                "mandates"  : [
                    {
                        id      : "ps-sim-1575466412104",
                        type    : "ONE_OFF",
                        scheme  : "CORE"
                    }
                ],
            }
        },
        {
            "method": "APPLE_PAY",
            "apple_pay_details": {
                "server_url": "http://testsecure.docdatapayments.com:8484",
                "merchant_country": "NL",
                "supported_networks": [
                    "visa",
                    "masterCard"
                ]
            }
        },
        {
            "method": "GOOGLE_PAY",
            "google_pay_details": {
             "server_url": "http://testsecure.docdatapayments.com:8484",
             "merchant_country": "NL",
             "gateway_id": "example",
             "environment": "TEST",
             "merchant_id": "default",
             "allowed_card_networks": [
                 "MASTERCARD",
                 "VISA"
              ]
         },
        {
            "method"    : "MASTERCARD"
        },
    ]'