ReadyRemit Transfer Request

Transfer request structure sent to your callback

Overview

The ReadyRemitTransferRequest type defines the structure of transfer requests that the SDK sends to your verifyFundsAndCreateTransfer callback. This object contains all the information needed to verify funds and create a transfer on your backend.

Definition

export type ReadyRemitTransferRequest = {
  fields?: [ReadyRemitTransferRequestField] | undefined;
  quoteBy: string;
  quoteHistoryId: string;
  recipientAccountId?: string | undefined;
  recipientId: string;
  sourceAccountId?: string | undefined;
}

export type ReadyRemitTransferRequestField = {  
  id: string;
  type: string;
  value: string;
}

Properties

Property	Type	Required	Description
fields	`ReadyRemitTransferRequestField[]`	No	Additional custom fields for the transfer
quoteBy	`string`	Yes	The entity that provided the quote
quoteHistoryId	`string`	Yes	Unique identifier for the quote used in this transfer
recipientAccountId	`string`	No	The recipient's account identifier
recipientId	`string`	Yes	Unique identifier for the recipient
sourceAccountId	`string`	No	The source account identifier for the transfer

ReadyRemitTransferRequestField Properties

Property	Type	Required	Description
id	`string`	Yes	Unique identifier for the field
type	`string`	Yes	The data type of the field
value	`string`	Yes	The value of the field

Sample Usage

import type { 
  ReadyRemitTransferRequest, 
  ReadyRemitTransferResponse, 
  ReadyRemitError 
} from 'react-native-ready-remit-sdk';

const verifyFundsAndCreateTransfer = async (
  request: ReadyRemitTransferRequest
): Promise<ReadyRemitTransferResponse | ReadyRemitError> => {
  console.log('Transfer Request:', {
    recipientId: request.recipientId,
    quoteHistoryId: request.quoteHistoryId,
    sourceAccountId: request.sourceAccountId,
  });

  // Forward the request to your backend
  const response = await fetch('https://your-api.com/transfers', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      recipient_id: request.recipientId,
      quote_history_id: request.quoteHistoryId,
      source_account_id: request.sourceAccountId,
      recipient_account_id: request.recipientAccountId,
      fields: request.fields,
    }),
  });

  if (!response.ok) {
    return {
      code: 'TRANSFER_FAILED',
      message: 'Transfer could not be processed',
    };
  }

  const data = await response.json();
  return { transferId: data.id };
};

Example Request Object

{
  "recipientId": "RCP-123456",
  "quoteBy": "convera",
  "quoteHistoryId": "QH-2026-0204-ABC123",
  "sourceAccountId": "SRC-789012",
  "recipientAccountId": "RCPA-345678",
  "fields": [
    {
      "id": "purpose_of_transfer",
      "type": "string",
      "value": "family_support"
    }
  ]
}

Related

Verify Funds and Create Transfer - Callback that receives this request
ReadyRemitTransferResponse - Success response structure
ReadyRemitError - Error response structure

Updated 4 days ago