Update an adyen payment How to update an existing adyen payment via API
To update an existing adyen payment, send a PATCH
request to the /api/adyen_payments/: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/adyen_payments/:id
Arguments
Body Parameter Type Required attributes.payment_request_data
attributes.payment_request_details
attributes.payment_response
attributes.reference_origin
Example
Request Response
The following request updates the adyen payment identified by the ID "xYZkjABcde":
Copy curl - g - X PATCH \
'https://yourdomain.commercelayer.io/api/adyen_payments/xYZkjABcde' \
- H 'Accept: application/vnd.api+json' \
- H 'Authorization: Bearer your-access-token' \
- H 'Content-Type: application/vnd.api+json' \
- d '{
"data" : {
"type" : "adyen_payments" ,
"id" : "xYZkjABcde" ,
"attributes" : {
"payment_request_data" : {
"foo" : "bar"
}
} ,
"relationships" : {
"order" : {
"data" : {
"type" : "orders" ,
"id" : "ABCRtyUpBa"
}
}
}
}
} '
On success, the API responds with a 200 OK
status code, returning the updated resource object:
Copy {
"data" : {
"id" : "xYZkjABcde" ,
"type" : "adyen_payments" ,
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/adyen_payments/xYZkjABcde"
} ,
"attributes" : {
"public_key" : "xxxx-yyyy-zzzz" ,
"payment_methods" : {
"foo" : "bar"
} ,
"payment_request_data" : {
"foo" : "bar"
} ,
"payment_request_details" : {
"foo" : "bar"
} ,
"payment_response" : {
"foo" : "bar"
} ,
"mismatched_amounts" : false ,
"payment_instrument" : {
"issuer" : "cl bank" ,
"card_type" : "visa"
} ,
"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" : {
"order" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/adyen_payments/xYZkjABcde/relationships/order" ,
"related" : "https://yourdomain.commercelayer.io/api/adyen_payments/xYZkjABcde/order"
}
} ,
"payment_gateway" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/adyen_payments/xYZkjABcde/relationships/payment_gateway" ,
"related" : "https://yourdomain.commercelayer.io/api/adyen_payments/xYZkjABcde/payment_gateway"
}
} ,
"versions" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/adyen_payments/xYZkjABcde/relationships/versions" ,
"related" : "https://yourdomain.commercelayer.io/api/adyen_payments/xYZkjABcde/versions"
}
}
} ,
"meta" : {
"mode" : "test"
}
}
}
Last updated 7 months ago