Flywire

App · 25 actions

Take and track cross-border payments with Flywire: price quotes in the payer's currency, payment links, payments, refunds, refund approvals, disbursements and recurring plans.

Actions

ActionWhat it does
Approve refund bundleApprove a refund bundle that is waiting for your approval, so Flywire processes its refunds.
Cancel paymentCancel a payment that is initiated or failed.
Cancel recurring planCancel a recurring plan, so Flywire takes no more payments for it.
Cancel refundCancel a refund that is still initiated, before any money has moved.
Capture card pre-authorizationCharge a card payment that was only authorized (held): the amount held or less.
Create payment linkMake a link to your Flywire payment portal, filled in with the amount and the payer's details, to send to a payer.
Get disbursementGet one disbursement: what was sent, when, and how many payouts, refunds and adjustments it holds.
Get disbursement filesGet download links for a disbursement's settlement files (CSV, TXT or DAT).
Get paymentGet one payment as it is now: status, amounts, fees, the payer, how they paid and its payouts.
Get price quoteGet one price quote again by its ID, to check its price while it hasn't expired.
Get price quotesSee what a payer in a given country would pay, in their own currency and for each payment method, for an amount you bill: fees and exchange rate included.
Get recipientGet one recipient: the currency it bills in, the fields payers must fill in (such as a student ID), what payers can pay for, its payment limits and when refunds are bundled.
Get recurring planGet one recurring plan: its schedule of payments, what is paid so far and what is left.
Get refundGet one refund: its status, what you pay and what the payer gets back.
Get refund bundleGet one refund bundle: its total, status and the money Flywire received from you for it.
List disbursement adjustmentsList the credits and debits, such as surcharges, that changed a disbursement's total.
List disbursement payoutsList the payments paid out in a disbursement.
List disbursement refundsList the refunds taken out of a disbursement.
List disbursementsList the disbursements Flywire has sent to your bank, filtered by recipient or delivery date.
List paymentsList payments created through your Flywire API key, filtered by recipient, status or creation date.
List recipientsList the recipients (portals) your Flywire account takes payments for, with their IDs.
List recurring plansList recurring (installment) plans Flywire runs for you, filtered by payer, recipient, status or creation date.
List refund bundlesList refund bundles, the groups of refunds Flywire processes together, such as the ones waiting for your approval.
List refundsList refunds, filtered by payment, status, recipient, refund bundle or creation date.
Refund paymentRefund all or part of a delivered payment.

Approve refund bundle

Approve a refund bundle that is waiting for your approval, so Flywire processes its refunds.

Inputs

Refund bundlebundle_idtextRequired
The refund bundle. Pick one, or give its ID from an earlier step.

Outputs

bundle_idtext
The bundle approved
statustext
Its status: approved
Example output
{
  "bundle_id": "BUDRW1234567",
  "status": "approved"
}

Cancel payment

Cancel a payment that is initiated or failed. If Flywire already has the funds it returns them to the payer; a card pre-authorization is released at once.

Inputs

Paymentpayment_idtextRequired
The payment. Pick one, or give its ID from an earlier step.

Outputs

cancelledtrue/false
Always true once cancelled
payment_idtext
The payment cancelled
Example output
{
  "cancelled": true,
  "payment_id": "FWU125675432"
}

Cancel recurring plan

Cancel a recurring plan, so Flywire takes no more payments for it.

Inputs

Recurring planplan_idtextRequired
The recurring plan. Pick one, or give its ID from an earlier step.

Outputs

cancelledtrue/false
Always true once cancelled
plan_idtext
The plan cancelled
Example output
{
  "cancelled": true,
  "plan_id": "IPTQQ191E6DBE533"
}

Cancel refund

Cancel a refund that is still initiated, before any money has moved.

Inputs

Refundrefund_idtextRequired
The refund. Pick one, or give its ID from an earlier step.

Outputs

