Join Program
This section is a work in progress, and subject to change.
API access is currently restricted. Interested? Please apply to our early access program.
Payment Methods Resource
URL Endpoints
| Endpoint |
Supported Methods |
| /[store-handle]/api/v2/sales/paymentmethods.json |
GET |
| /[store-handle]/api/v2/sales/paymentmethods/[paymentmethod-uuid].[format] |
GET, PUT, DELETE |
Data Structure
GET
/[store-handle]/api/v2/sales/paymentmethods.json
/static/support/documentation/examples/paymentmethods.json
| Name |
Path |
Type |
Description |
Example |
| type |
type |
string (readonly) |
Resource type. Must match the resource type used in the endpoint. |
"orders", "products", "customers" |
| uuid |
uuid |
uuid |
Resource identifier. Must be a valid hex representation. |
"06429e75a8ea11de80c09314b8ee4e52" |
| revision |
revision |
timestamp (readonly) |
Resource version. Uses the timestamp format, precision up to seconds. |
1253783394 |
| name |
name |
string |
Payment method name. |
"Pick up in Store", "Paypal", "ACH Direct", "Bank Transfer" |
| method |
method |
enum |
Payment method. Values can be "cash", "debitcard", "creditcard", "check", "transfer". |
"cash", "debitcard" |
| gateway |
gateway |
enum |
Merchant code. Used for online processing. Values can be "paypal_express", "paypal_direct", "ach_direct", "authorize" or empty. |
"paypal_express", "paypal_direct" |
| testing |
testing |
bool |
Testing modus. For online processing this means it uses the test servers. |
true, false |
| login |
login |
string |
Login name for processing service. |
"mystore" |
| password |
password |
string (masked) |
Password for processing service. Is masked using * characters. |
"*****" |
| signature |
signature |
string |
Optional signature for processing service. |
"Sjd78HSd7" |
| instructions |
instructions |
string |
Optional instructions for this payment method. |
"Transfer money to account number x." |