Commerce Layer will be proud to sponsor the next JAMstack Conf in London — 09-10 July, 2019 🎉 Stay tuned!

API REFERENCE

Wire Transfers

Wire transfers can be associated to orders as their payment sources. Being manual payments, they are always authorized.

The wire transfer object

A Wire transfer object is returned as part of the response body of each successful create, list, retrieve or update API call. The following table contains the list of all its fields along with their type, description and example values.

Object fields:
id
integer
Unique identifier for the resource.
Example:
1234
created_at
datetime
Time at which the resource was created.
Example:
2018-01-01T12:00:00.000Z
updated_at
datetime
Time at which the resource was last updated.
Example:
2018-01-01T12:00:00.000Z
reference
string
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
relationship (N:1)
The order associated to the paypal payment, that is set as its payment source.

Create a wire transfer

To create a new wire transfer, send a POST request to the /api/wire_transfers endpoint, passing the resource arguments in the request body. The following table contains the list of all the possible arguments, along with their type, description and examples values. All the arguments marked as required must be present in the request.

Arguments:
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
required
The order associated to the paypal payment, that is set as its payment source.
Example request:
POST /api/wire_transfers HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "wire_transfers",
    "relationships": {
      "order": {
        "data": {
          "type": "orders",
          "id": "1234"
        }
      }
    }
  }
}
Example response:
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "wire_transfers",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/wire_transfers/1234"
    },
    "attributes": {
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "order": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/wire_transfers/1234/relationships/order",
          "related": "https://your-brand.commercelayer.io/api/wire_transfers/1234/order"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

List all wire transfers

To fetch a collection of wire transfers, send a GET request to the /api/wire_transfers endpoint.

Example request:
GET /api/wire_transfers HTTP/1.1
Accept: application/vnd.api+json
Example response:
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "1234",
      "type": "wire_transfers",
      "links": {
        "self": "https://your-brand.commercelayer.io/api/wire_transfers/1234"
      },
      "attributes": {
        "id": "1234",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANYREFEFERNCE",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "order": {
          "links": {
            "self": "https://your-brand.commercelayer.io/api/wire_transfers/1234/relationships/order",
            "related": "https://your-brand.commercelayer.io/api/wire_transfers/1234/order"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 24 wire_transfers (first page)"
    }
  ],
  "meta": {
    "record_count": 125,
    "page_count": 5
  },
  "links": {
    "first": "/api/wire_transfers?page[number]=1&page[size]=25",
    "prev": "/api/wire_transfers?page[number]=2&page[size]=25",
    "next": "/api/wire_transfers?page[number]=4&page[size]=25",
    "last": "/api/wire_transfers?page[number]=5&page[size]=25"
  }
}
Available filters
id q reference ids created_at_from created_at_to updated_at_from updated_at_to
Sortable attributes
id created_at updated_at reference

Retrieve a wire transfer

To fetch a single wire transfer, send a GET request to the /api/wire_transfers/{{id}} endpoint, where {{id}} is the id of the resource that you want to retrieve.

Example request:
GET /api/wire_transfers/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response:
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "wire_transfers",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/wire_transfers/1234"
    },
    "attributes": {
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "order": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/wire_transfers/1234/relationships/order",
          "related": "https://your-brand.commercelayer.io/api/wire_transfers/1234/order"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Update a wire transfer

To update an existing wire transfer, send a PATCH request to the /api/wire_transfers/{{id}} endpoint, where {{id}} is the id of the resource that you want to update. The following table contains the list of all the possible arguments that you can pass with the request body, along with their type, description and examples values. Please note that all arguments are optional.

Arguments:
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
optional
The order associated to the paypal payment, that is set as its payment source.
Example request:
PATCH /api/wire_transfers/1234 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "wire_transfers",
    "id": 1234,
    "attributes": {
      "reference": "ANYREFEFERNCE"
    },
    "relationships": {
    }
  }
}
Example response:
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "wire_transfers",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/wire_transfers/1234"
    },
    "attributes": {
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "order": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/wire_transfers/1234/relationships/order",
          "related": "https://your-brand.commercelayer.io/api/wire_transfers/1234/order"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Delete a wire transfer

To delete a wire transfer, send a DELETE request to the /api/wire_transfers/{{id}} endpoint, where {{id}} is the id of the resource that you want to delete.

Example request:
DELETE /api/wire_transfers/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response:
HTTP/1.1 204 No Content