Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Internal Transfer

Create an internal transfer

An internal transfer is an payment between two accounts within the same Fintech.

By default, the payment is posted immediately. To indicate that you want to separate the authorization from the completion of the payment, use capture_mode = MANUAL. In that case, a separate call to update the status of the transfer will be required to complete the payment.

post/transactions/internal_transfer

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

amountinteger required

The amount (in cents) to transfer from originating account to receiving account.

capture_mode'IMMEDIATE' | 'MANUAL'

Controls when the transfer will take effect. A value of IMMEDIATE (the default) means that the transfer will be completed immediately. A value of MANUAL means that the transaction will remain in a "pending" state until explicitly completed or cancelled (or the auth expires).

currencystring required

ISO 4217 alphabetic currency code of the transfer amount

expires_atstring date-time

When capture_mode is MANUAL, this field describes when the pending transaction should expire.

final_customer_idstring uuid

The customer id of the international customer that receives the final remittance transfer (required for remittance payments).

memostring

A short note to the recipient

metadataobject

Arbitrary key-value metadata to associate with the transaction

originating_account_aliasstring

An alias representing a GL account to debit. This is alternative to specifying by account id

originating_account_customer_idstring uuid

The customer id of the owner of the originating account.

originating_account_idstring uuid

The UUID of the account being debited

receiving_account_aliasstring

An alias representing a GL account to credit. This is an alternative to specifying by account id

receiving_account_customer_idstring uuid

The customer id of the owner of the receiving account.

receiving_account_idstring uuid

The UUID of the account being credited

reference_idstring

Network reference id

tenantstring

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

