curl --request PATCH \
--url http://{defaultHost}/api/v2/platform/payment_methods/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_method": {
"name": "Test Payment Method",
"active": true,
"auto_capture": true,
"description": "This is a test payment method",
"type": "Spree::Gateway::Bogus",
"display_on": "both",
"store_ids": [
"2"
],
"public_metadata": {},
"private_metadata": {}
}
}
'{
"data": {
"id": "40",
"type": "payment_method",
"attributes": {
"name": "Credit Card",
"type": "Spree::Gateway::Bogus",
"description": null,
"active": true,
"display_on": "both",
"auto_capture": null,
"position": 3,
"created_at": "2022-11-08T19:34:49.452Z",
"updated_at": "2022-11-08T19:34:49.687Z",
"deleted_at": null,
"public_metadata": {},
"private_metadata": {},
"preferences": {
"dummy_key": "UPDATED-DUMMY-KEY-123",
"test_mode": false,
"server": "production"
}
},
"relationships": {
"stores": {
"data": [
{
"id": "301",
"type": "store"
}
]
}
}
}
}Updates a Payment Method
curl --request PATCH \
--url http://{defaultHost}/api/v2/platform/payment_methods/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_method": {
"name": "Test Payment Method",
"active": true,
"auto_capture": true,
"description": "This is a test payment method",
"type": "Spree::Gateway::Bogus",
"display_on": "both",
"store_ids": [
"2"
],
"public_metadata": {},
"private_metadata": {}
}
}
'{
"data": {
"id": "40",
"type": "payment_method",
"attributes": {
"name": "Credit Card",
"type": "Spree::Gateway::Bogus",
"description": null,
"active": true,
"display_on": "both",
"auto_capture": null,
"position": 3,
"created_at": "2022-11-08T19:34:49.452Z",
"updated_at": "2022-11-08T19:34:49.687Z",
"deleted_at": null,
"public_metadata": {},
"private_metadata": {},
"preferences": {
"dummy_key": "UPDATED-DUMMY-KEY-123",
"test_mode": false,
"server": "production"
}
},
"relationships": {
"stores": {
"data": [
{
"id": "301",
"type": "store"
}
]
}
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes
Show child attributes
"Test Payment Method"
"This is a test payment method"
Spree::Gateway::Bogus, Spree::PaymentMethod::Check "Spree::Gateway::Bogus"
both, back_end, front_end "both"
Was this page helpful?