Skip to main content

Documentation

Card Eligibility for Card Payouts

Retrieve beneficiary card information. Currently available for Visa cards. | Enterprise

Rapyd’s API allows you to retrieve information about a beneficiary’s card. This allows you to determine if their card is eligible for card payouts called Original Credit Transactions (OCT) and card payments called Account Funding Transactions (AFT).

Determining eligibility for Original Credit Transactions validates if the card can be used for person-to-person transfers and disbursements. The card information the API provides can include: the card scheme, the card issuer, and the card issuer country.

Determining eligibility for Account Funding Transactions validates if the card can be used for domestic or international transactions.

The merchant can create a better experience for their customers by determining the card eligibility for a card payout or card payment.

Retrieve Card Eligibility Workflow
card-eligibility-flow-1.png

  1. You request Rapyd to retrieve the card metadata with the card number or card ID.

  2. Rapyd processes your request.

  3. The card metadata is provided by the Card Network (Visa).

  4. You receive the response with the card metadata from Rapyd.

How Card Eligibility for Card Payouts Works

Description of Path Parameters

See Retrieve Card Eligibility Details for additional details about the parameters.

Path Parameter

Required

Description

card_number

yes - either card number or card ID is required

16 - 19 digits

card_id

yes - either card number or card ID is required

The ID of the card. A string starting with card_.

transaction_type

yes

Possible values:

  • oct

  • aft

  • all

Retrieve Card Eligibility Details Request

    • Request

      • // Request URL: POST https://sandboxapi.rapyd.net/v1/cards/eligibility

// Message body:

{
    "card_number": "4895070000003551",
    "transaction_type": "all" 
}
Retrieve Card Eligibility Details Response

Retrieve Card Eligibility Details describes the fields in the response.

    • Response

      • {
    "status": {

        "error_code": "0",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "a1036ba7-7dbf-410d-b31e-eca3236ed79c"
    },
                                         
    "data": [
        "scheme":
        "card_type":
        "billing_currency":
        "issuer":
        "issuer_country":
        "product_type":
        "oct":{
            "money_transfer_domestic": standards,
            "money_transfer_international": fast_funds,
            "non_money_transfer_domestic": fast_funds
            "non_money_transfer_international": standards,
            "online_gambling_domestic": not_supported,
            "online_gambling_international": not_supported
        }
        "aft":{
            "domestic": true,
            "international": false,
}]}
In this section: