createdTime | string (date-time) | Read-only | When Flyra accepted the transfer. ISO 8601, UTC. |
customerId | string (uuid) | Yes | The customer the transfer is initiated for. |
destination | object | Yes | One end of the transfer, with its own currency and amount, so a transfer can change currency. Identify it by paymentInstrumentId or by type, not both. instrumentType and country are not accepted. |
destination.amount | string | No | Decimal string in this side's currency. Send it on the source only: Flyra prices the transfer from it and fills in the destination amount, which is ignored on a request. |
destination.bankAccountDetails | object | No | Returned when this side's type is PROVIDED_BANK_ACCOUNT: where the customer pays in to complete the deposit. The fields present follow bankAccountType. The transfer stays PENDING until the customer pays. |
destination.bankAccountDetails.accountHolderName | string | No | Every type. |
destination.bankAccountDetails.accountNumber | string | No | USD_DEPOSIT_ACCOUNT and NGN_DEPOSIT_ACCOUNT. |
destination.bankAccountDetails.bankAccountType | enum | No | Which fields are populated. The NGN, UGX and KES types populate accountHolderName, accountNumber and bankName. A GB deposit populates those fields too and carries no type.USD_DEPOSIT_ACCOUNTEUR_DEPOSIT_ACCOUNTMXN_SPEI_DEPOSIT_ACCOUNTNGN_DEPOSIT_ACCOUNTUGX_DEPOSIT_ACCOUNTKES_DEPOSIT_ACCOUNTBRL_PIX_DEPOSIT_ACCOUNTCOP_BRE_B_DEPOSIT_ACCOUNT
|
destination.bankAccountDetails.bankName | string | No | NGN_DEPOSIT_ACCOUNT. The bank holding the account, which the payer needs. |
destination.bankAccountDetails.bic | string | No | EUR_DEPOSIT_ACCOUNT. |
destination.bankAccountDetails.breBKey | string | No | COP_BRE_B_DEPOSIT_ACCOUNT. The Bre-B key the customer pays to. |
destination.bankAccountDetails.clabe | string | No | MXN_SPEI_DEPOSIT_ACCOUNT. |
destination.bankAccountDetails.depositMessage | string | No | A reference the payer must include, where the corridor requires one. |
destination.bankAccountDetails.iban | string | No | EUR_DEPOSIT_ACCOUNT. |
destination.bankAccountDetails.id | string (uuid) | No | |
destination.bankAccountDetails.pixCopiaECola | string | No | BRL_PIX_DEPOSIT_ACCOUNT. The EMV BR Code to display. |
destination.bankAccountDetails.routingNumber | string | No | USD_DEPOSIT_ACCOUNT. |
destination.currency | string | Yes | ISO 4217 code of the funds on this side. A deposit is quoted in the customer's local currency on the source side (NGN for a Nigerian deposit); every other transfer in USD. Send USD on a side the Flyra wallet is on, even though its balance reads USDB. |
destination.id | string (uuid) | No | |
destination.paymentInstrumentId | string (uuid) | Conditional | An instrument Flyra manages; required unless type is sent. Not a virtual account (OWNED_VIRTUAL_BANK_ACCOUNT), which only receives money: use the wallet. Source and destination must be different instruments. Either mistake is refused with 422 VALIDATION_FAILED. |
destination.type | enum | No | Sent instead of paymentInstrumentId for a side Flyra does not hold. CUSTOMER_EXTERNAL_BANK_ACCOUNT and CUSTOMER_EXTERNAL_CRYPTO_ACCOUNT are any bank or crypto account the customer owns. PROVIDED_BANK_ACCOUNT is a one-time account Flyra creates to accept a deposit; its details come back in bankAccountDetails.CUSTOMER_EXTERNAL_BANK_ACCOUNTCUSTOMER_EXTERNAL_CRYPTO_ACCOUNTPROVIDED_BANK_ACCOUNT
|
disclaimer | string | Read-only | Text to show the customer, where the corridor requires one. |
expiresAt | integer | Read-only | When the deposit instructions stop being valid, as Unix epoch milliseconds UTC. Present only while a deposit is outstanding. |
expiresIn | object | Read-only | How long the deposit instructions stay valid, as a value and unit. Show this rather than computing it from expiresAt. |
expiresIn.unit | string | Read-only | |
expiresIn.value | integer | Read-only | |
fees | object | Read-only | |
fees.amount | string | Read-only | Decimal string. |
fees.currency | string | Read-only | |
id | string (uuid) | Read-only | |
rate | number | Read-only | The rate Flyra applied between the two sides. Present on a converting transfer only. |
source | object | Yes | One end of the transfer, with its own currency and amount, so a transfer can change currency. Identify it by paymentInstrumentId or by type, not both. instrumentType and country are not accepted. |
source.amount | string | No | Decimal string in this side's currency. Send it on the source only: Flyra prices the transfer from it and fills in the destination amount, which is ignored on a request. |
source.bankAccountDetails | object | No | Returned when this side's type is PROVIDED_BANK_ACCOUNT: where the customer pays in to complete the deposit. The fields present follow bankAccountType. The transfer stays PENDING until the customer pays. |
source.bankAccountDetails.accountHolderName | string | No | Every type. |
source.bankAccountDetails.accountNumber | string | No | USD_DEPOSIT_ACCOUNT and NGN_DEPOSIT_ACCOUNT. |
source.bankAccountDetails.bankAccountType | enum | No | Which fields are populated. The NGN, UGX and KES types populate accountHolderName, accountNumber and bankName. A GB deposit populates those fields too and carries no type.USD_DEPOSIT_ACCOUNTEUR_DEPOSIT_ACCOUNTMXN_SPEI_DEPOSIT_ACCOUNTNGN_DEPOSIT_ACCOUNTUGX_DEPOSIT_ACCOUNTKES_DEPOSIT_ACCOUNTBRL_PIX_DEPOSIT_ACCOUNTCOP_BRE_B_DEPOSIT_ACCOUNT
|
source.bankAccountDetails.bankName | string | No | NGN_DEPOSIT_ACCOUNT. The bank holding the account, which the payer needs. |
source.bankAccountDetails.bic | string | No | EUR_DEPOSIT_ACCOUNT. |
source.bankAccountDetails.breBKey | string | No | COP_BRE_B_DEPOSIT_ACCOUNT. The Bre-B key the customer pays to. |
source.bankAccountDetails.clabe | string | No | MXN_SPEI_DEPOSIT_ACCOUNT. |
source.bankAccountDetails.depositMessage | string | No | A reference the payer must include, where the corridor requires one. |
source.bankAccountDetails.iban | string | No | EUR_DEPOSIT_ACCOUNT. |
source.bankAccountDetails.id | string (uuid) | No | |
source.bankAccountDetails.pixCopiaECola | string | No | BRL_PIX_DEPOSIT_ACCOUNT. The EMV BR Code to display. |
source.bankAccountDetails.routingNumber | string | No | USD_DEPOSIT_ACCOUNT. |
source.currency | string | Yes | ISO 4217 code of the funds on this side. A deposit is quoted in the customer's local currency on the source side (NGN for a Nigerian deposit); every other transfer in USD. Send USD on a side the Flyra wallet is on, even though its balance reads USDB. |
source.id | string (uuid) | No | |
source.paymentInstrumentId | string (uuid) | Conditional | An instrument Flyra manages; required unless type is sent. Not a virtual account (OWNED_VIRTUAL_BANK_ACCOUNT), which only receives money: use the wallet. Source and destination must be different instruments. Either mistake is refused with 422 VALIDATION_FAILED. |
source.type | enum | No | Sent instead of paymentInstrumentId for a side Flyra does not hold. CUSTOMER_EXTERNAL_BANK_ACCOUNT and CUSTOMER_EXTERNAL_CRYPTO_ACCOUNT are any bank or crypto account the customer owns. PROVIDED_BANK_ACCOUNT is a one-time account Flyra creates to accept a deposit; its details come back in bankAccountDetails.CUSTOMER_EXTERNAL_BANK_ACCOUNTCUSTOMER_EXTERNAL_CRYPTO_ACCOUNTPROVIDED_BANK_ACCOUNT
|
status | enum | Read-only | A transfer Flyra is still processing is reported as PENDING.PENDINGPOSTEDSETTLEDREFUNDEDFAILED
|
updatedTime | string (date-time) | Read-only | When the transfer last changed. ISO 8601, UTC. Compare it across webhook deliveries to discard an event that arrived out of order. |