Initiate Receives

Overview

Receives are initiated to your virtual accounts using the Submit Receive Request endpoint. You can receive payments to your primary virtual account.

Step 1: Get the Channel ID

Before initiating a send, retrieve the appropriate channelId by calling the Channels endpoint. Filter the results for:

• channelType: virtualbank
• country: The country matching your virtual account (e.g., US, NG)
• currency: The currency matching your virtual account (e.g., USD, NGN)

The returned channelId is required when submitting the send request.

Step 2: Submit the Receive Request

Call the Submit Receive Request endpoint with the channelId, recipient details, the payment amount.

Supported Networks by Currency

Receive to Custom Wallet Virtual Accounts

To initiate a receive to a custom wallet virtual account instead of your primary YC wallet, include the walletId field in the request. The walletId is the id of the custom wallet returned when you created it.

{
    "recipient": {
        "name": "John soy",
        "country": "NG",
        "phone": "+2348012322123",
        "address": "Home Address",
        "dob": "02/01/1998",
        "email": "[email protected]",
        "idNumber": "314159",
        "idType": "license"
    },
    "source": {
        "accountType": "bank"
    },
    "channelType": "bank",,
		"walletId": "wallet-123",
    "currency": "NGN",
    "country": "NG",
    "sequenceId": "3fa8s5jhyu7i97g77-h9dij97h3fc-2cfdfa7",
    "amount": 100,
    "reason": "other",
    "customerUID": "2345676",
    "forceAccept": true
}

The only difference from a standard receive is the addition of the walletId field, which directs the receive to be paid to the specified custom wallet's virtual account.

Receives Webhooks

Receives webhook events are sent as the receive progresses through its lifecycle. For details on send webhook event types and statuses, refer to the Webhooks and Events page.