Adding the payment source

How to add an Adyen payment source to an order

Problem

You have a pending order with a selected payment method that is associated with an Adyen payment integration. You want to give your customer the possibility to select one of the payment sources available from that gateway — e.g. a credit card — and use it to process the payment.

Solution

To add an Adyen payment source to an order, you have to create an Adyen payment source object and associate it with the order, as described in the Checkout guide.

Adding a payment source

Example

1. Get the payment source type

The following request retrieves the attributes of the payment method associated with the order identified by the "qaMAhZkZvd" ID:

curl -g -X GET \
  'http://yourdomain.commercelayer.io/api/orders/qaMAhZkZvd?include=payment_method' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Accept: application/vnd.api+json'

On success, the API responds with a 200 OK status code, returning the requested order object and the associated payment method:

{
  "data": {
    "id": "qaMAhZkZvd",
    "type": "orders",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/orders/qaMAhZkZvd"
    },
    "attributes": {...},
    "relationships": {
      "market": {
        "links": {...}
      },
      "customer": {
        "links": {...}
      },
      "shipping_address": {
        "links": {...}
      },
      "billing_address": {
        "links": {...}
      },
      "available_payment_methods": {
        "links": {...}
      },
      "payment_method": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/orders/qaMAhZkZvd/relationships/payment_method",
          "related": "https://yourdomain.commercelayer.io/api/orders/qaMAhZkZvd/payment_method"
        },
      "data": {
        "type": "payment_methods",
        "id": "JMRQlsvxkO"
      }
      },
      "payment_source": {
        "links": {...}
      },
      "line_items": {
        "links": {...}
      },
      "shipments": {
        "links": {...} 
      }
    },
    "meta": {
      "mode": "test"
    }
  },
  "included": [
    {
      "id": "JMRQlsvxkO",
      "type": "payment_methods",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/payment_methods/JMRQlsvxkO"
      },
      "attributes": {
        "payment_source_type": "adyen_payments",
        "name": "Adyen Payment",
        "disabled_at": null,
        "price_amount_cents": 0,
        "price_amount_float": 0.0,
        "formatted_price_amount": "€0,00",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "",
        "reference_origin": null,
        "metadata": {}
      },
      "relationships": {
        "market": {
        "links": {...}
        },
        "payment_gateway": {
          "links": {...}
        }
      },
      "meta": {
        "mode": "test"
      }
    }
  ]
}

2. Create the payment source and associate it with the order

The following request creates an Adyen payment object and associates it with the order identified by the "qaMAhZkZvd" ID:

curl -g -X POST \
  'http://yourdomain.commercelayer.io/api/adyen_payments' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "adyen_payments",
    "attributes": {},
    "relationships": {
      "order": {
        "data": {
          "type": "orders",
          "id": "qaMAhZkZvd"
        }
      }
    }
  }
}'

On success, the API responds with a 201 Created status code, returning the created Adyen payment object:

{
  "data": {
    "id": "emdEKhoOMA",
    "type": "adyen_payments",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/adyen_payments/emdEKhoOMA"
    },
    "attributes": {
      "payment_methods": {
        "groups": [
          {
            "name": "Credit Card",
            "types": [
              "visa",
              "mc",
              "amex"
            ]
          }
        ],
        "paymentMethods": [
          {
            "brands": [
              "visa",
              "mc",
              "amex"
            ],
            "details": [
              {
                "key": "encryptedCardNumber",
                "type": "cardToken"
              },
              {
                "key": "encryptedSecurityCode",
                "type": "cardToken"
              },
              {
                "key": "encryptedExpiryMonth",
                "type": "cardToken"
              },
              {
                "key": "encryptedExpiryYear",
                "type": "cardToken"
              },
              {
                "key": "holderName",
                "optional": true,
                "type": "text"
              }
            ],
            "name": "Credit Card",
            "type": "scheme"
          },
          {
            "name": "Online bank transfer.",
            "supportsRecurring": true,
            "type": "directEbanking"
          },
          {
            "name": "Pay later with Klarna.",
            "supportsRecurring": true,
            "type": "klarna"
          },
          {
            "name": "Paysafecard",
            "supportsRecurring": true,
            "type": "paysafecard"
          },
          {
            "details": [
              {
                "key": "bic",
                "type": "text"
              }
            ],
            "name": "GiroPay",
            "supportsRecurring": true,
            "type": "giropay"
          },
          {
            "name": "Slice it with Klarna.",
            "supportsRecurring": true,
            "type": "klarna_account"
          }
        ]
      },
      "payment_request_data": {},
      "payment_request_details": {},
      "payment_response": {},
      "payment_instrument":{...},
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": null,
      "reference_origin": null,
      "metadata": {}
    },
    "relationships": {
      "order": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/adyen_payments/emdEKhoOMA/relationships/order",
          "related": "https://yourdomain.commercelayer.io/api/adyen_payments/emdEKhoOMA/order"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Additional notes

Available payment methods

At the moment of the Adyen payment source creation, Commerce Layer makes a server-to-server request to Adyen to get a list of the available payment methods based on the payment amount and the customer country/device — see Adyen documentation for any reference — and returns it in the payment_methods attribute of the Ayden payment object.

The term payment method mentioned here is used to match Adyen internal naming convention and has nothing to do with Commerce Layer API payment method concept you'll find elsewhere in the guides.

Preventing mismatched amount errors

You can authorize Adyen payments using the _authorize trigger attribute of the order, or wait for Commerce Layer to do it automatically at the moment of the order placement (we strongly recommend following this latter workflow). Remember that you need to send back the payment details (and any other additional information required by specific features such as 3DS) to actually authorize the order. Until you do that the order status is still pending and so the order is still editable (i.e. the customer can add or remove items from the cart, changing its total amount). If this happens the order amount and the succeded authorization amount will differ, resulting in an error.

When implementing your checkout flow using Adyen please make sure the lapse of time between the order placement and authorization is as short as possible to prevent the order from being modified in the meantime.

Payment source nullification

If the payment method is associated with the order is changed previously created Adyen's payment sources are nullified and must be recreated. In this case, if the payment has already been authorized, the related authorization is voided and the order's payment status is set back from authorized to paid.

If an Adyen payment is authorized but the related order is not placed yet, the associated payment source cannot be changed. In some special cases (e.g. to give the user the possibility to change previously inserted credit card details) you may want to force the payment source nullification, even if the related payment is already authorized. To do that, you can leverage the _nullify_payment_source attribute of the order and manually trigger the payment source nullification, along with the related authorization void (if any) and payment status reset.