cancelledtrue/false
Always true once cancelled
refund_idtext
The refund cancelled
Example output
{
  "cancelled": true,
  "refund_id": "RFLW23456432"
}

Capture card pre-authorization

Charge a card payment that was only authorized (held): the amount held or less. Whatever isn't captured goes back to the cardholder.

Inputs

Paymentpayment_idtextRequired
The payment. Pick one, or give its ID from an earlier step.
Amount to captureamountnumberRequired
Up to the amount held. A whole number in the smallest unit of the recipient's currency: 12025 for 120.25 USD, 120 for 120 JPY.At least 1.

Outputs

The charge

charge_infoobject
What was charged
charge_resultobject
How the charge went
payment_referencetext
The payment reference
Example output
{
  "charge_info": {
    "amount": 70000,
    "currency": "EUR"
  },
  "charge_result": {
    "status": "received"
  },
  "payment_reference": "TQQ921794790"
}

Make a link to your Flywire payment portal, filled in with the amount and the payer's details, to send to a payer. It works until a payment is made with it, or for up to 90 days. Needs the Shared Secret on your Flywire connection.

Inputs

Portal namepayment_destinationtextRequired
Your Flywire portal's name, such as flywireuniversity. Flywire gave it to you when it set up your portal.
Amountamountnumber
The amount to ask for. A whole number in the smallest unit of the recipient's currency: 12025 for 120.25 USD, 120 for 120 JPY.At least 1.
Most the payer can paymax_amountnumber
Lets the payer pay less, up to this. Usually the same as Amount. A whole number in the smallest unit of the recipient's currency: 12025 for 120.25 USD, 120 for 120 JPY.At least 1.
Payer's countrycountrytext
Where the money is sent from, as a two-letter code such as US.
Payer's emailpayer_emailtext
The payer's email address.
Payer's first namepayer_first_nametext
For a company, its name.
Payer's last namepayer_last_nametext
For a company, its name.
Payer's addresspayer_addresstext
The first line of their home address. Not a PO box.
Payer's citypayer_citytext
The payer's city.
Payer's statepayer_statetext
The state code, such as NY.
Payer's postal codepayer_ziptext
The payer's postal or ZIP code.
Payer's phonepayer_phonetext
With the country code, such as +44123456.
Payer can change their detailspayer_can_edittext
Whether the payer can change the details filled in. Defaults to no.One of: no (No, what I fill in is fixed), yes (Yes, the payer can change it).
Portal fieldsrecipient_fieldsobject
Values for your portal's own fields, by field ID, such as student_id. 'Get recipient' lists them. The payer can't change them.
Days until it expiresdays_to_expirenumber
1 to 90. Defaults to 90.From 1 to 90.
Languagelocaletext
The portal's language. Defaults to the payer's browser language.One of: en (English), es-ES (Spanish), zh-CN (Chinese), ko-KR (Korean), pt-PT (Portuguese), ja-JP (Japanese), fr-FR (French), id-ID (Bahasa Indonesia), ar-SA (Arabic), vi-VN (Vietnamese), and 3 more.
Return button addressreturn_urltext
An https:// address for a button shown once the payer has made the payment, such as your website.
Return button labelreturn_button_labeltext
The button's words. Defaults to Return to your portal's name.
Notifications addressnotifications_urltext
An https:// address Flywire tells about this payment's progress, such as a webhook workflow's address.
Your referenceexternal_referencetext
Your own reference, such as an invoice number, up to 50 characters. Flywire includes it in every notification.

Outputs

payment_destinationtext
The portal it opens
urltext
The link to send to the payer
Example output
{
  "payment_destination": "flywireuniversity",
  "url": "https://payment.flywire.com/orders/4bee6c2c-ae10-465c-ba84-1a978e11681a?token=5e03c2cb-2877-47d8-8226-fbfbf62361b3"
}

Get disbursement

Get one disbursement: what was sent, when, and how many payouts, refunds and adjustments it holds.