type'ACCOUNT_BALANCE_ADJUSTMENT' | 'ACCOUNT_TO_ACCOUNT' | 'ACCOUNT_TO_ACCOUNT_SWEEP' | 'ACH_CREDIT_SWEEP' | 'ACH_DEBIT_SWEEP' | 'ACH_FLOAT_TRANSFER' | 'ACH_INCOMING_CREDIT_SWEEP' | 'ACH_INCOMING_DEBIT_SWEEP' | 'ACH_INCOMING_RETURN_CREDIT_SWEEP' | 'ACH_INCOMING_RETURN_DEBIT_SWEEP' | 'ACH_OUTGOING_CREDIT_SWEEP' | 'ACH_OUTGOING_DEBIT_SWEEP' | 'ACH_OUTGOING_RETURN_CREDIT_SWEEP' | 'ACH_OUTGOING_RETURN_DEBIT_SWEEP' | 'ACH_SWEEP' | 'ARBITRATION_FINAL_CREDIT' | 'ARBITRATION_FINAL_CREDIT_REVERSAL' | 'AUTO_PAYMENT' | 'AUTO_PAYMENT_REVERSAL' | 'BULK_DOMESTIC_WIRE_OUTGOING_SWEEP' | 'BULK_EFT_CA_OUTGOING_CREDIT_SWEEP' | 'BULK_EFT_CA_OUTGOING_DEBIT_SWEEP' | 'CARD_CHARGEBACK' | 'CARD_CHARGEBACK_CASE_WON_SWEEP' | 'CARD_CHARGEBACK_CASE_WON_SWEEP_REVERSAL' | 'CARD_CHARGEBACK_WRITEOFF' | 'CARD_CHARGEBACK_WRITEOFF_SWEEP' | 'CARD_CHARGEBACK_WRITEOFF_SWEEP_REVERSAL' | 'CARD_PROVISIONAL_CREDIT' | 'CARD_PROVISIONAL_CREDIT_REVERSAL' | 'CARD_PROVISIONAL_CREDIT_SWEEP' | 'CARD_PROVISIONAL_CREDIT_SWEEP_REVERSAL' | 'CASHBACK' | 'CASHBACK_SWEEP' | 'CASH_DEPOSIT_KIOSK' | 'CASH_DEPOSIT_KIOSK_REVERSAL' | 'CHARGEBACK_FINAL_CREDIT' | 'CHARGEBACK_FINAL_CREDIT_REVERSAL' | 'CHECK_DEPOSIT_KIOSK' | 'CHECK_DEPOSIT_KIOSK_GOV' | 'CHECK_DEPOSIT_KIOSK_GOV_REVERSAL' | 'CHECK_DEPOSIT_KIOSK_PAYROLL' | 'CHECK_DEPOSIT_KIOSK_PAYROLL_REVERSAL' | 'CHECK_DEPOSIT_KIOSK_REVERSAL' | 'CHECK_DEPOSIT_MOBILE' | 'CHECK_DEPOSIT_MOBILE_REVERSAL' | 'CREDIT_MEMO' | 'DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL' | 'DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT' | 'DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_CASH_PICKUP' | 'DOMESTIC_MONEY_TRANSFER_CASH_PICKUP_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY' | 'DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET' | 'DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET_REVERSAL' | 'DOMESTIC_WIRE_INCOMING_RETURN_SWEEP' | 'DOMESTIC_WIRE_INCOMING_SWEEP' | 'DOMESTIC_WIRE_OUTGOING_RETURN_SWEEP' | 'DOMESTIC_WIRE_OUTGOING_SWEEP' | 'EFT_CA_INCOMING_CREDIT_RETURN_SWEEP' | 'EFT_CA_INCOMING_CREDIT_SWEEP' | 'EFT_CA_INCOMING_DEBIT_RETURN_SWEEP' | 'EFT_CA_INCOMING_DEBIT_SWEEP' | 'EFT_CA_OUTGOING_CREDIT_RETURN_SWEEP' | 'EFT_CA_OUTGOING_CREDIT_SWEEP' | 'EFT_CA_OUTGOING_DEBIT_RETURN_SWEEP' | 'EFT_CA_OUTGOING_DEBIT_SWEEP' | 'ETRANSFER_SWEEP' | 'FEE' | 'FEE_REVERSAL' | 'FEE_SWEEP' | 'FORCE_PAYMENT' | 'GENERAL_FEE_SWEEP' | 'GENERAL_FEE_SWEEP_REVERSAL' | 'GENERAL_INTERNAL_TRANSFER_SWEEP' | 'GENERAL_INTERNAL_TRANSFER_SWEEP_REVERSAL' | 'GENERAL_REWARD_SWEEP' | 'GENERAL_REWARD_SWEEP_REVERSAL' | 'INCOMING_WIRE' | 'INCOMING_WIRE_SWEEP' | 'INTEREST_CHARGED_SWEEP' | 'INTEREST_CORRECTION' | 'INTEREST_PAYOUT' | 'INTEREST_PAYOUT_SWEEP' | 'INTERNATIONAL_WIRE_INCOMING_SWEEP' | 'INTERNATIONAL_WIRE_OUTGOING_RETURN_SWEEP' | 'INTERNATIONAL_WIRE_OUTGOING_SWEEP' | 'INVOICE' | 'IN_STORE_CASH_DEPOSIT_SWEEP' | 'IN_STORE_CASH_DEPOSIT_SWEEP_REVERSAL' | 'LOAN_DISBURSEMENT' | 'LOAN_FUNDING' | 'MANUAL_ADJUSTMENT' | 'MANUAL_ADJUSTMENT_REVERSAL' | 'MANUAL_ADJUSTMENT_SWEEP' | 'MANUAL_AFT_SWEEP' | 'MANUAL_CARD_SWEEP' | 'MANUAL_CASH_DEPOSIT_SWEEP' | 'MANUAL_CASH_ORDER_SWEEP' | 'MANUAL_CHECK_ISSUANCE' | 'MANUAL_CHECK_SWEEP' | 'MANUAL_OCT_SWEEP' | 'MANUAL_WIRE_SWEEP' | 'MARKETPLACE_BILL_PAY' | 'MARKETPLACE_BILL_PAY_REVERSAL' | 'MARKETPLACE_EVENT_TICKETS' | 'MARKETPLACE_EVENT_TICKETS_REVERSAL' | 'MARKETPLACE_GIFT_CARD' | 'MARKETPLACE_GIFT_CARD_REVERSAL' | 'MARKETPLACE_MOBILE_TOP_UP' | 'MARKETPLACE_MOBILE_TOP_UP_REVERSAL' | 'MASTERCARD_GROSS_SWEEP' | 'MASTERCARD_INTERCHANGE_SWEEP' | 'MASTERCARD_NET_SWEEP' | 'MISC_CREDIT' | 'MOBILE_DEPOSIT_RETURN_SWEEP' | 'MOBILE_DEPOSIT_SWEEP' | 'NEGATIVE_BALANCE_RESERVE' | 'NEGATIVE_BALANCE_WRITEOFF' | 'NETWORK_ADJUSTMENT_SWEEP' | 'NETWORK_CHARGEBACK_SWEEP' | 'ONE_TIME_PAYMENT' | 'ONE_TIME_PAYMENT_REVERSAL' | 'OUTGOING_INTERNATIONAL_REMITTANCE' | 'OUTGOING_INTERNATIONAL_REMITTANCE_REVERSAL' | 'OVERDUE_CARD_WRITEOFF' | 'PEER_TO_PEER' | 'PROMOTIONAL_CREDIT' | 'PROMOTIONAL_CREDIT_REVERSAL' | 'PROMOTIONAL_CREDIT_SWEEP' | 'PROVISIONAL_CREDIT' | 'PROVISIONAL_CREDIT_REVERSAL' | 'PULSE_GROSS_SWEEP' | 'PULSE_INTERCHANGE_SWEEP' | 'REVENUE_DISBURSEMENT' | 'SECURITY_ACCOUNT_PAYMENT' | 'SECURITY_OVERPAY_ADJUSTMENT' | 'SECURITY_OVERPAY_ADJUSTMENT_REVERSAL' | 'SIGN_UP_BONUS' | 'SUBSCRIPTION_FEE' | 'TRANSFER_FEE' | 'TRANSFER_FEE_REVERSAL' | 'VISA_GROSS_SWEEP' | 'VISA_INTERCHANGE_SWEEP' | 'VISA_NET_SWEEP' | 'WIRE_SETTLEMENT_CREDIT' | 'WIRE_SETTLEMENT_DEBIT' | 'WRITEOFF_FRAUD_FINAL_CREDIT' | 'WRITEOFF_FRAUD_FINAL_CREDIT_REVERSAL' | 'WRITEOFF_NON_FRAUD_FINAL_CREDIT' | 'WRITEOFF_NON_FRAUD_FINAL_CREDIT_REVERSAL' required

