The wire transfer object

A comprehensive list of the wire transfer resource's attributes and relationships

A wire transfer object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/wire_transfers endpoint.

Fields

FieldTypeDescription

type

string

wire_transfers

id

string

The wire transfer unique identifier

links.self

string

The wire transfer endpoint URL

attributes.payment_instrument

object

Information about the payment instrument used in the transaction

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code

attributes.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.

relationships.order

object

The order associated to the wiretransfer payment, that is set as its payment source.

relationships.versions

array

The associated changes.

meta.mode

string

The resource environment (can be one of test or live)

Last updated