Inputs

Disbursementdisbursement_idtextRequired
The disbursement. Pick one, or give its ID from an earlier step.

Outputs

disbursementobject
A disbursement: one transfer of funds from Flywire to your bank
Example output
{
  "disbursement": {
    "amount": 1000000,
    "bank_account_number": "XXX5677",
    "currency": "USD",
    "delivered_at": "2026-06-13T17:22:22Z",
    "disbursement_id": "FWU2026-06-13",
    "number_of_adjustments": 0,
    "number_of_payments": 37,
    "number_of_refunds": 0,
    "recipient_id": "FWU",
    "status": "delivered"
  }
}

Get disbursement files

Get download links for a disbursement's settlement files (CSV, TXT or DAT). The links expire, so download them in the same workflow.

Inputs

Disbursementdisbursement_idtextRequired
The disbursement. Pick one, or give its ID from an earlier step.

Outputs

countnumber
How many were returned
disbursement_idtext
The disbursement read
fileslist
The settlement files
Example output
{
  "count": 1,
  "disbursement_id": "FWU2026-06-13",
  "files": [
    {
      "name": "FWU2026-06-13.txt",
      "url": "https://s3.amazonaws.com/example-bucket/FWU2026-06-13.txt"
    }
  ]
}

Get payment

Get one payment as it is now: status, amounts, fees, the payer, how they paid and its payouts.

Inputs

Paymentpayment_idtextRequired
The payment. Pick one, or give its ID from an earlier step.

Outputs

paymentobject
The payment
Example output
{
  "payment": {
    "adjustments": [
      {
        "category": "service",
        "minimum_fee": null,
        "proportion": 0.015
      }
    ],
    "amount_from": 94000,
    "amount_to": 100000,
    "created_at": "2023-02-14T14:06:32Z",
    "currency_from": "EUR",
    "currency_to": "USD",
    "disbursement_id": null,
    "expiration_date": "2023-02-16T14:06:32Z",
    "external_reference": "My internal reference",
    "items": [
      {
        "amount": 100000,
        "id": "default"
      }
    ],
    "metadata": {
      "MyOwnMetadata": "My system info about the payment"
    },
    "notifications_url": "https://example.com/flywire",
    "payer": {
      "address1": "789 Calle Mayor",
      "address2": null,
      "city": "Madrid",
      "country": "ES",
      "email": "payer@example.com",
      "first_name": "Peter",
      "last_name": "Payer",
      "middle_name": null,
      "phone": "0034912345678",
      "state": null,
      "zip": "28013"
    },
    "payment_id": "RUC928923284",
    "payment_method_details": {
      "brand": "VISA",
      "card_classification": "credit",
      "card_expiration": "3/2030",
      "last_four_digits": "1111",
      "name": "Debit/Credit in USD",
      "reason": {
        "code": "012",
        "description": "Your transaction has been declined by your bank."
      },
      "status": "failed",
      "type": "card"
    },
    "payouts": [
      {
        "amount": 86300,
        "currency": "GBP",
        "disbursement_id": "RUC2018-02-26",
        "recipient_id": "RUC",
        "reference": "PRUC642678730",
        "status": "notified"
      }
    ],
    "recipient": {
      "fields": [
        {
          "id": "student_id",
          "value": "ID12345"
        }
      ],
      "id": "RUC"
    },
    "status": "initiated",
    "status_detail": "processing",
    "status_transitions": {
      "authorized_at": null,
      "cancelled_at": null,
      "delivered_at": null,
      "guaranteed_at": null
    }
  }
}

Get price quote

Get one price quote again by its ID, to check its price while it hasn't expired.

Inputs

Price quote IDoffer_idtextRequired
The quote's ID, from 'Get price quotes'.

Outputs

