Push to Card

Push to Card is a convenient method for sending funds directly to a recipient's debit card, offering near-instantaneous transfers for domestic payouts. This method is ideal for beneficiaries who prefer receiving payments directly to their cards rather than through a bank account, providing flexibility and speed.

The usual workflow for integrating with the non-hosted solution involves the following steps:

Step 1: Authenticate: Obtain an API token by validating your credentials.

Step 2: Create Beneficiary: Create and manage beneficiary's accounts using API calls.

Step 3: Create a Sender: Identify who is originating the payout. Every transfer requires a sender.

Step 4: Create Transfer Method: Add and manage transfer methods for your beneficiaries.

Step 5: Validate Card Eligibility: Confirm the card can receive a Push to Card payout before transferring.

Step 6: Create Transfer: Execute and manage transfers between accounts.

API Endpoints Used

This guide will demonstrate step-by-step instructions using the API integration method. In this guide, you will use the following API endpoints:

Below, you will go through the necessary API calls to achieve the steps above within the i-payout system.

Step 1: Authenticate

To start using i-payout solutions, you will need to authenticate with your API Token. Refer to the Get a Token guide to learn how to:

Step 2: Create Beneficiary

A beneficiary is an individual designated to receive funds or payments through the i-payout system. To create a beneficiary, you will need to provide detailed information about the individual, such as their name, address, and payment details.

Use the Create Beneficiary endpoint to create a new beneficiary. The request should include all necessary details about the beneficiary in the request body and, as shown in Step 1, include the authentication to access the i-payout API. Below, you will find an example request to create a new beneficiary:

curl --request POST \
     --url "https://merchantapi.testewallet.com/api/v1/beneficiaries" \
     --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
        "username": "john_doe",
        "firstName": "John",
        "lastName": "Doe",
        "emailAddress": "[email protected]"
    }'

{
  "data": {
    "beneficiaryToken": "e0e4764b-9619-4deb-95c4-108ce9f0fe04"
  },
  "isSuccess": true,
  "message": "Customer created successfully",
  "statusCode": "NO_ERROR",
  "logIdentifier": "497b73624c0d47bfb0abf58df5dd99ca"
}

Step 3: Create a Sender

A sender identifies the originating party of the payout. You must create a sender before initiating a transfer. Use the Create Sender endpoint to register a new sender in the system.

The senderID and emailAddress fields are required. Only company senders are supported at this time, so you must provide the companyName field. All other fields are optional but recommended for compliance and record-keeping purposes. Below, you will find an example request to create a new sender:

curl --request POST \
     --url "https://merchantapi.testewallet.com/api/v1/beneficiaries/sender" \
     --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
        "senderID": "SENDER_001",
        "companyName": "Acme Corp",
        "emailAddress": "[email protected]",
        "address1": "123 Main Street",
        "country": "US"
    }'

{
  "isSuccess": true,
  "message": "Sender created successfully",
  "statusCode": "NO_ERROR",
  "logIdentifier": "abc123def456",
  "data": {
    "senderToken": "f1e2d3c4-b5a6-7890-abcd-ef1234567890"
  }
}

Step 4: Create Transfer Method

To manage how funds are transferred to beneficiaries, you need to create a transfer method. To add a Push to Card transfer method for your beneficiary, use the Add Credit Card endpoint. This method requires a credit card and the relevant details:

curl -X POST "https://merchantapi.testewallet.com/api/v1/transfermethods/beneficiaries/<BENEFICIARY_TOKEN_FROM_STEP_2>/credit-cards" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "X-MerchantId: <YOUR_MERCHANT_ID>" \
  -H "Content-Type: application/json" \
  -d '{
    "beneficiaryFirstName": "John",
    "beneficiaryLastName": "Doe",
    "creditCardNumber": "4111111111111111",
    "expiryMonth": "12",
    "expiryYear": "2026",
    "beneficiaryAddress1": "123 Elm St",
    "beneficiaryCity": "Los Angeles",
    "beneficiaryState": "CA",
    "beneficiaryZipCode": "90001",
    "beneficiaryCountry": "US",
    "beneficiaryPhoneNumber": "+1 555-1234",
    "cardType": "DebitCard"
}'

