Retrieve Payment Methods

Definition

https://sandbox.bluesnap.com/services/2/tools/payment-methods-info

---

Documentation

With this request, you retrieve to retrieve the payment methods available to the shopper based on the following:

• Shopper country
• Shopper currency
• Activated payment methods in the merchant account console

Request Content

Send a POST request to:

• Sandbox: https://sandbox.bluesnap.com/services/2/tools/payment-methods-info
• Production: https://ws.bluesnap.com/services/2/tools/payment-methods-info

with the following properties:

  <th>
    Type
  </th>

  <th>
    Required
  </th>

  <th>
    Description
  </th>
</tr>

  <td>
    *string*
  </td>

  <td>
    Yes
  </td>

  <td>
    Shopper's country
  </td>
</tr>

<tr>
  <td>
    `currency`
  </td>

  <td>
    *string*
  </td>

  <td>
    Yes
  </td>

  <td>
    Shopper's currency, using the [supported currency codes](https://support.bluesnap.com/docs/currencies)
  </td>
</tr>

Property
`country`

Errors

If the request fails, the API returns an HTTP 400 response, with the following information:

  <th>
    Name
  </th>

  <th>
    Error Description
  </th>
</tr>

  <td>
    NO\_PAYMENT\_METHODS
  </td>

  <td>
    There are no payment methods available for this shopper.
  </td>
</tr>

Code
22020

Response Content

If successful, the response HTTP status code is 200 OK.
The response includes the supportedPaymentMethods or supported-payment-method object, with the following properties:

  <th>
    Type
  </th>

  <th>
    Description
  </th>
</tr>

  <td>
    *String*
  </td>

  <td>
    Payment method short name, such as:

    * `CC`
    * `WIRE`
    * `ECP`
    * `SEPA_DIRECT_DEBIT`
  </td>
</tr>

<tr>
  <td>
    `paymentMethodDisplayName`\
    `payment-method-display-name`
  </td>

  <td>
    *String*
  </td>

  <td>
    Payment method full name, such as:

    * `Credit Card`
    * `Wire Transfer`
    * `Electronic Check Presentment`
    * `SEPA Direct Debit`
  </td>
</tr>

<tr>
  <td>
    `supportedTypes`\
    `supported-type`
  </td>

  <td>
    *String*
  </td>

  <td>
    This is only included if there is more than one type for a payment method. For example, `Credit Card` could include:

    * `VISA`
    * `MASTERCARD`
    * `AMEX`
  </td>
</tr>

Property
`paymentMethodCodeName` `payment-method-code-name`

{`

• JSON Examples
• XML Examples

`}

JSON Examples

Request Example

Retrieve Payment Methods

curl -v -X POST https://sandbox.bluesnap.com/services/2/tools/payment-methods-info \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
   "country": "FR",
   "currency": "EUR"
}'

Response Example

Retrieve Payment Methods Response: 200 OK

{
    "country": "FR",
    "currency": "EUR",
    "supportedPaymentMethods": [
        {
            "paymentMethodCodeName": "WALLET_MP",
            "paymentMethodDisplayName": "Wallet MP"
        },
        {
            "paymentMethodCodeName": "CC",
            "paymentMethodDisplayName": "Credit Card",
            "supportedTypes": [
                "VISA",
                "MASTERCARD"
            ]
        },
        {
            "paymentMethodCodeName": "PAYPAL",
            "paymentMethodDisplayName": "PayPal"
        },
        {
            "paymentMethodCodeName": "WIRE",
            "paymentMethodDisplayName": "Wire Transfer"
        },
        {
            "paymentMethodCodeName": "MONEYBOOKERS",
            "paymentMethodDisplayName": "Moneybookers"
        },
        {
            "paymentMethodCodeName": "SEPA_DIRECT_DEBIT",
            "paymentMethodDisplayName": "SEPA Direct Debit"
        },
        {
            "paymentMethodCodeName": "BANKTRANSFER",
            "paymentMethodDisplayName": "Bank Transfer"
        },
        {
            "paymentMethodCodeName": "SOFORTUBERWEISUNG"
        }
    ]
}

Example Description

The example above shows a Retrieve Payment Methods request for a shopper in France with EUR as their currency, and a response showing the available payment types of:

• Wallet: Wallet MP (Masterpass)
• Credit card: Visa and Mastercard
• Paypal
• Wire Transfer
• Money Bookers
• SEPA Direct Debit
• Bank Transfer
• SOFORT

{`

`}

XML Examples

Request Example

Retrieve Payment Methods

curl -v -X POST https://sandbox.bluesnap.com/services/2/tools/payment-methods-info \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<?xml version="1.0" encoding="UTF-8"?>
<payment-methods-info xmlns="http://ws.plimus.com">
  <country>US</country>
  <currency>USD</currency>
</payment-methods-info>

Response Example

Retrieve Payment Methods Response: 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment-methods-info xmlns="http://ws.plimus.com">
    <country>US</country>
    <currency>USD</currency>
    <supported-payment-method>
        <payment-method-code-name>WALLET_MP</payment-method-code-name>
        <payment-method-display-name>Wallet MP</payment-method-display-name>
    </supported-payment-method>
    <supported-payment-method>
        <payment-method-code-name>CC</payment-method-code-name>
        <payment-method-display-name>Credit Card</payment-method-display-name>
        <supported-type>VISA</supported-type>
        <supported-type>MASTERCARD</supported-type>
    </supported-payment-method>
    <supported-payment-method>
        <payment-method-code-name>PAYPAL</payment-method-code-name>
        <payment-method-display-name>PayPal</payment-method-display-name>
    </supported-payment-method>
    <supported-payment-method>
        <payment-method-code-name>WIRE</payment-method-code-name>
        <payment-method-display-name>Wire Transfer</payment-method-display-name>
    </supported-payment-method>
    <supported-payment-method>
        <payment-method-code-name>ECP</payment-method-code-name>
        <payment-method-display-name>Electronic Check Presentment</payment-method-display-name>
    </supported-payment-method>
    <supported-payment-method>
        <payment-method-code-name>MONEYBOOKERS</payment-method-code-name>
        <payment-method-display-name>Moneybookers</payment-method-display-name>
    </supported-payment-method>
    <supported-payment-method>
        <payment-method-code-name>BANKTRANSFER</payment-method-code-name>
        <payment-method-display-name>Bank Transfer</payment-method-display-name>
    </supported-payment-method>
</payment-methods-info>

Example Description

The example above shows a Retrieve Payment Methods request for a shopper in the US with USD as their currency, and a response showing the available payment types of:

• Wallet: Wallet MP (Masterpass)
• Credit card: Visa and Mastercard
• Paypal
• Wire Transfer
• ECP
• Money Bookers
• Bank Transfer

{`

`}

Back to Top