Transfer Method

The "Transfer Method" enum identifies the method by which a transfer is sent and received. Different "Transfer Methods" come with different sender/recipient requirements, different compliance requirements, and varying fees/delivery times. Enabling new transfer methods can done in collaboration with your ReadyRemit account manager.

BANK_ACCOUNT: Transfers are sent via traditional SWIFT or ACH rails to a bank account. Field requirements usually include a bank account number and a routing number or equivalent but requirements can vary based on country. Bank Account transfers usually take anywhere between 1 and 3 days but can be slowed down by weekends and holidays.
CASH_PICKUP: With the Cash Pickup transfer type, funds are sent to a partner location in the specified country where the Recipient can retrieve the funds as cash. Cash Pickup transfers are often available faster than bank transfers.
PUSH_TO_CARD: ReadyRemit offers the ability to send money directly to a bank account by entering debit card information. Push-to-card transfers are available instantly and aren't limited by weekends or holidays. The Push-to-card transfer type requires additional effort to collect information from users while remaining PCI compliant. For more information, see the Push-to-card integration guide.

Quote By

The "Quote By" enum differentiates a quote or a transfer amount as either a "Send Amount" or a "Receive Amount".

SEND_AMOUNT: The quote or transfer amount represents the base amount being sent by the Sender. This amount plus the fee will be deducted from the sender account. The final receive amount will be calculated based on the exchange rate.
RECEIVE_AMOUNT: The quote or transfer amount represents the final amount being received by the Recipient. The send amount will be calculated based on the exchange rate.

Used in:

Recipient Type

"Recipient Type" defines the kind of entity receiving the funds for a Transfer. The fields required to send a transfer, compliance requirements, and risk level will change based on the type of the recipient.

PERSON: A person recipient represents an individual receiving funds. Use cases include sending money to a friend or relative, or to yourself.
BUSINESS: The BUSINESS "Recipient Type" represents a company or organization that receives funds. Use cases include paying a bill or invoice.

Sender Type

Sender types are identical to "Recipient Type" above.

KYC Status

"KYC Status" defines the current status of a sender as it relates to their progress through the KYC flow.

UNKNOWN: Primarily used for businesses.
PASSED: KYC passed either via the initial database check or from ID verification. Senders in this state should be allowed to complete a transfer.
ID_REQUIRED: The initial database check resulted in the need to verify the sender's physical ID document. Senders in this state should be prompted to begin the KYC ID Verification flow.
FAILED: The KYC checks or ID check failed. This state can only be recovered via interaction with support. Senders in this state should not be allowed to complete a remittance flow.
PENDING: Senders are in this state if they have submitted an ID for verification and are waiting for a result. Senders should be in the pending state for less than 30 seconds before moving to PASSED or FAILED.
REQUEST_FAILED: This state indicates there was an error confirming KYC status. Users in this state should be treated as FAILED but recovery is possible in collaboration with the ReadyRemit team.

Round Direction

The "Round Direction" enum is used to specify which rounding logic was/should be used for specific currencies.

STANDARD: Standard rounding means that the value should be rounded down to the appropriate significant digits if the next digit is <= 4
- 5.054 => 5.05
- 5.055 => 5.06
- 5.057 => 5.06
UP: This rounding method requires that the first non-significant digit always be rounded up
- 5.054 => 5.06
- 5.055 => 5.06
- 5.057 => 5.06
DOWN: The opposite of the "Up" method, the first non-significant digit will always be rounded down.
- 5.054 => 5.05
- 5.055 => 5.05
- 5.057 => 5.05

Used anywhere a currency is returned.

Field Type

See Dynamic Fields.

Card Onboarding Session Status

The current status of a Card Onboarding Session.

INCOMPLETE: The session is still in progress and a card has not yet been created
SUCCEEDED: The session is complete and a card has been successfully onboarded. You can expect the cardId property of the Get Card Onboarding Session API call to be populated.
EXPIRED: The session has expired and can no longer be used to onboard a card. In order to continue, a new Card Onboarding Session must be created using the Create card onboarding session API call.