offerobject
A price quote: what the payer pays with one payment method
Example output
{
  "offer": {
    "adjustments": [],
    "amount_from": 115811,
    "amount_to": 100000,
    "currency_from": "USD",
    "currency_to": "EUR",
    "exchange_rate": 0.863475836,
    "expires_at": "2026-08-14T15:08:51Z",
    "id": "01a000b6-2118-7d73-b6fd-330e2b6becbd",
    "name": "Debit/Credit Card in USD",
    "payment_method_settings": {
      "accepted_brands": [
        "VISA",
        "MC"
      ],
      "accepted_card_classification": [
        "DEBIT",
        "CREDIT"
      ]
    },
    "recurring": false,
    "type": "card"
  }
}

Get price quotes

See what a payer in a given country would pay, in their own currency and for each payment method, for an amount you bill: fees and exchange rate included. Each quote's price holds until it expires.

Inputs

Recipientrecipient_idtextRequired
The recipient (portal) to use. Pick one, or give its ID, such as FWU.
Amount you billamountnumberRequired
What you want to receive. A whole number in the smallest unit of the recipient's currency: 12025 for 120.25 USD, 120 for 120 JPY.At least 1.
Payer's countrycountrytextRequired
Where the money is sent from, as a two-letter code such as DE.
Payer's currencypayer_currencytext
Only quotes in this currency, as a three-letter code such as EUR. Leave empty for every currency on offer.
Payment methodpayment_typetext
Only quotes for this kind of payment. Leave empty for all.One of: card, bank_transfer (Bank transfer), direct_debit (Direct debit), online (Other online methods).
Recurringrecurringtext
Only methods that can or can't repeat. Leave empty for both.One of: true (Only methods that can repeat (recurring)), false (Only one-off methods).

Outputs

countnumber
How many were returned
offerslist
The price quotes, one per payment method
Example output
{
  "count": 1,
  "offers": [
    {
      "adjustments": [],
      "amount_from": 115811,
      "amount_to": 100000,
      "currency_from": "USD",
      "currency_to": "EUR",
      "exchange_rate": 0.863475836,
      "expires_at": "2026-08-14T15:08:51Z",
      "id": "01a000b6-2118-7d73-b6fd-330e2b6becbd",
      "name": "Debit/Credit Card in USD",
      "payment_method_settings": {
        "accepted_brands": [
          "VISA",
          "MC"
        ],
        "accepted_card_classification": [
          "DEBIT",
          "CREDIT"
        ]
      },
      "recurring": false,
      "type": "card"
    }
  ]
}

Get recipient

Get one recipient: the currency it bills in, the fields payers must fill in (such as a student ID), what payers can pay for, its payment limits and when refunds are bundled.

Inputs

Recipientrecipient_idtextRequired
The recipient (portal) to use. Pick one, or give its ID, such as FWU.
Languagelocaletext
The language for field labels. Defaults to English.One of: en (English), es-ES (Spanish), zh-CN (Chinese), ko (Korean), pt-PT (Portuguese), ja (Japanese), fr-FR (French), id (Bahasa Indonesia), ar (Arabic), vi (Vietnamese), it-IT (Italian), de-DE (German).

Outputs

