POST /payment-methods.json

application/json

Body Required

name string Required

Name
redirectUrl string | null

Redirect url
showInVendorPortal boolean | null Required

Show in vendor portal

Default value is true.
showNotes boolean | null Required

Show notes

Default value is false.
source string Required

Source

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

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- name string Required
  
  Name
- redirectUrl string | null
  
  Redirect url
- showInVendorPortal boolean | null Required
  
  Show in vendor portal
  
  Default value is true.
- showNotes boolean | null Required
  
  Show notes
  
  Default value is false.
- source string Required
  
  Source
  
  Values are bacs, check, custom, ost, other, paypal, stripe_managed, stripe, or transferwise. Default value is other.
- updatedAt string(date-time)
  
  Updated at

POST /payment-methods.json

curl \
 --request POST 'http://api.example.com/v1/payment-methods.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"string","redirectUrl":"string","showInVendorPortal":true,"showNotes":false,"source":"other"}'

Request examples

{
  "name": "string",
  "redirectUrl": "string",
  "showInVendorPortal": true,
  "showNotes": false,
  "source": "other"
}

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "id": 42,
  "name": "string",
  "redirectUrl": "string",
  "showInVendorPortal": true,
  "showNotes": false,
  "source": "other",
  "updatedAt": "2025-05-04T09:42:00Z"
}