Update an authorization

To update an existing authorization, send a PATCH request to the /api/authorizations/: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/authorizations/:id
Arguments
Body Parameter
Type
Required
type
string
Required
id
string
Required
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
attributes._capture
boolean, value is 'true'
Optional
attributes._capture_amount_cents
integer
Optional
attributes._void
boolean, value is 'true'
Optional
Example
Request
Response
The following request updates the authorization identified by the ID "xYZkjABcde":
1
curl -g -X PATCH \
2
  'https://yourdomain.commercelayer.io/api/authorizations/xYZkjABcde' \
3
  -H 'Accept: application/vnd.api+json' \
4
  -H 'Authorization: Bearer your-access-token' \
5
  -H 'Content-Type: application/vnd.api+json' \
6
  -d '{
7
  "data": {
8
    "type": "authorizations",
9
    "id": "xYZkjABcde",
10
    "attributes": {
11
      "_capture": true,
12
      "_capture_amount_cents": 500
13
    }
14
  }
15
}'
Copied!
On success, the API responds with a 200 OK status code, returning the updated resource object:
1
{
2
  "data": {
3
    "id": "xYZkjABcde",
4
    "type": "authorizations",
5
    "links": {
6
      "self": "https://yourdomain.commercelayer.io/api/authorizations/xYZkjABcde"
7
    },
8
    "attributes": {
9
      "number": "42/T/001",
10
      "currency_code": "EUR",
11
      "amount_cents": 1500,
12
      "amount_float": 15.0,
13
      "formatted_amount": "€15,00",
14
      "succeeded": false,
15
      "message": "Accepted",
16
      "error_code": "00001",
17
      "error_detail": "Already settled",
18
      "token": "xxxx-yyyy-zzzz",
19
      "gateway_transaction_id": "xxxx-yyyy-zzzz",
20
      "created_at": "2018-01-01T12:00:00.000Z",
21
      "updated_at": "2018-01-01T12:00:00.000Z",
22
      "reference": "ANY-EXTERNAL-REFEFERNCE",
23
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
24
      "metadata": {
25
        "foo": "bar"
26
      },
27
      "cvv_code": "000",
28
      "cvv_message": "validated",
29
      "avs_code": "000",
30
      "avs_message": "validated",
31
      "fraud_review": "passed",
32
      "capture_amount_cents": 500,
33
      "capture_amount_float": 5.0,
34
      "formatted_capture_amount": "€5,00",
35
      "capture_balance_cents": 1000,
36
      "capture_balance_float": 10.0,
37
      "formatted_capture_balance": "€10,00",
38
      "void_balance_cents": 1500,
39
      "void_balance_float": 15.0,
40
      "formatted_void_balance": "€15,00"
41
    },
42
    "relationships": {
43
      "order": {
44
        "links": {
45
          "self": "https://yourdomain.commercelayer.io/api/authorizations/xYZkjABcde/relationships/order",
46
          "related": "https://yourdomain.commercelayer.io/api/authorizations/xYZkjABcde/order"
47
        }
48
      },
49
      "captures": {
50
        "links": {
51
          "self": "https://yourdomain.commercelayer.io/api/authorizations/xYZkjABcde/relationships/captures",
52
          "related": "https://yourdomain.commercelayer.io/api/authorizations/xYZkjABcde/captures"
53
        }
54
      },
55
      "voids": {
56
        "links": {
57
          "self": "https://yourdomain.commercelayer.io/api/authorizations/xYZkjABcde/relationships/voids",
58
          "related": "https://yourdomain.commercelayer.io/api/authorizations/xYZkjABcde/voids"
59
        }
60
      }
61
    },
62
    "meta": {
63
      "mode": "test"
64
    }
65
  }
66
}
Copied!

Retrieve an authorization

Avalara accounts

Last modified 5mo ago

Copy link

Contents

Request

Arguments

Example