recipientobject
The recipient
Example output
{
  "recipient": {
    "address": "London Street",
    "address2": "",
    "city": "London",
    "country": "GB",
    "currency": "GBP",
    "email": "",
    "external_code": "",
    "fields": [
      {
        "format": "text",
        "id": "student_id",
        "pattern": "^[f|F]\\d{8}$",
        "pattern_message": "The ID begins with F followed by 8 digits",
        "required": true,
        "type": "string",
        "value": "",
        "view_options": {
          "help": null,
          "hidden": false,
          "hint": null,
          "label": "Student ID",
          "placeholder": null,
          "position": 4,
          "section_description": "Please provide us the following details",
          "section_identifier": "student_information",
          "section_name": "Student Information"
        }
      },
      {
        "format": "",
        "id": "student_status",
        "pattern": null,
        "pattern_message": null,
        "required": false,
        "type": "string",
        "value": [
          {
            "label": "Full-time",
            "value": "full_time"
          },
          {
            "label": "Part-Time",
            "value": "part_time"
          }
        ],
        "view_options": null
      }
    ],
    "id": "FWU",
    "items": [
      {
        "currency": "GBP",
        "id": "default",
        "label": "Amount"
      }
    ],
    "logo_url": "https://example.com/logo.png",
    "name": "Flywire University",
    "refund_bundle_cut_off": {
      "approval_type": "manual",
      "next_cutoff_time": "2023-12-22T09:47:06.090Z",
      "periodicity": "weekly"
    },
    "settings": {
      "amount_limits": {
        "maximum_amount": 11004758,
        "minimum_amount": 3668
      }
    },
    "state": "London",
    "website": "",
    "zip": ""
  }
}

Get recurring plan

Get one recurring plan: its schedule of payments, what is paid so far and what is left.

Inputs

Recurring planplan_idtextRequired
The recurring plan. Pick one, or give its ID from an earlier step.

Outputs

planobject
The recurring plan
Example output
{
  "plan": {
    "amount_paid_value": 300000,
    "charges": [
      {
        "amount": 300000,
        "currency": "EUR",
        "id": 1801,
        "payment_id": "TQQ294328372",
        "scheduled_at": "2024-09-13T15:30:55.000+00:00",
        "status": "delivered"
      },
      {
        "amount": 300000,
        "currency": "EUR",
        "id": 1802,
        "payment_id": null,
        "scheduled_at": "2024-10-12T15:30:55.000+00:00",
        "status": null
      }
    ],
    "created_at": "2024-09-12T15:30:56Z",
    "currency": "EUR",
    "next_installment_date": "2024-10-12T15:30:55.000+00:00",
    "number_of_installments": 3,
    "payor_id": "my_payer_id",
    "recipient": {
      "fields": [
        {
          "id": "student_id",
          "value": "ID12345"
        }
      ],
      "id": "FWU"
    },
    "recurring_id": "IPTQQ191E6DBE533",
    "recurring_receivables_end_date": "2024-11-12T16:30:55.000+00:00",
    "recurring_receivables_start_date": "2024-09-12T15:30:55.000+00:00",
    "remaining_amount_value": 600000,
    "status": "in_progress",
    "total_amount": 900000
  }
}

Get refund

Get one refund: its status, what you pay and what the payer gets back.

Inputs

Refundrefund_idtextRequired
The refund. Pick one, or give its ID from an earlier step.

Outputs

refundobject
The refund
Example output
{
  "refund": {
    "amount": 12000,
    "amount_to": 10000,
    "bundle_id": "BUDR123456HG",
    "created_at": "2024-01-02T08:43:38Z",
    "currency": "USD",
    "currency_to": "EUR",
    "external_reference": "My reference",
    "payer": {
      "address1": "789 Calle Mayor",
      "address2": null,
      "city": "Madrid",
      "country": "ES",
      "email": "payer@example.com",
      "first_name": "Peter",
      "last_name": "Payer",
      "middle_name": null,
      "phone": "0034912345678",
      "state": null,
      "zip": "28013"
    },
    "payment_id": "FLW990764382",
    "recipient_id": "FLW",
    "refund_id": "RFLW12345678",
    "status": "cancelled",
    "status_transitions": {
      "cancelled_at": "2024-01-03T15:40:50Z"
    }
  }
}

Get refund bundle

Get one refund bundle: its total, status and the money Flywire received from you for it.

Inputs

Refund bundlebundle_idtextRequired
The refund bundle. Pick one, or give its ID from an earlier step.

Outputs

