{

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 Description
merchant_key The key of the merchant.
order_key The key of the order.

Parameters

Not applicable.

Request

Not applicable.

Response

Array of:

Field Type M Description
method String M The payment method, e.g. IDEAL, BANCONTACT, SEPA_DIRECT_DEBIT or MASTERCARD.
_bancontactdetails 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.
_idealdetails Block C The payment details for an IDEAL payment method.
+ issuers Block[] M The list of available issuing banks.
+ + id String M The id of the issuing bank, e.g. RABONL2U
+ + name String 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_debitdetails Block C _The payment details for an SEPA_DIRECTDEBIT payment method.
+ mandates Block[] O The list of active mandates for the shopper.
+ + id String M The mandate id.
+ + type String M The type of mandate, i.e. ONE_OFF or RECURRING
+ + scheme String M The mandate scheme, i.e. CORE or B2B

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"    : "MASTERCARD"
        },
    ]'