Jetti API documentation

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

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

Source

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

Responses

• 200

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
  
  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
  
  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 \
 -X POST http://api.example.com/v1/payment-methods.json \
 -H "Content-Type: application/json" \
 -d '{"name":"string","redirectUrl":"string","showInVendorPortal":true,"showNotes":false,"source":"other"}'

Request example

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

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"
}