refund_bundleobject
The refund bundle
Example output
{
  "refund_bundle": {
    "amount": 12000,
    "approved_at": "2017-12-06 17:41:27 UTC",
    "bundle_id": "BUDREB8E4538",
    "created_at": "2017-12-06 17:41:27 UTC",
    "currency": "USD",
    "marked_for_approval": "false",
    "notifications_url": "https://example.com/flywire/refunds",
    "reception": {
      "account_number": null,
      "amount": 12000,
      "bank_reference": null,
      "currency": "USD",
      "date": "2019-01-11"
    },
    "recipient_id": "EBS",
    "status": "approved"
  }
}

List disbursement adjustments

List the credits and debits, such as surcharges, that changed a disbursement's total. Gets one page.

Inputs

Disbursementdisbursement_idtextRequired
The disbursement. Pick one, or give its ID from an earlier step.
Pagepagenumber
Which page to get, from 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Flywire's default is 10.From 1 to 100.

Outputs

adjustmentslist
The adjustments
disbursement_idtext
The disbursement read
pagenumber
This page's number
per_pagenumber
How many fit on a page
total_entriesnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "adjustments": [
    {
      "amount": 60000,
      "category": "surcharge",
      "currency": "USD",
      "entity": "payment",
      "entity_reference": "FWU928923284",
      "entry_type": "credit",
      "reference": "ADJ260612052533CMGDE"
    }
  ],
  "disbursement_id": "FWU2025-12-31",
  "page": 1,
  "per_page": 10,
  "total_entries": 1,
  "total_pages": 1
}

List disbursement payouts

List the payments paid out in a disbursement. Gets one page.

Inputs

Disbursementdisbursement_idtextRequired
The disbursement. Pick one, or give its ID from an earlier step.
Pagepagenumber
Which page to get, from 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Flywire's default is 10.From 1 to 100.

Outputs

disbursement_idtext
The disbursement read
pagenumber
This page's number
payoutslist
The payouts
per_pagenumber
How many fit on a page
total_entriesnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "disbursement_id": "FWU2025-12-31",
  "page": 1,
  "payouts": [
    {
      "amount": 20000,
      "currency": "GBP",
      "payment_id": "FWU744586810",
      "recipient_id": "FWU",
      "reference": "PFWU744586810",
      "status": "notified"
    }
  ],
  "per_page": 10,
  "total_entries": 1,
  "total_pages": 1
}

List disbursement refunds

List the refunds taken out of a disbursement. Gets one page.

Inputs

Disbursementdisbursement_idtextRequired
The disbursement. Pick one, or give its ID from an earlier step.
Pagepagenumber
Which page to get, from 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Flywire's default is 10.From 1 to 100.

Outputs

disbursement_idtext
The disbursement read
pagenumber
This page's number
per_pagenumber
How many fit on a page
refundslist
The refunds
total_entriesnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "disbursement_id": "FWU2025-12-31",
  "page": 1,
  "per_page": 10,
  "refunds": [
    {
      "amount": 654334,
      "currency": "GBP",
      "payment": {
        "external_reference": "67893",
        "id": "FWU787203662"
      },
      "refund_id": "RFWU1CB69313"
    }
  ],
  "total_entries": 1,
  "total_pages": 1
}

List disbursements

List the disbursements Flywire has sent to your bank, filtered by recipient or delivery date. Your Flywire account needs disbursements turned on. Gets one page.

Inputs

Recipientsrecipient_idslist
Only these recipients, up to 10. Leave empty for all of them.
Delivered on or afterdelivered_fromdate
Only those delivered on or after this date.
Delivered on or beforedelivered_todate
Only those delivered on or before this date.
Pagepagenumber
Which page to get, from 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Flywire's default is 10.From 1 to 100.

Outputs

disbursementslist
The disbursements
pagenumber
This page's number
per_pagenumber
How many fit on a page
total_entriesnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "disbursements": [
    {
      "amount": 1000000,
      "bank_account_number": "XXX5677",
      "currency": "USD",
      "delivered_at": "2026-06-13T17:22:22Z",
      "disbursement_id": "FWU2026-06-13",
      "number_of_adjustments": 0,
      "number_of_payments": 37,
      "number_of_refunds": 0,
      "recipient_id": "FWU",
      "status": "delivered"
    }
  ],
  "page": 1,
  "per_page": 10,
  "total_entries": 1,
  "total_pages": 1
}

