Retrieve a payment option

How to fetch a specific payment option via API

To fetch a single payment option, send a GET request to the /api/payment_options/:id endpoint, where id is the ID of the resource that you want to retrieve.

Request

GET https://yourdomain.commercelayer.io/api/payment_options/:id

Example

Request

The following request fetches the payment option identified by the id "xYZkjABcde":

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Response

On success, the API responds with a 200 OK status code, returning a single resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "payment_options",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde"
    },
    "attributes": {
      "name": "Stripe Payment Option",
      "payment_source_type": "stripe_payments",
      "data": {
        "application_fee_amount": 1000,
        "on_behalf_of": "pm_xxx"
      },
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "order": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde/relationships/order",
          "related": "https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde/order"
        }
      },
      "attachments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde/relationships/attachments",
          "related": "https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde/attachments"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}