{
  "isSuccess": true,
  "message": "Card added successfully",
  "statusCode": "NO_ERROR",
  "logIdentifier": "def456ghi789",
  "data": {
    "token": "bankAcc123Token",
    "isDocumentVerificationRequired": false
  }
}

Step 5: Validate Card Eligibility

Before creating the transfer, confirm the card is eligible for Push to Card in the beneficiary's country and currency. Use the Validate Push to Card Eligibility endpoint:

curl --request GET \
     --url "https://merchantapi.testewallet.com/api/v1/lookups/cards/validate-push-to-card-eligibility/4111111111111111?cardCountry=US&cardType=DebitCard" \
     --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json'

{
  "isSuccess": true,
  "message": "Card is eligible for Push to Card",
  "statusCode": "NO_ERROR",
  "logIdentifier": "abc123def456",
  "data": {
    "countryCode": "US",
    "cardBrand": "Visa",
    "cardType": "Debit",
    "isEligible": true,
    "errorReason": null
  }
}

Only proceed to Step 6 if isEligible is true. If it's false, check errorReason for why the card can't be used for Push to Card.

Step 6: Create Transfer

With the new beneficiaries created in the system, you can now pay them. This is done by transferring funds to them. The Create Transfer endpoint will be used to make the transfer from you to your beneficiary by linking the transfer with the beneficiaryToken created on Step 2 and the senderToken created in Step 3.

To transfer via Push to Card, the destinationType should be DebitCard.

Below, you will find an example request to create a new transfer:

curl --request POST \
     --url "https://merchantapi.testewallet.com/api/v1/transfers" \
     --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header "accept: application/json" \
     --header "Content-Type: application/json" \
     --data '{
         "merchantTransactionId": "TX123456",
         "beneficiaryToken": "<beneficiaryToken_from_step_2>",
         "senderToken": "<senderToken_from_step_3>",
         "autoApprove": true,
         "comments": "Payment for services",
         "dateExpire": "2024-12-31T23:59:59.999Z",
         "sourceAmount": 100.00,
         "sourceCurrency": "USD",
         "destinationAmount": 100.00,
         "destinationCurrency": "USD",
         "destinationType": "DebitCard"
     }'

{
  "isSuccess": true,
  "message": "Transfer created successfully",
  "statusCode": "NO_ERROR",
  "logIdentifier": "abc123def456",
  "data": {
    "token": "trans789token",
    "dateCreated": "2024-07-09T16:17:00.548Z",
    "dateUpdated": "2024-07-09T16:17:00.548Z",
    "statusId": 1,
    "status": "CREATED",
    "fxRate": 1.05,
    "beneficiaryFee": 2.50,
    "merchantFee": 1.00,
    "senderToken": "f1e2d3c4-b5a6-7890-abcd-ef1234567890"
  }
}

Monitor Transfer Status

After creating a transfer, there are two ways to track its progress:

Option A: Transfer Reports (Recommended)

Use the Get Transfers Report endpoint to retrieve the status and details of your transfers on demand. This is the primary way to check on transfers, especially when processing multiple payments and you need to review statuses in bulk. You can filter results by beneficiary, status, date range, currency, and more. The maximum pageSize is 100 records per request.

Option B: Webhook Notifications

For real-time updates without polling the API, subscribe to webhook events. We recommend the following events:

• TRANSFER.CREATED: triggers when a transfer is created, confirming the payout was initiated.
• TRANSFER.STATUS.UPDATED: triggers when the transfer status changes (e.g., PROCESSING, APPROVED, DECLINED, CANCELLED, ON_HOLD, SETTLED).

Transfers placed on ON_HOLD may include sub-statuses with additional detail.

To start receiving webhook notifications, follow the How to Set Up Webhooks guide. For a full list of available events and example payloads, see Webhook Events.

Other Available Payout Methods

Follow the links below to learn more about other available payout methods:

• eWallet
• Regular ACH
• Same-day ACH
• Real-time ACH
• International Bank
• Swift Wire