List payments

List payments created through your Flywire API key, filtered by recipient, status or creation date. It can lag a few minutes behind; 'Get payment' is always current. Gets one page.

Inputs

Recipientsrecipient_idslist
Only these recipients, up to 10. Leave empty for all of them.
Statusstatustext
Only payments now in this status. Leave empty for all.One of: initiated (Initiated (no funds yet)), processed (Processed (funds received or captured)), guaranteed (Guaranteed (Flywire will send the funds)), delivered (Delivered (funds sent to you)), failed, cancelled, reversed.
Created on or aftercreated_fromdate
Only those created on or after this date.
Created on or beforecreated_todate
Only those created on or before this date.
Pagepagenumber
Which page to get, from 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Flywire's default is 10.From 1 to 100.

Outputs

pagenumber
This page's number
paymentslist
The payments
per_pagenumber
How many fit on a page
total_entriesnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "page": 1,
  "payments": [
    {
      "amount_from": 50000,
      "amount_to": 50000,
      "created_at": "2024-04-30T06:37:19Z",
      "currency_from": "EUR",
      "currency_to": "EUR",
      "disbursement_id": "TQQ2024-04-30",
      "expiration_date": "2024-05-03T06:37:19Z",
      "external_reference": "My external reference",
      "payment_id": "TQQ871958420",
      "payor_id": "My_payer_1",
      "status": "delivered",
      "status_transitions": {
        "authorized_at": null,
        "cancelled_at": null,
        "delivered_at": "2024-04-30T06:37:57Z",
        "guaranteed_at": "2024-04-30T06:37:32Z"
      }
    }
  ],
  "per_page": 10,
  "total_entries": 1,
  "total_pages": 1
}

List recipients

List the recipients (portals) your Flywire account takes payments for, with their IDs. Gets one page; run it again with the next page number to see more.

Inputs

Pagepagenumber
Which page to get, from 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Flywire's default is 10.From 1 to 100.

Outputs

pagenumber
This page's number
per_pagenumber
How many fit on a page
recipientslist
The recipients
total_entriesnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "page": 1,
  "per_page": 10,
  "recipients": [
    {
      "country": "US",
      "external_code": "E00212",
      "id": "FWU",
      "name": "Flywire University",
      "state": "IN"
    }
  ],
  "total_entries": 1,
  "total_pages": 1
}

List recurring plans

List recurring (installment) plans Flywire runs for you, filtered by payer, recipient, status or creation date. Gets one page.

Inputs

Payer IDpayor_idtext
Only this payer's plans: the payer ID your system gave Flywire.
Recipientsrecipient_idslist
Only these recipients, up to 10. Leave empty for all of them.
Statusstatustext
Only plans in this status. Leave empty for all.One of: in_progress (In progress), finished, cancelled.
Created oncreated_ondate
Only plans created on this date.
Pagepagenumber
Which page to get, from 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Flywire's default is 10.From 1 to 100.

Outputs

pagenumber
This page's number
per_pagenumber
How many fit on a page
recurring_planslist
The recurring plans
total_entriesnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "page": 1,
  "per_page": 10,
  "recurring_plans": [
    {
      "created_at": "2024-04-05T11:09:46Z",
      "external_reference": "My external reference",
      "notifications_url": "https://example.com/flywire",
      "number_of_installments": 4,
      "payor_id": "my_payer_id_1",
      "recipient_id": "TQQ",
      "recurring_id": "IPTQQ18EADF349BE",
      "status": "in_progress",
      "total_amount": 50000
    }
  ],
  "total_entries": 1,
  "total_pages": 1
}

