GET /payment-methods/{id}.json

GET /payment-methods/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.


  • 200

    Successful response

    Hide response attributes Show response attributes object
    • createdAt string(date-time)

      Created at

    • id integer(int32)


    • name string Required


    • redirectUrl string | null

      Redirect url

    • showInVendorPortal boolean | null Required

      Show in vendor portal

      Default value is true.

    • showNotes boolean | null Required

      This may be useful if you want the vendor to add in an email or other details in the vendor portal when selecting their payout method.

      Default value is false.

    • source string Required


      Values are bacs, check, custom, ost, other, paypal, stripe_managed, stripe, or transferwise. Default value is other.

    • updatedAt string(date-time)

      Updated at

GET /payment-methods/{id}.json
curl \
 -X GET{id}.json
Response examples (200)
  "createdAt": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "redirectUrl": "string",
  "showInVendorPortal": true,
  "showNotes": false,
  "source": "other",
  "updatedAt": "2023-05-04T09:42:00+00:00"