List transfers
List all the transfers associated with a particular Moov account.
Read our transfers overview guide to learn more.
When you run this request, you retrieve 200 transfers at a time. You can advance past a results set of 200 transfers by using the skip parameter (for example,
if you set skip= 10, you will see a results set of 200 transfers after the first 10). If you are searching a high volume of transfers, the request will likely
process very slowly. To achieve faster performance, restrict the data as much as you can by using the StartDateTime and EndDateTime parameters for a limited
period of time. You can run multiple requests in smaller time window increments until you've retrieved all the transfers you need. The maximum allowed value for
skip is 200 000.
For large result sets, use cursor pagination instead of skip. When more transfers are available, the response includes an
X-Next-Cursor header. Pass its value as the cursor query parameter, with the same filters and count, to retrieve the next page.
cursor cannot be combined with a nonzero skip.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/transfers.read scope.
curl -X GET "https://api.moov.io/accounts/{accountID}/transfers" \
-H "Authorization: Bearer {token}" \
-H "X-Moov-Version: v2026.10.00"mc, _ := moov.NewClient()
var accountID string
mc.ListTransfers(ctx, accountID, moov.WithTransferStatus("completed"))
import { Moov } from "@moovio/sdk";
const moov = new Moov({
security: {
username: "",
password: "",
},
});
async function run() {
const result = await moov.transfers.list({
skip: 60,
count: 20,
accountID: "0579c895-4d2b-4024-8092-f71b80ab5d00",
});
console.log(result);
}
run();declare(strict_types=1);
require 'vendor/autoload.php';
use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;
use Moov\MoovPhp\Models\Operations;
$sdk = MoovPhp\Moov::builder()
->setSecurity(
new Components\Security(
username: '',
password: '',
)
)
->build();
$request = new Operations\ListTransfersRequest(
skip: 60,
count: 20,
accountID: '0579c895-4d2b-4024-8092-f71b80ab5d00',
);
$response = $sdk->transfers->list(
request: $request
);
if ($response->transfers !== null) {
// handle response
}package hello.world;
import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.ListTransfersValidationError;
import io.moov.sdk.models.operations.ListTransfersRequest;
import io.moov.sdk.models.operations.ListTransfersResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws ListTransfersValidationError, Exception {
Moov sdk = Moov.builder()
.security(Security.builder()
.username("")
.password("")
.build())
.build();
ListTransfersRequest req = ListTransfersRequest.builder()
.accountID("0579c895-4d2b-4024-8092-f71b80ab5d00")
.skip(60L)
.count(20L)
.build();
ListTransfersResponse res = sdk.transfers().list()
.request(req)
.call();
if (res.transfers().isPresent()) {
System.out.println(res.transfers().get());
}
}
}from moovio_sdk import Moov
from moovio_sdk.models import components
with Moov(
security=components.Security(
username="",
password="",
),
) as moov:
res = moov.transfers.list(account_id="0579c895-4d2b-4024-8092-f71b80ab5d00", skip=60, count=20)
# Handle response
print(res)require 'moov_ruby'
Models = ::Moov::Models
s = ::Moov::Client.new(
security: Models::Components::Security.new(
username: '',
password: ''
)
)
req = Models::Operations::ListTransfersRequest.new(
skip: 60,
count: 20,
account_id: '0579c895-4d2b-4024-8092-f71b80ab5d00'
)
res = s.transfers.list(request: req)
unless res.transfers.nil?
# handle response
endusing Moov.Sdk;
using Moov.Sdk.Models.Components;
using Moov.Sdk.Models.Requests;
var sdk = new MoovClient(security: new Security() {
Username = "",
Password = "",
});
ListTransfersRequest req = new ListTransfersRequest() {
Skip = 60,
Count = 20,
AccountID = "0579c895-4d2b-4024-8092-f71b80ab5d00",
};
var res = await sdk.Transfers.ListAsync(req);
// handle response[
{
"transferID": "d835gf30-4b19-4850-a9b2-c0624c41ecb3",
"transferType": "card-payment",
"source": {
"paymentMethodID": "9506dbf6-4208-44c3-ad8a-e4431660e1f2",
"paymentMethodType": "card-payment",
"account": {
"accountID": "7e4b26c2-b399-49ef-8390-50e1ea44d550",
"email": "jules@julesjackson.com",
"displayName": "Jules Jackson"
},
"card": {
"cardID": "aefd5563-93c6-413c-875e-1bd0ebfc116d",
"fingerprint": "2f5d782ceef1c3bd31ed5...",
"brand": "Visa",
"cardType": "credit",
"lastFourCardNumber": "2000",
"bin": "400020",
"expiration": {
"month": "01",
"year": "28"
},
"holderName": "Jules Jackson",
"billingAddress": {
"postalCode": "80301"
},
"domesticPushToCard": "standard",
"domesticPullFromCard": "supported",
"cardVerification": {
"cvv": "unavailable",
"addressLine1": "unavailable",
"postalCode": "unavailable",
"accountName": {
"firstName": "unavailable",
"lastName": "unavailable",
"middleName": "unavailable",
"fullName": "unavailable"
}
},
"issuer": "Moov Visa Sandbox",
"issuerCountry": "US",
"cardAccountUpdater": {}
}
},
"destination": {
"paymentMethodID": "3f9969cf-a1f3-4d83-8ddc-229a506651cf",
"paymentMethodType": "moov-wallet",
"account": {
"accountID": "34233b72-780c-4a0d-8b08-cbbe23k878f8",
"email": "john@wholebodyfitness.io",
"displayName": "Whole Body Fitness"
},
"wallet": {
"walletID": "744b2e78-8cc8-4a6a-af42-611e3b844503",
"partnerAccountID": "65b57f28-49e9-4afb-9bf6-7e4fb6444917",
"walletType": "general"
}
},
"status": "pending",
"amount": {
"currency": "USD",
"valueDecimal": "329.45"
},
"amountDetails": {
"tip": {
"currency": "USD",
"valueDecimal": "3.50"
},
"tax": {
"currency": "USD",
"valueDecimal": "8.25"
}
},
"description": "Transfer from card to wallet",
"createdOn": "2025-01-21T21:32:16Z",
"moovFees": [
{
"accountID": "7e4b26c2-b399-49ef-8390-50e1ea44d550",
"transferParty": "source",
"totalAmount": {
"currency": "USD",
"valueDecimal": "0.10"
},
"feeIDs": [
"9d957d33-1a9a-47aa-9460-fe1a90f003dd"
]
}
],
"options": {
"cardPayment": {
"dynamicDescriptor": "WhlBdy *Yoga 11-12"
}
},
"processingDetails": {
"cardPayment": {
"status": "confirmed",
"authorizationCode": "A1B2C3",
"networkTransactionID": "123456789012345"
}
}
}
]Response headers
X-Next-Cursor
string
cursor query parameter, with the same filters
and count, to retrieve the next page. Omitted when there are no more transfers.
x-request-id
string
required
Response headers
x-request-id
string
required
Response headers
x-request-id
string
required
{
"accountIDs": "string",
"status": "string",
"startDateTime": "string",
"endDateTime": "string",
"skip": "string",
"count": "string",
"cursor": "string",
"groupID": "string",
"foreignID": "string",
"scheduleID": "string",
"paymentLinkCode": "string",
"refunded": "string",
"disputed": "string"
}Response headers
x-request-id
string
required
Response headers
x-request-id
string
required
Response headers
x-request-id
string
required
Response headers
x-request-id
string
required
Headers
X-Moov-Version
string
v2026.08.00 uses v2026.07.00.
A malformed value, such as 2022, returns a 404 response.
v2026.10.00
Path parameters
accountID
string
required
Query parameters
accountIDs
array
status
string
created,
pending,
completed,
failed,
reversed,
queued,
awaiting-capture,
canceled
startDateTime
string
<date-time>
endDateTime
string
<date-time>
groupID
string
scheduleID
string
paymentLinkCode
string
refunded
boolean
disputed
boolean
foreignID
string
authorizationIDs
array
invoiceIDs
array
transferTypes
array
skip
integer
<int64>
count
integer
<int64>
200.
cursor
string
X-Next-Cursor header. Reuse the same filters and count between pages.
Cannot be combined with a nonzero skip.
Response
amount
object
card-payment transfer reports the approved authorization amount until a final capture is created.
For these transfers, when a final capture is created, this is updated to the cumulative captured amount.
For other transfer types, this is the transfer amount.
Show child attributes
amount
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
amountDetails
object
card-payment transfer, this is the aggregate of all captures' amountDetails.
Show child attributes
amountDetails
surcharge
object
Show child attributes
amountDetails.surcharge
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
tax
object
Show child attributes
amountDetails.tax
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
tip
object
Show child attributes
amountDetails.tip
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
authorization
object
card-payment transfer.
card-payment transfer.
Show child attributes
authorization
amountDetails
object
The tip, tax, and surcharge authorized by the card network.
These describe the authorized amount and are fixed.
They can differ from the transfer's amountDetails, which is the aggregate of all captures' amountDetails.
Show child attributes
authorization.amountDetails
surcharge
object
Show child attributes
authorization.amountDetails.surcharge
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
tax
object
Show child attributes
authorization.amountDetails.tax
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
tip
object
Show child attributes
authorization.amountDetails.tip
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
authorizationID
string
required
authorizedAmount
object
required
Show child attributes
authorization.authorizedAmount
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
capturableAmount
object
required
Show child attributes
authorization.capturableAmount
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
capturedAmount
object
required
Show child attributes
authorization.capturedAmount
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
expiresOn
string<date-time>
requestedAmount
object
required
Show child attributes
authorization.requestedAmount
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
completedOn
string<date-time>
createdOn
string<date-time>
description
string
<=128 characters
destination
object
Show child attributes
destination
account
object
Show child attributes
destination.account
accountID
string
required
displayName
string
required
string
required
applePay
object
Show child attributes
destination.applePay
brand
string<enum>
required
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardDisplayName
string
required
User-friendly name of the tokenized card returned by Apple.
It usually contains the brand and the last four digits of the underlying card. There is no standard format.
cardType
string<enum>
required
debit,
credit,
prepaid,
unknown
dynamicLastFour
string
required
expiration
object
required
Show child attributes
destination.applePay.expiration
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
issuerCountry
string
bankAccount
object
Show child attributes
destination.bankAccount
bankAccountID
string
required
bankAccountType
string<enum>
required
checking,
savings,
general-ledger,
loan
bankName
string
required
fingerprint
string
<=100 characters
required
Once the bank account is linked, we don't reveal the full bank account number.
The fingerprint acts as a way to identify whether two linked bank accounts are the same.
holderName
string
required
holderType
string<enum>
required
individual,
business,
guest
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
riskVerificationOutcome
string
notAttempted when
requestRiskVerification was not set, or the calling account was not allowlisted.
notAttempted,
success,
inconclusive,
decline
card
object
Show child attributes
destination.card
billingAddress
object
required
Show child attributes
destination.card.billingAddress
addressLine1
string
<=60 characters
addressLine2
string
<=32 characters
city
string
<=32 characters
country
string
<=2 characters
postalCode
string
<=10 characters
required
stateOrProvince
string
<=2 characters
bin
string
[6 to 8] characters
required
brand
string<enum>
required
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardID
string
required
cardType
string<enum>
required
debit,
credit,
prepaid,
unknown
cardVerification
object
required
Show child attributes
destination.card.cardVerification
addressLine1
string
required
postalCode; the card network returns a single code covering both address fields.
noMatch,
match,
notChecked,
unavailable,
partialMatch
cvv
string
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
postalCode
string
required
addressLine1; the card network returns a single code covering both address fields.
noMatch,
match,
notChecked,
unavailable,
partialMatch
accountName
object
Show child attributes
destination.card.cardVerification.accountName
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
expiration
object
required
Show child attributes
destination.card.expiration
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
lastFourCardNumber
string
4 characters
required
cardAccountUpdater
object
Show child attributes
destination.card.cardAccountUpdater
updateType
string<enum>
unspecified,
account-closed,
contact-cardholder,
expiration-update,
no-change,
no-match,
number-update
updatedOn
string<date-time>
cardOnFile
boolean
domesticPullFromCard
string<enum>
not-supported,
supported,
unknown
domesticPushToCard
string<enum>
not-supported,
standard,
fast-funds,
unknown
holderName
string
issuer
string
issuerCountry
string
merchantAccountID
string
googlePay
object
Show child attributes
destination.googlePay
brand
string<enum>
required
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardDisplayName
string
required
User-friendly name of the tokenized card returned by Google Pay.
It usually contains the last four digits of the underlying card. There is no standard format.
cardType
string<enum>
required
debit,
credit,
prepaid,
unknown
dynamicLastFour
string
4 characters
required
expiration
object
required
Show child attributes
destination.googlePay.expiration
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
tokenID
string
required
authMethod
string<enum>
PAN_ONLY,
CRYPTOGRAM_3DS
issuerCountry
string
paymentMethodID
string
paymentMethodType
string<enum>
moov-wallet,
ach-debit-fund,
ach-debit-collect,
ach-credit-standard,
ach-credit-same-day,
rtp-credit,
card-payment,
push-to-card,
pull-from-card,
apple-pay,
card-present-payment,
instant-bank-credit,
push-to-apple-pay,
pull-from-apple-pay,
google-pay,
push-to-google-pay,
pull-from-google-pay
wallet
object
Show child attributes
destination.wallet
partnerAccountID
string<uuid>
required
walletID
string
required
walletType
string<enum>
required
Type of a wallet.
default: The system-generated wallet automatically created when an account is granted the wallet capability.general: An additional, user-defined wallet created via API or Dashboard.card-issuing: The system-generated wallet automatically created when an account is granted the card-issuing capability.
default,
general,
card-issuing
disputedAmount
object
Show child attributes
disputedAmount
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
facilitatorFee
object
Show child attributes
facilitatorFee
markup
object
Show child attributes
facilitatorFee.markup
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
total
object
Show child attributes
facilitatorFee.total
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
failureReason
string<enum>
source-payment-error,
destination-payment-error,
wallet-insufficient-funds,
rejected-high-risk,
processing-error
foreignID
string
groupID
string
invoiceID
string
lineItems
object
Show child attributes
lineItems
items
array<object>
required
Show child attributes
lineItems.items[]
basePrice
object
Show child attributes
lineItems.items[].basePrice
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
images
array<object>
Show child attributes
lineItems.items[].images[]
altText
string
<=125 characters
imageID
string
link
string<uri>
publicID
string
Pattern
name
string
[1 to 150] characters
options
array<object>
Show child attributes
lineItems.items[].options[]
group
string
<=100 characters
images
array<object>
Show child attributes
lineItems.items[].options[].images[]
altText
string
<=125 characters
imageID
string
link
string<uri>
publicID
string
Pattern
name
string
[1 to 150] characters
priceModifier
object
Show child attributes
lineItems.items[].options[].priceModifier
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
quantity
integer<int32>
productID
string
quantity
integer<int32>
metadata
object
moovFee
object
Show child attributes
moovFee
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
moovFeeDetails
object
Show child attributes
moovFeeDetails
moovProcessing
object
required
Show child attributes
moovFeeDetails.moovProcessing
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
cardScheme
object
Show child attributes
moovFeeDetails.cardScheme
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
discount
object
Show child attributes
moovFeeDetails.discount
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
interchange
object
Show child attributes
moovFeeDetails.interchange
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
moovFees
array<object>
Show child attributes
moovFees[]
accountID
string
feeIDs
array<string>
totalAmount
object
Show child attributes
moovFees[].totalAmount
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
transferParty
string
source,
destination,
partner
occurrenceID
string
options
object
Show child attributes
options
achCredit
object
Show child attributes
options.achCredit
addenda
array<object>
Show child attributes
options.achCredit.addenda[]
isMasked
boolean
record
string
<=80 characters
companyEntryDescription
string
[4 to 10] characters
originatingCompanyName
string
[4 to 16] characters
achDebit
object
Show child attributes
options.achDebit
addenda
array<object>
Show child attributes
options.achDebit.addenda[]
isMasked
boolean
record
string
<=80 characters
companyEntryDescription
string
[4 to 10] characters
debitHoldPeriod
string<enum>
no-hold,
1-day,
2-days
originatingCompanyName
string
[4 to 16] characters
secCode
string<enum>
WEB,
PPD,
CCD,
TEL
cardPayment
object
Show child attributes
options.cardPayment
dynamicDescriptor
string
[4 to 22] characters
transactionSource
string<enum>
Specifies the nature and initiator of a transaction.
Crucial for recurring and merchant-initiated transactions as per card scheme rules. Omit for customer-initiated e-commerce transactions.
first-recurring,
recurring,
unscheduled
pullFromCard
object
Show child attributes
options.pullFromCard
dynamicDescriptor
string
[4 to 22] characters
transactionSource
string<enum>
Specifies the nature and initiator of a transaction.
Crucial for recurring and merchant-initiated transactions as per card scheme rules. Omit for customer-initiated e-commerce transactions.
first-recurring,
recurring,
unscheduled
pushToCard
object
Show child attributes
options.pushToCard
dynamicDescriptor
string
[4 to 22] characters
scheduledDeliveryOn
string<date-time>
paymentLinkCode
string
processingDetails
object
Show child attributes
processingDetails
achCredit
object
Show child attributes
processingDetails.achCredit
status
string<enum>
required
,
initiated,
originated,
corrected,
returned,
completed,
canceled
traceNumber
string
<=15 characters
required
correction
object
Show child attributes
processingDetails.achCredit.correction
code
string
description
string
reason
string
return
object
Show child attributes
processingDetails.achCredit.return
code
string
description
string
reason
string
achDebit
object
Show child attributes
processingDetails.achDebit
status
string<enum>
required
,
initiated,
originated,
corrected,
returned,
completed,
canceled
traceNumber
string
<=15 characters
required
correction
object
Show child attributes
processingDetails.achDebit.correction
code
string
description
string
reason
string
return
object
Show child attributes
processingDetails.achDebit.return
code
string
description
string
reason
string
cardPayment
object
Show child attributes
processingDetails.cardPayment
authorizationCode
string
failureCode
string<enum>
call-issuer,
do-not-honor,
processing-error,
invalid-transaction,
invalid-amount,
no-such-issuer,
reenter-transaction,
cvv-mismatch,
lost-or-stolen,
insufficient-funds,
invalid-card-number,
invalid-merchant,
expired-card,
incorrect-pin,
transaction-not-allowed,
suspected-fraud,
amount-limit-exceeded,
velocity-limit-exceeded,
revocation-of-authorization,
card-not-activated,
issuer-not-available,
could-not-route,
cardholder-account-closed,
account-closed,
account-not-activated,
authentication-failed,
authentication-required,
cardholder-action-required,
format-error,
invalid-pin,
offline-approved,
offline-declined,
partial-approval,
payment-stopped,
pin-required,
record-not-found,
surcharge-not-permitted,
transaction-reversed,
verification-failed,
unknown-issue,
duplicate-transaction
networkTransactionID
string
retrievalReferenceNumber
string
status
string<enum>
initiated,
confirmed,
canceled,
settled,
failed,
completed,
cleared-externally
instantBankCredit
object
Show child attributes
processingDetails.instantBankCredit
network
string<enum>
required
fednow,
rtp
status
string<enum>
required
initiated,
completed,
failed,
accepted-without-posting
endToEndID
string
failureCode
string<enum>
processing-error,
invalid-account,
account-closed,
account-blocked,
invalid-field,
transaction-not-supported,
limit-exceeded,
invalid-amount,
customer-deceased,
participant-not-available,
other
networkResponseCode
string
pullFromCard
object
Show child attributes
processingDetails.pullFromCard
status
string<enum>
required
initiated,
failed,
completed
authorizationCode
string
failureCode
string<enum>
call-issuer,
do-not-honor,
processing-error,
invalid-transaction,
invalid-amount,
no-such-issuer,
reenter-transaction,
cvv-mismatch,
lost-or-stolen,
insufficient-funds,
invalid-card-number,
invalid-merchant,
expired-card,
incorrect-pin,
transaction-not-allowed,
suspected-fraud,
amount-limit-exceeded,
velocity-limit-exceeded,
revocation-of-authorization,
card-not-activated,
issuer-not-available,
could-not-route,
cardholder-account-closed,
account-closed,
account-not-activated,
authentication-failed,
authentication-required,
cardholder-action-required,
format-error,
invalid-pin,
offline-approved,
offline-declined,
partial-approval,
payment-stopped,
pin-required,
record-not-found,
surcharge-not-permitted,
transaction-reversed,
verification-failed,
unknown-issue,
duplicate-transaction
networkResponseCode
string
networkTransactionID
string
pushToCard
object
Show child attributes
processingDetails.pushToCard
status
string<enum>
required
initiated,
deferred,
canceled,
failed,
completed
authorizationCode
string
failureCode
string<enum>
call-issuer,
do-not-honor,
processing-error,
invalid-transaction,
invalid-amount,
no-such-issuer,
reenter-transaction,
cvv-mismatch,
lost-or-stolen,
insufficient-funds,
invalid-card-number,
invalid-merchant,
expired-card,
incorrect-pin,
transaction-not-allowed,
suspected-fraud,
amount-limit-exceeded,
velocity-limit-exceeded,
revocation-of-authorization,
card-not-activated,
issuer-not-available,
could-not-route,
cardholder-account-closed,
account-closed,
account-not-activated,
authentication-failed,
authentication-required,
cardholder-action-required,
format-error,
invalid-pin,
offline-approved,
offline-declined,
partial-approval,
payment-stopped,
pin-required,
record-not-found,
surcharge-not-permitted,
transaction-reversed,
verification-failed,
unknown-issue,
duplicate-transaction
networkResponseCode
string
networkTransactionID
string
refundedAmount
object
Show child attributes
refundedAmount
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
scheduleID
string
source
object
Show child attributes
source
account
object
Show child attributes
source.account
accountID
string
required
displayName
string
required
string
required
applePay
object
Show child attributes
source.applePay
brand
string<enum>
required
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardDisplayName
string
required
User-friendly name of the tokenized card returned by Apple.
It usually contains the brand and the last four digits of the underlying card. There is no standard format.
cardType
string<enum>
required
debit,
credit,
prepaid,
unknown
dynamicLastFour
string
required
expiration
object
required
Show child attributes
source.applePay.expiration
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
issuerCountry
string
bankAccount
object
Show child attributes
source.bankAccount
bankAccountID
string
required
bankAccountType
string<enum>
required
checking,
savings,
general-ledger,
loan
bankName
string
required
fingerprint
string
<=100 characters
required
Once the bank account is linked, we don't reveal the full bank account number.
The fingerprint acts as a way to identify whether two linked bank accounts are the same.
holderName
string
required
holderType
string<enum>
required
individual,
business,
guest
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
riskVerificationOutcome
string
notAttempted when
requestRiskVerification was not set, or the calling account was not allowlisted.
notAttempted,
success,
inconclusive,
decline
card
object
Show child attributes
source.card
billingAddress
object
required
Show child attributes
source.card.billingAddress
addressLine1
string
<=60 characters
addressLine2
string
<=32 characters
city
string
<=32 characters
country
string
<=2 characters
postalCode
string
<=10 characters
required
stateOrProvince
string
<=2 characters
bin
string
[6 to 8] characters
required
brand
string<enum>
required
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardID
string
required
cardType
string<enum>
required
debit,
credit,
prepaid,
unknown
cardVerification
object
required
Show child attributes
source.card.cardVerification
addressLine1
string
required
postalCode; the card network returns a single code covering both address fields.
noMatch,
match,
notChecked,
unavailable,
partialMatch
cvv
string
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
postalCode
string
required
addressLine1; the card network returns a single code covering both address fields.
noMatch,
match,
notChecked,
unavailable,
partialMatch
accountName
object
Show child attributes
source.card.cardVerification.accountName
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
expiration
object
required
Show child attributes
source.card.expiration
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
lastFourCardNumber
string
4 characters
required
cardAccountUpdater
object
Show child attributes
source.card.cardAccountUpdater
updateType
string<enum>
unspecified,
account-closed,
contact-cardholder,
expiration-update,
no-change,
no-match,
number-update
updatedOn
string<date-time>
cardOnFile
boolean
domesticPullFromCard
string<enum>
not-supported,
supported,
unknown
domesticPushToCard
string<enum>
not-supported,
standard,
fast-funds,
unknown
holderName
string
issuer
string
issuerCountry
string
merchantAccountID
string
googlePay
object
Show child attributes
source.googlePay
brand
string<enum>
required
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardDisplayName
string
required
User-friendly name of the tokenized card returned by Google Pay.
It usually contains the last four digits of the underlying card. There is no standard format.
cardType
string<enum>
required
debit,
credit,
prepaid,
unknown
dynamicLastFour
string
4 characters
required
expiration
object
required
Show child attributes
source.googlePay.expiration
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
tokenID
string
required
authMethod
string<enum>
PAN_ONLY,
CRYPTOGRAM_3DS
issuerCountry
string
paymentMethodID
string
paymentMethodType
string<enum>
moov-wallet,
ach-debit-fund,
ach-debit-collect,
ach-credit-standard,
ach-credit-same-day,
rtp-credit,
card-payment,
push-to-card,
pull-from-card,
apple-pay,
card-present-payment,
instant-bank-credit,
push-to-apple-pay,
pull-from-apple-pay,
google-pay,
push-to-google-pay,
pull-from-google-pay
terminalCard
object
Show child attributes
source.terminalCard
applicationID
string
applicationName
string
bin
string
[6 to 8] characters
brand
string<enum>
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardType
string<enum>
debit,
credit,
prepaid,
unknown
entryMode
string<enum>
contactless
expiration
object
Show child attributes
source.terminalCard.expiration
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
holderName
string
issuer
string
issuerCountry
string
lastFourCardNumber
string
4 characters
transferID
string
wallet
object
Show child attributes
source.wallet
partnerAccountID
string<uuid>
required
walletID
string
required
walletType
string<enum>
required
Type of a wallet.
default: The system-generated wallet automatically created when an account is granted the wallet capability.general: An additional, user-defined wallet created via API or Dashboard.card-issuing: The system-generated wallet automatically created when an account is granted the card-issuing capability.
default,
general,
card-issuing
status
string<enum>
created,
pending,
completed,
failed,
reversed,
queued,
awaiting-capture,
canceled
sweepID
string
transferID
string
transferType
string<enum>
card-payment,
push-to-card,
pull-from-card,
ach-debit,
ach-credit,
ach-debit-to-ach-credit,
instant-bank-credit,
wallet