List refund bundles

List refund bundles, the groups of refunds Flywire processes together, such as the ones waiting for your approval. Gets one page.

Inputs

Statusstatustext
Only bundles in this status. Leave empty for all.One of: pending, approved, debited, received.
Waiting for approvalmarked_for_approvaltext
Filter by whether they wait for your approval. Can't be used with Status.One of: true (Only bundles waiting for approval), false (Only bundles not waiting for approval).
Recipientsrecipient_idslist
Only these recipients, up to 10. Leave empty for all of them.
Created on or aftercreated_fromdate
Only those created on or after this date.
Created on or beforecreated_todate
Only those created on or before this date.
Pagepagenumber
Which page to get, from 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Flywire's default is 10.From 1 to 100.

Outputs

pagenumber
This page's number
per_pagenumber
How many fit on a page
refund_bundleslist
The refund bundles
total_entriesnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "page": 1,
  "per_page": 10,
  "refund_bundles": [
    {
      "amount": 115000,
      "created_at": "2022-07-21T17:27:54Z",
      "currency": "GBP",
      "id": "BUDREB8E4538",
      "marked_for_approval": true,
      "recipient_id": "EBS",
      "status": "pending"
    }
  ],
  "total_entries": 1,
  "total_pages": 1
}

List refunds

List refunds, filtered by payment, status, recipient, refund bundle or creation date. Gets one page.

Inputs

Paymentpayment_idtext
Only refunds of this payment. Leave empty for all.
Statusstatustext
Only refunds now in this status. Leave empty for all.One of: initiated, received (Received (Flywire has the money)), finished (Finished (the payer has it)), returned (Returned to you), cancelled, failed.
Recipientsrecipient_idslist
Only these recipients, up to 10. Leave empty for all of them.
Refund bundlebundle_idtext
Only refunds in this bundle. Leave empty for all.
Created on or aftercreated_fromdate
Only those created on or after this date.
Created on or beforecreated_todate
Only those created on or before this date.
Pagepagenumber
Which page to get, from 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Flywire's default is 10.From 1 to 100.

Outputs

pagenumber
This page's number
per_pagenumber
How many fit on a page
refundslist
The refunds
total_entriesnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "page": 1,
  "per_page": 10,
  "refunds": [
    {
      "amount": 10000,
      "bundle_id": "BUDR123456HG",
      "created_at": "2023-12-04T14:07:01Z",
      "currency": "USD",
      "external_reference": "a-reference",
      "payment_id": "RUC990764382",
      "recipient_id": "RUC",
      "refund_id": "RRUC247B58FE",
      "status": "initiated"
    }
  ],
  "total_entries": 1,
  "total_pages": 1
}

Refund payment

Refund all or part of a delivered payment. A payment can have one refund under way at a time, and refunds can't add up to more than it.

Inputs

Paymentpayment_idtextRequired
The payment. Pick one, or give its ID from an earlier step.
Amount to refundamountnumberRequired
In the payment's billing currency. A whole number in the smallest unit of the recipient's currency: 12025 for 120.25 USD, 120 for 120 JPY.At least 1.
Your referenceexternal_referencetext
Your own reference, such as an invoice number, up to 50 characters. Flywire includes it in every notification.
Notifications addressnotifications_urltext
An https:// address Flywire tells about the refund's progress. Leave empty to use the payment's.
Emails to the payerpayer_emailstext
Who tells the payer about the refund. Flywire's default is that you do.One of: flywire (Flywire emails the payer), self (I email the payer myself).

Outputs

refundobject
The refund
Example output
{
  "refund": {
    "amount": 10000,
    "bundle_id": "BUDR12345678",
    "currency": "USD",
    "external_reference": "my-refunds-29",
    "notifications_url": "https://example.com/flywire/refunds",
    "payment_id": "UUI123456789",
    "refund_id": "RUUI12345678",
    "status": "pending"
  }
}

On this page