Payments Profiles

Domain profiles defined by the Payments API. Each profile URI is the full tag tag:flywire.com,2016:agents:api:profile:{name} — the short name in the table is the suffix after the colon. They are usually advertised together with the structural hypermedia profile (and, for collection items, item).

Profile	Description
intermediated-payments	Collection of payments intermediated by the agency.
intermediated-payment-summary	Item-level shape inside an intermediated-payments collection.
intermediated-payment	Full detail of a single intermediated payment.
payment-recipients	Tree of payment recipients (destinations or groups).
payment-experience	A payment experience that has been set up for a recipient.

intermediated-payments

Representations advertising this profile comply with the intermediated-payments schema. They are always emitted together with the hypermedia and item profiles to expose pagination links.

intermediated-payment-summary

Representations advertising this profile comply with the intermediated-payment-summary schema — the item-level shape inside an intermediated-payments collection.

intermediated-payment

Representations advertising this profile comply with the intermediated-payment schema.

payment-recipients

Representations advertising this profile comply with the payment-recipients schema.

payment-experience

Representations advertising this profile comply with the payment-experience schema and will, when generated along with the hypermedia profile, expose a link with the IANA payment relation type that can be shared with the agency's clients so that they can perform the payment in the set up experience. This link will be available until we are sure the payment was initiated and will point to the same experience every time.