Update an axerve payment
How to update an existing axerve payment via API
To update an existing axerve payment, send a PATCH request to the /api/axerve_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/axerve_payments/:id
Arguments
type
string
Required
id
string
Required
attributes.payment_request_data
object
Optional
attributes._update
boolean
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
relationships.order
object
Optional
Example
The following request updates the axerve payment identified by the ID "XAyRWNUzyN":
curl -g -X PATCH \
'https://yourdomain.commercelayer.io/api/axerve_payments/XAyRWNUzyN' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "axerve_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:
{
"data": {
"id": "XAyRWNUzyN",
"type": "axerve_payments",
"links": {
"self": "https://yourdomain.commercelayer.io/api/axerve_payments/XAyRWNUzyN"
},
"attributes": {
"login": "xxxx-yyyy-zzzz",
"return_url": "https://yourdomain.com/thankyou",
"payment_request_data": {
"foo": "bar"
},
"client_ip": "213.45.120.5",
"buyer_details": {
"cardHolder": {
"email": "[email protected]"
},
"shippingAddress": {
"firstName": "George"
}
},
"request_token": true,
"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/axerve_payments/XAyRWNUzyN/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/axerve_payments/XAyRWNUzyN/order"
}
},
"payment_gateway": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/axerve_payments/XAyRWNUzyN/relationships/payment_gateway",
"related": "https://yourdomain.commercelayer.io/api/axerve_payments/XAyRWNUzyN/payment_gateway"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/axerve_payments/XAyRWNUzyN/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/axerve_payments/XAyRWNUzyN/versions"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/axerve_payments/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/axerve_payments/XAyRWNUzyN/event_stores"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}Last updated

