Manual gateways Update a manual gateway How to update an existing manual gateway via API
To update an existing manual gateway, send a PATCH
request to the /api/manual_gateways/:id
endpoint, where id
is the ID of the resource that you want to update.
Here below the list of all the possible arguments that you can pass with the request body.
Request
PATCH https://yourdomain.commercelayer.io/api/manual_gateways/:id
Arguments
Body Parameter
Type
Required
attributes.reference_origin
Example
Request Response
The following request updates the manual gateway identified by the ID "xYZkjABcde":
Copy curl -g -X PATCH \
'https://yourdomain.commercelayer.io/api/manual_gateways/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "manual_gateways",
"id": "xYZkjABcde",
"attributes": {
"reference": "ANY-EXTERNAL-REFEFERNCE"
}
}
}'
On success, the API responds with a 200 OK
status code, returning the updated resource object:
Copy {
"data" : {
"id" : "xYZkjABcde" ,
"type" : "manual_gateways" ,
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/manual_gateways/xYZkjABcde"
} ,
"attributes" : {
"name" : "US payment gateway" ,
"created_at" : "2018-01-01T12:00:00.000Z" ,
"updated_at" : "2018-01-01T12:00:00.000Z" ,
"reference" : "ANY-EXTERNAL-REFEFERNCE" ,
"reference_origin" : "ANY-EXTERNAL-REFEFERNCE-ORIGIN" ,
"metadata" : {
"foo" : "bar"
}
} ,
"relationships" : {
"payment_methods" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/manual_gateways/xYZkjABcde/relationships/payment_methods" ,
"related" : "https://yourdomain.commercelayer.io/api/manual_gateways/xYZkjABcde/payment_methods"
}
} ,
"versions" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/manual_gateways/xYZkjABcde/relationships/versions" ,
"related" : "https://yourdomain.commercelayer.io/api/manual_gateways/xYZkjABcde/versions"
}
}
} ,
"meta" : {
"mode" : "test" ,
"organization_id" : "xRRkjDFafe" ,
"trace_id" : "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}