The desired transaction type to use for this transfer

Example request

{
  "amount": 1025,
  "currency": "USD",
  "originating_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "receiving_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "type": "ACCOUNT_TO_ACCOUNT"
}

Response

Internal transfer response

idstring uuid required

The transaction id associated with the transfer

status'CANCELED' | 'COMPLETE' | 'EXPIRED' | 'PENDING' required

The status of the internal transfer auth. A value of PENDING indicates that the funds have been reserved and the transaction is ready to be either completed or canceled. A value of COMPLETE indicates the funds have been successfully moved and no more action can be performed. A value of CANCELED or EXPIRED means that the transaction has rolled back and the funds have been returned to the originating account, either by explicitly canceling via the API, or due to the expiry time having passed.

amountinteger required

The amount (in cents) to transfer from originating account to receiving account.

capture_mode'IMMEDIATE' | 'MANUAL'

Controls when the transfer will take effect. A value of IMMEDIATE (the default) means that the transfer will be completed immediately. A value of MANUAL means that the transaction will remain in a "pending" state until explicitly completed or cancelled (or the auth expires).

currencystring required

ISO 4217 alphabetic currency code of the transfer amount

expires_atstring date-time

When capture_mode is MANUAL, this field describes when the pending transaction should expire.

final_customer_idstring uuid

The customer id of the international customer that receives the final remittance transfer (required for remittance payments).

memostring

A short note to the recipient

metadataobject

Arbitrary key-value metadata to associate with the transaction

originating_account_aliasstring

An alias representing a GL account to debit. This is alternative to specifying by account id

originating_account_customer_idstring uuid

The customer id of the owner of the originating account.

originating_account_idstring uuid

The UUID of the account being debited

receiving_account_aliasstring

An alias representing a GL account to credit. This is an alternative to specifying by account id

receiving_account_customer_idstring uuid

The customer id of the owner of the receiving account.

receiving_account_idstring uuid

The UUID of the account being credited

reference_idstring

Network reference id

tenantstring

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

