Skip to main content

Documentation

Retrieve Card Eligibility Details

Retrieve information about a beneficiary’s card to determine whether it is eligible for card payouts (Original Credit Transactions (OCT)), and card payments (Account Funding Transactions (AFT)). Currently available for Visa cards.

See also Card Eligibility for Card Payouts.

    • card_number

    • The number of the card. In the sandbox, use the number 4895034400003371 to simulate this method with a Visa card. Required when card_id is not used.

    • card_id

    • ID of the card, a string starting with card_. Required when card_number is not used.

    • transaction_type

    • The type of transaction. One of the following:

      • all - OCT and AFT transactions.

      • oct - Original Credit Transactions (OCT).

      • aft - Account Funding Transaction (AFT).

  • /v1/cards/eligibility

  • Retrieve Card Eligibility - Visa

  • curl -X post
    https://sandboxapi.rapyd.net/v1/cards/eligibility
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '
    {
       "card_number": "4895034400003371",
       "transaction_type": "all"
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "df0d84ea-435e-4c28-adf6-db069ef0778b"
        },
        "data": {
            "scheme": "VISA",
            "card_type": "Consumer",
            "billing_currency": "USD",
            "issuer": "Visa Test Bank",
            "issuer_country": "US",
            "product_type": "Credit",
            "oct": {
                "money_transfer_domestic": "standard",
                "money_transfer_international": "standard",
                "non_money_transfer_domestic": "standard",
                "non_money_transfer_international": "standard",
                "online_gambling_domestic": "not_supported",
                "online_gambling_international": "not_supported"
            },
            "aft": {
                "domestic": true,
                "international": false
            }
        }
    }
  • Retrieve Card Eligibility - Card ID

  • curl -X post
    https://sandboxapi.rapyd.net/v1/cards/eligibility
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '
    {
       "card_id": "card_b730347e7b509e6be0091092c78db1b2",
       "transaction_type": "all"
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "fe3fe8d0-a86d-4c7e-ac9d-c81c4dbfb5a1"
        },
        "data": {
            "scheme": "VISA",
            "card_type": "Consumer",
            "billing_currency": "USD",
            "issuer": "Visa Test Bank",
            "issuer_country": "US",
            "product_type": "Credit",
            "oct": {
                "money_transfer_domestic": "standard",
                "money_transfer_international": "standard",
                "non_money_transfer_domestic": "standard",
                "non_money_transfer_international": "standard",
                "online_gambling_domestic": "not_supported",
                "online_gambling_international": "not_supported"
            },
            "aft": {
                "domestic": true,
                "international": false
            }
        }
    }    
Publication date: