Retrieve transfer options
To use this endpoint from the browser, you’ll need to specify the
/accounts/{yourAccountID}/transfers.read
scope when generating a token. The accountID included must be your accountID. You can find your accountID on the Business details page.
|
|
|
|
|
|
{
"destinationOptions": [
{
"paymentMethodID": "8485a2ce-c9b0-4d49-bfa1-60e88a79ce31",
"paymentMethodType": "moov-wallet",
"wallet": {
"walletID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
}
}
],
"sourceOptions": [
{
"paymentMethodID": "2b42ad2a-7586-4e55-a268-10d585186c27",
"paymentMethodType": "moov-wallet",
"wallet": {
"walletID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
}
}
]
}
Response headers
X-Retry-In
string
<duration>
Body
amount
object
required
Show child attributes
currency
string
<=3 characters
Pattern
value
integer<int64>
destination
object
required
Show child attributes
accountID
string<uuid>
<=36 characters
Pattern
paymentMethodID
string<uuid>
<=36 characters
Pattern
source
object
required
Show child attributes
accountID
string<uuid>
<=36 characters
Pattern
paymentMethodID
string<uuid>
<=36 characters
Pattern
Response
destinationOptions
array
Show child attributes
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
wallet
object
Show child attributes
walletID
string<uuid>
<=36 characters
Pattern
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
bankAccount
object
Show child attributes
bankAccountID
string<uuid>
<=36 characters
Pattern
bankAccountType
string<enum>
checking
,
savings
,
general-ledger
,
loan
bankName
string
exceptionDetails
object
errored
or verificationFailed
bank account status.
Show child attributes
achReturnCode
string<enum>
The return code of an ACH transaction that caused the bank account status to change.
Codes:
- R02 - Account Closed
- R03 - No Account/Unable to Locate Account
- R04 - Invalid Account Number
- R05 - Improper Debit to Consumer Account
- R07 - Authorization Revoked by Customer
- R08 - Payment Stopped
- R10 - Customer Advises Originator is Not Known or Authorized to Receiver and
- R11 - Customer Advises Entry Not in Accordance with the Terms of the Authorization
- R12 - Branch Sold to Another DFI
- R13 - RDFI not qualified to participate
- R14 - Representative payee deceased or unable to continue in that capacity
- R15 - Beneficiary or bank account holder
- R16 - Bank account frozen
- R17 - Entry with Invalid Account Number Initiated Under Questionable Circumstances
- R20 - Non-payment bank account
- R23 - Credit entry refused by receiver
- R29 - Corporate customer advises not authorized
- R34 - Limited participation RDFI
- R38 - Stop Payment on Source Document (Adjustment Entry)
- R39 - Improper Source Document
R02
,
R03
,
R04
,
R05
,
R07
,
R08
,
R10
,
R11
,
R12
,
R13
,
R14
,
R15
,
R16
,
R17
,
R20
,
R23
,
R29
,
R34
,
R38
,
R39
description
string
errored
or verificationFailed
bank account status.
rtpRejectionCode
string<enum>
The rejection code of an RTP transaction that caused the bank account status to change.
Codes:
- AC03 - Account Invalid
- AC04 - Account Closed
- AC06 - Account Blocked
- AC14 - Creditor Account Type Invalid
- AG01 - Transactions Forbidden On Account
- AG03 - Transaction Type Not Supported
- MD07 - Customer Deceased
AC03
,
AC04
,
AC06
,
AC14
,
AG01
,
AG03
,
MD07
fingerprint
string
<=100 characters
holderName
string
holderType
string<enum>
individual
,
business
lastFourAccountNumber
string
paymentMethods
array
Includes any payment methods generated for a newly created bank account, removing the need to call the List Payment Methods endpoint following a successful Create BankAccount request.
NOTE: This field is only populated for Create BankAccount requests made with the X-Wait-For
header.
Show child attributes
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
routingNumber
string
status
string<enum>
new
,
verified
,
verificationFailed
,
pending
,
errored
statusReason
string<enum>
bank-account-created
,
verification-initiated
,
micro-deposit-attempts-exceeded
,
micro-deposit-expired
,
max-verification-failures
,
verification-attempts-exceeded
,
verification-expired
,
verification-successful
,
ach-debit-return
,
ach-credit-return
,
rtp-credit-failure
,
micro-deposit-return
,
admin-action
,
other
updatedOn
string<date-time>
<=24 characters
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
card
object
Show child attributes
billingAddress
object
Show child attributes
addressLine1
string
<=60 characters
required
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
addressLine2
string
<=32 characters
bin
string
brand
string
American Express
,
Discover
,
Mastercard
,
Visa
cardAccountUpdater
object
Show child attributes
updateType
string<enum>
unspecified
,
account-closed
,
contact-cardholder
,
expiration-update
,
no-change
,
no-match
,
number-update
updatedOn
string<date-time>
<=24 characters
cardCategory
string
cardID
string<uuid>
<=36 characters
Pattern
cardOnFile
boolean
cardType
string<enum>
debit
,
credit
,
prepaid
,
unknown
cardVerification
object
Show child attributes
accountName
object
Show child attributes
firstName
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
fullName
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
lastName
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
middleName
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
addressLine1
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
cvv
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
postalCode
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
commercial
boolean
domesticPullFromCard
string
not-supported
,
supported
,
unknown
domesticPushToCard
string
not-supported
,
standard
,
fast-funds
,
unknown
expiration
object
Show child attributes
month
string
2 characters
year
string
2 characters
fingerprint
string
<=100 characters
holderName
string
issuer
string
issuerCountry
string
issuerPhone
string
issuerURL
string
lastFourCardNumber
string
merchantAccountID
string<uuid>
<=36 characters
Pattern
paymentMethods
array
Includes any payment methods generated for a newly linked card, removing the need to call the List Payment Methods endpoint following a successful Link Card request.
NOTE: This field is only populated for Link Card requests made with the X-Wait-For
header.
Show child attributes
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
regulated
boolean
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
applePay
object
Show child attributes
brand
string<enum>
American Express
,
Discover
,
Mastercard
,
Visa
cardDisplayName
string
cardType
string<enum>
debit
,
credit
,
prepaid
,
unknown
dynamicLastFour
string
expiration
object
Show child attributes
month
string
2 characters
year
string
2 characters
fingerprint
string
<=100 characters
sourceOptions
array
Show child attributes
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
wallet
object
Show child attributes
walletID
string<uuid>
<=36 characters
Pattern
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
bankAccount
object
Show child attributes
bankAccountID
string<uuid>
<=36 characters
Pattern
bankAccountType
string<enum>
checking
,
savings
,
general-ledger
,
loan
bankName
string
exceptionDetails
object
errored
or verificationFailed
bank account status.
Show child attributes
achReturnCode
string<enum>
The return code of an ACH transaction that caused the bank account status to change.
Codes:
- R02 - Account Closed
- R03 - No Account/Unable to Locate Account
- R04 - Invalid Account Number
- R05 - Improper Debit to Consumer Account
- R07 - Authorization Revoked by Customer
- R08 - Payment Stopped
- R10 - Customer Advises Originator is Not Known or Authorized to Receiver and
- R11 - Customer Advises Entry Not in Accordance with the Terms of the Authorization
- R12 - Branch Sold to Another DFI
- R13 - RDFI not qualified to participate
- R14 - Representative payee deceased or unable to continue in that capacity
- R15 - Beneficiary or bank account holder
- R16 - Bank account frozen
- R17 - Entry with Invalid Account Number Initiated Under Questionable Circumstances
- R20 - Non-payment bank account
- R23 - Credit entry refused by receiver
- R29 - Corporate customer advises not authorized
- R34 - Limited participation RDFI
- R38 - Stop Payment on Source Document (Adjustment Entry)
- R39 - Improper Source Document
R02
,
R03
,
R04
,
R05
,
R07
,
R08
,
R10
,
R11
,
R12
,
R13
,
R14
,
R15
,
R16
,
R17
,
R20
,
R23
,
R29
,
R34
,
R38
,
R39
description
string
errored
or verificationFailed
bank account status.
rtpRejectionCode
string<enum>
The rejection code of an RTP transaction that caused the bank account status to change.
Codes:
- AC03 - Account Invalid
- AC04 - Account Closed
- AC06 - Account Blocked
- AC14 - Creditor Account Type Invalid
- AG01 - Transactions Forbidden On Account
- AG03 - Transaction Type Not Supported
- MD07 - Customer Deceased
AC03
,
AC04
,
AC06
,
AC14
,
AG01
,
AG03
,
MD07
fingerprint
string
<=100 characters
holderName
string
holderType
string<enum>
individual
,
business
lastFourAccountNumber
string
paymentMethods
array
Includes any payment methods generated for a newly created bank account, removing the need to call the List Payment Methods endpoint following a successful Create BankAccount request.
NOTE: This field is only populated for Create BankAccount requests made with the X-Wait-For
header.
Show child attributes
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
routingNumber
string
status
string<enum>
new
,
verified
,
verificationFailed
,
pending
,
errored
statusReason
string<enum>
bank-account-created
,
verification-initiated
,
micro-deposit-attempts-exceeded
,
micro-deposit-expired
,
max-verification-failures
,
verification-attempts-exceeded
,
verification-expired
,
verification-successful
,
ach-debit-return
,
ach-credit-return
,
rtp-credit-failure
,
micro-deposit-return
,
admin-action
,
other
updatedOn
string<date-time>
<=24 characters
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
card
object
Show child attributes
billingAddress
object
Show child attributes
addressLine1
string
<=60 characters
required
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
addressLine2
string
<=32 characters
bin
string
brand
string
American Express
,
Discover
,
Mastercard
,
Visa
cardAccountUpdater
object
Show child attributes
updateType
string<enum>
unspecified
,
account-closed
,
contact-cardholder
,
expiration-update
,
no-change
,
no-match
,
number-update
updatedOn
string<date-time>
<=24 characters
cardCategory
string
cardID
string<uuid>
<=36 characters
Pattern
cardOnFile
boolean
cardType
string<enum>
debit
,
credit
,
prepaid
,
unknown
cardVerification
object
Show child attributes
accountName
object
Show child attributes
firstName
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
fullName
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
lastName
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
middleName
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
addressLine1
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
cvv
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
postalCode
string
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
commercial
boolean
domesticPullFromCard
string
not-supported
,
supported
,
unknown
domesticPushToCard
string
not-supported
,
standard
,
fast-funds
,
unknown
expiration
object
Show child attributes
month
string
2 characters
year
string
2 characters
fingerprint
string
<=100 characters
holderName
string
issuer
string
issuerCountry
string
issuerPhone
string
issuerURL
string
lastFourCardNumber
string
merchantAccountID
string<uuid>
<=36 characters
Pattern
paymentMethods
array
Includes any payment methods generated for a newly linked card, removing the need to call the List Payment Methods endpoint following a successful Link Card request.
NOTE: This field is only populated for Link Card requests made with the X-Wait-For
header.
Show child attributes
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
regulated
boolean
paymentMethodID
string<uuid>
<=36 characters
Pattern
paymentMethodType
string<enum>
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
applePay
object
Show child attributes
brand
string<enum>
American Express
,
Discover
,
Mastercard
,
Visa
cardDisplayName
string
cardType
string<enum>
debit
,
credit
,
prepaid
,
unknown
dynamicLastFour
string
expiration
object
Show child attributes
month
string
2 characters
year
string
2 characters
fingerprint
string
<=100 characters