type'ACCOUNT_BALANCE_ADJUSTMENT' | 'ACCOUNT_TO_ACCOUNT' | 'ACCOUNT_TO_ACCOUNT_SWEEP' | 'ACH_CREDIT_SWEEP' | 'ACH_DEBIT_SWEEP' | 'ACH_FLOAT_TRANSFER' | 'ACH_INCOMING_CREDIT_SWEEP' | 'ACH_INCOMING_DEBIT_SWEEP' | 'ACH_INCOMING_RETURN_CREDIT_SWEEP' | 'ACH_INCOMING_RETURN_DEBIT_SWEEP' | 'ACH_OUTGOING_CREDIT_SWEEP' | 'ACH_OUTGOING_DEBIT_SWEEP' | 'ACH_OUTGOING_RETURN_CREDIT_SWEEP' | 'ACH_OUTGOING_RETURN_DEBIT_SWEEP' | 'ACH_SWEEP' | 'ARBITRATION_FINAL_CREDIT' | 'ARBITRATION_FINAL_CREDIT_REVERSAL' | 'AUTO_PAYMENT' | 'AUTO_PAYMENT_REVERSAL' | 'BULK_DOMESTIC_WIRE_OUTGOING_SWEEP' | 'BULK_EFT_CA_OUTGOING_CREDIT_SWEEP' | 'BULK_EFT_CA_OUTGOING_DEBIT_SWEEP' | 'CARD_CHARGEBACK' | 'CARD_CHARGEBACK_CASE_WON_SWEEP' | 'CARD_CHARGEBACK_CASE_WON_SWEEP_REVERSAL' | 'CARD_CHARGEBACK_WRITEOFF' | 'CARD_CHARGEBACK_WRITEOFF_SWEEP' | 'CARD_CHARGEBACK_WRITEOFF_SWEEP_REVERSAL' | 'CARD_PROVISIONAL_CREDIT' | 'CARD_PROVISIONAL_CREDIT_REVERSAL' | 'CARD_PROVISIONAL_CREDIT_SWEEP' | 'CARD_PROVISIONAL_CREDIT_SWEEP_REVERSAL' | 'CASHBACK' | 'CASHBACK_SWEEP' | 'CASH_DEPOSIT_KIOSK' | 'CASH_DEPOSIT_KIOSK_REVERSAL' | 'CHARGEBACK_FINAL_CREDIT' | 'CHARGEBACK_FINAL_CREDIT_REVERSAL' | 'CHECK_DEPOSIT_KIOSK' | 'CHECK_DEPOSIT_KIOSK_GOV' | 'CHECK_DEPOSIT_KIOSK_GOV_REVERSAL' | 'CHECK_DEPOSIT_KIOSK_PAYROLL' | 'CHECK_DEPOSIT_KIOSK_PAYROLL_REVERSAL' | 'CHECK_DEPOSIT_KIOSK_REVERSAL' | 'CHECK_DEPOSIT_MOBILE' | 'CHECK_DEPOSIT_MOBILE_REVERSAL' | 'CREDIT_MEMO' | 'DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL' | 'DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT' | 'DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_CASH_PICKUP' | 'DOMESTIC_MONEY_TRANSFER_CASH_PICKUP_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY' | 'DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET' | 'DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET_REVERSAL' | 'DOMESTIC_WIRE_INCOMING_RETURN_SWEEP' | 'DOMESTIC_WIRE_INCOMING_SWEEP' | 'DOMESTIC_WIRE_OUTGOING_RETURN_SWEEP' | 'DOMESTIC_WIRE_OUTGOING_SWEEP' | 'EFT_CA_INCOMING_CREDIT_RETURN_SWEEP' | 'EFT_CA_INCOMING_CREDIT_SWEEP' | 'EFT_CA_INCOMING_DEBIT_RETURN_SWEEP' | 'EFT_CA_INCOMING_DEBIT_SWEEP' | 'EFT_CA_OUTGOING_CREDIT_RETURN_SWEEP' | 'EFT_CA_OUTGOING_CREDIT_SWEEP' | 'EFT_CA_OUTGOING_DEBIT_RETURN_SWEEP' | 'EFT_CA_OUTGOING_DEBIT_SWEEP' | 'ETRANSFER_SWEEP' | 'FEE' | 'FEE_REVERSAL' | 'FEE_SWEEP' | 'FORCE_PAYMENT' | 'GENERAL_FEE_SWEEP' | 'GENERAL_FEE_SWEEP_REVERSAL' | 'GENERAL_INTERNAL_TRANSFER_SWEEP' | 'GENERAL_INTERNAL_TRANSFER_SWEEP_REVERSAL' | 'GENERAL_REWARD_SWEEP' | 'GENERAL_REWARD_SWEEP_REVERSAL' | 'INCOMING_WIRE' | 'INCOMING_WIRE_SWEEP' | 'INTEREST_CHARGED_SWEEP' | 'INTEREST_CORRECTION' | 'INTEREST_PAYOUT' | 'INTEREST_PAYOUT_SWEEP' | 'INTERNATIONAL_WIRE_INCOMING_SWEEP' | 'INTERNATIONAL_WIRE_OUTGOING_RETURN_SWEEP' | 'INTERNATIONAL_WIRE_OUTGOING_SWEEP' | 'INVOICE' | 'IN_STORE_CASH_DEPOSIT_SWEEP' | 'IN_STORE_CASH_DEPOSIT_SWEEP_REVERSAL' | 'LOAN_DISBURSEMENT' | 'LOAN_FUNDING' | 'MANUAL_ADJUSTMENT' | 'MANUAL_ADJUSTMENT_REVERSAL' | 'MANUAL_ADJUSTMENT_SWEEP' | 'MANUAL_AFT_SWEEP' | 'MANUAL_CARD_SWEEP' | 'MANUAL_CASH_DEPOSIT_SWEEP' | 'MANUAL_CASH_ORDER_SWEEP' | 'MANUAL_CHECK_ISSUANCE' | 'MANUAL_CHECK_SWEEP' | 'MANUAL_OCT_SWEEP' | 'MANUAL_WIRE_SWEEP' | 'MARKETPLACE_BILL_PAY' | 'MARKETPLACE_BILL_PAY_REVERSAL' | 'MARKETPLACE_EVENT_TICKETS' | 'MARKETPLACE_EVENT_TICKETS_REVERSAL' | 'MARKETPLACE_GIFT_CARD' | 'MARKETPLACE_GIFT_CARD_REVERSAL' | 'MARKETPLACE_MOBILE_TOP_UP' | 'MARKETPLACE_MOBILE_TOP_UP_REVERSAL' | 'MASTERCARD_GROSS_SWEEP' | 'MASTERCARD_INTERCHANGE_SWEEP' | 'MASTERCARD_NET_SWEEP' | 'MISC_CREDIT' | 'MOBILE_DEPOSIT_RETURN_SWEEP' | 'MOBILE_DEPOSIT_SWEEP' | 'NEGATIVE_BALANCE_RESERVE' | 'NEGATIVE_BALANCE_WRITEOFF' | 'NETWORK_ADJUSTMENT_SWEEP' | 'NETWORK_CHARGEBACK_SWEEP' | 'ONE_TIME_PAYMENT' | 'ONE_TIME_PAYMENT_REVERSAL' | 'OUTGOING_INTERNATIONAL_REMITTANCE' | 'OUTGOING_INTERNATIONAL_REMITTANCE_REVERSAL' | 'OVERDUE_CARD_WRITEOFF' | 'PEER_TO_PEER' | 'PROMOTIONAL_CREDIT' | 'PROMOTIONAL_CREDIT_REVERSAL' | 'PROMOTIONAL_CREDIT_SWEEP' | 'PROVISIONAL_CREDIT' | 'PROVISIONAL_CREDIT_REVERSAL' | 'PULSE_GROSS_SWEEP' | 'PULSE_INTERCHANGE_SWEEP' | 'REVENUE_DISBURSEMENT' | 'SECURITY_ACCOUNT_PAYMENT' | 'SECURITY_OVERPAY_ADJUSTMENT' | 'SECURITY_OVERPAY_ADJUSTMENT_REVERSAL' | 'SIGN_UP_BONUS' | 'SUBSCRIPTION_FEE' | 'TRANSFER_FEE' | 'TRANSFER_FEE_REVERSAL' | 'VISA_GROSS_SWEEP' | 'VISA_INTERCHANGE_SWEEP' | 'VISA_NET_SWEEP' | 'WIRE_SETTLEMENT_CREDIT' | 'WIRE_SETTLEMENT_DEBIT' | 'WRITEOFF_FRAUD_FINAL_CREDIT' | 'WRITEOFF_FRAUD_FINAL_CREDIT_REVERSAL' | 'WRITEOFF_NON_FRAUD_FINAL_CREDIT' | 'WRITEOFF_NON_FRAUD_FINAL_CREDIT_REVERSAL' required

The desired transaction type to use for this transfer

Example response

{
  "amount": 1025,
  "currency": "USD",
  "originating_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "receiving_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "type": "ACCOUNT_TO_ACCOUNT"
}