Prepaid Transfers

Create a new prepaid card transfer

POST /prepaid-payment/transfers/
Request Parameters and Recipient Information

Request Parameters

Parameter Type Required Description
requestIdstringYesUnique idempotency key (max 64 characters)
paymentDatestringYesTransfer execution date (ISO 8601 format)
currencystringYesPayment currency (USD or CAD)
amountnumberYesCard amount
prepaidProductstringYesProduct code (e.g., VISA-US, VISA-CA)
prepaidProductCountrystringYesProduct country (US, CA)
reasonstringNoTransfer reason
referencestringNoReference (max 16 characters)
internalReferencestringNoInternal reference (max 16 characters)
verificationTypestringYesVerification type (NONE/PHONE/PHONE_ADDRESS/ADDRESS)
verificationExpirationHoursnumberConditionalRequired for PHONE/PHONE_ADDRESS/ADDRESS (e.g., 24)

Recipient Information

Parameter Type Required Description
recipientTypestringYesCOMPANY or INDIVIDUAL
recipientFirstNamestringConditionalRequired for INDIVIDUAL
recipientLastNamestringConditionalRequired for INDIVIDUAL
recipientCompanyNamestringConditionalRequired for COMPANY
recipientEmailstringYesRecipient email address
recipientNickNamestringNoRecipient nickname
recipientPhoneNumberstringConditionalRequired for PHONE verification (e.g., +972507471111)
recipientCitystringNoRecipient city
recipientStatestringNoRecipient state
recipientCountrystringConditionalRequired for PHONE_ADDRESS/ADDRESS
recipientPostalCodestringConditionalRequired for PHONE_ADDRESS/ADDRESS
recipientAddressstringNoRecipient address

Response Example:

{
  "requestId": "92ab47a-1234-481e-5046-1e24c34dae0a",
  "paymentDate": "2024-01-01T00:00:00.000Z",
  "prepaidProductCountry": "US",
  "currency": "USD",
  "amount": 10,
  "prepaidProduct": "VISA-US",
  "verificationType": "PHONE_ADDRESS",
  "recipientFirstName": "John",
  "recipientLastName": "Smith",
  "recipientEmail": "[email protected]",
  "recipientPhoneNumber": "+12145596993",
  "recipientCountry": "US",
  "recipientPostalCode": "77590",
  "verificationExpiryHours": 24
}