Requesting the BIN Lookup Service with Fast Funds Eligibility Using the REST API {#bin-lookup-payouts-req-task} =============================================================================================================== Send one of these payment credentials to the BIN Lookup Service to retrieve BIN information and fast funds eligibility. **Payment Card Numbers** * Full payment card number **Tokens** * `TMS` customer ID token * `TMS` payment instrument token * `TMS` instrument identifier token * `TMS` jti transient token * `Flex API` JWT transient token Follow these steps to request the BIN Lookup Service with Fast Funds: 1. Send the request to the BIN Lookup Service endpoint: #### ADDITIONAL INFORMATION `POST https://<``url_prefix``>/bin/v1/binlookup ` #### ADDITIONAL INFORMATION Use one of these URL prefixes: * Test: `apitest.cybersource.com` * Production: `api.cybersource.com` * Production in India: `api.in.cybersource.com` 2. Include one of the prerequisite fields in the request: * paymentInformation.card.number (Full payment card number is recommended.) * paymentInformation.customer.id * paymentInformation.instrumentIdentifier.id * paymentInformation.paymentInstrument.id * tokenInformation.jti * tokenInformation.transientTokenJwt {#bin-lookup-payouts-req-task_choices_az2_s4v_f5b} 3. Request the service. Set processingInformation.payoutOptions.payoutInquiry to true. 4. Include optional fields in the request as needed. 5. Check the response message to make sure that the request was successful. A 200-level HTTP response code indicates success. For information about response codes, see [BIN Lookup Response Codes](/docs/cybs/en-us/bin-lookup/developer/all/rest/bin-lookup/bin-lookup-reference-intro/bin-lookup-resp-codes.md ""). {#bin-lookup-payouts-req-task_response-rest} Required Fields for the BIN Lookup Service with Fast Funds Eligibility Using the REST API {#bin-lookup-payouts-service-fields} ============================================================================================================================== Include this fast funds eligibility field in the request for the BIN Lookup Service: [processingInformation.payoutOptions.payoutInquiry](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-payout-opts-payout-inqry.md "") : Set this field to `true` to get fast funds eligibility information in the response. Include one of these payment credential fields in the request: [paymentInformation.card.number](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-card-number.md "") : Set this field to the full payment card number (recommended) or network token. [paymentInformation.customer.id](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-customer-id.md "") : [paymentInformation.instrumentIdentifier.id](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-instrument-identifier-id.md "") : [paymentInformation.paymentInstrument.id](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-instrument-id.md "") : [tokenInformation.jti](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/token-info-aa/token-info-jti.md "") : [tokenInformation.transientTokenJwt](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/token-info-aa/token-info-transient-token-jwt.md "") : Optional Fields for the BIN Lookup Service with Fast Funds Eligibility Using the REST API {#bin-lookup-payouts-opt-fields} ========================================================================================================================== These fields are optional for a BIN Lookup Service request with fast funds eligibility information: [paymentAccountInformation.network.id](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-account-info-aa/payment-account-info-network-id.md "") : [processingInformation.binSource](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-bin-source.md "") : [processingInformation.payoutOptions.acquirerBin](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-payout-opts-acq-bin.md "") : [processingInformation.payoutOptions.networkID](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-payout-opts-ntwrk-id.md "") : Testing the BIN Lookup Service with Fast Funds Eligibility Using the REST API {#bin-lookup-payouts-test-proc} ============================================================================================================= `Cybersource` provides these test payment card numbers for requesting the BIN Lookup Service with fast funds eligibility in the test environment. Do not use real payment card numbers. Remove spaces when sending card numbers to `Cybersource`. Test Payment Card Numbers for the BIN Lookup Service with Fast Funds {#bin-lookup-payouts-test} =============================================================================================== Use these payment card numbers to test the BIN Lookup Service with fast funds at the test endpoint: `https://apitest.cybersource.com``/bin/v1/binlookup` | Card Number | Card Type | Card Platform and/or Product | Issuer Country | Account Funding Source | |:--------------------|:----------|:-----------------------------|:---------------|:-----------------------| | 4761 0800 0000 0003 | Visa | Consumer | AE | Debit | | 4515 8600 0004 1118 | Visa | Consumer | US | Debit | | 4515 2200 0008 1111 | Visa | Business | AL | Debit | | 4473 3000 0051 1117 | Visa | Business | AM | Debit | | 4846 7000 0973 1113 | Visa | Business | AO | Debit | [Test Payment Card Numbers and Card Information] Examples: Requests to the BIN Lookup Service with Fast Funds Eligibility Using the REST API {#bin-lookup-payouts-card-example} ============================================================================================================================== These examples show various BIN Lookup Service requests with fast funds eligibility options enabled and successful responses. Request Example: BIN Lookup Service with a Payment Card and Fast Funds Eligibility ``` { "paymentInformation": { "card": { "number": "4761080000000003" } }, "processingInformation": { "payoutOptions": { "payoutInquiry": true } } } ``` Response 201 Example: Successful BIN Lookup Service with Fast Funds Eligibility ``` { "id": "6590834057836283403955", "submitTimeUtc": "2022-07-29T08:30:05Z", "status": "COMPLETED", "paymentAccountInformation": { "card": { "type": "001", "brandName": "VISA", "maxLength": "16", "currency": "AED", "credentialType": "PAN" }, "features": { "accountFundingSource": "DEBIT", "cardPlatform": "CONSUMER", "comboCard": "0" } }, "issuerInformation": { "name": "INTL HDQTRS-CENTER OWNED", "country": "AE" "accountPrefix": "4111111" }, "payoutInformation": { "pushFunds": { "moneyTransferFastFundsCrossBorder": "Y", "moneyTransferFastFundsDomestic": "Y", "moneyTransferCrossBorder": "Y", "moneyTransferDomestic": "Y", "nonMoneyTransferFastFundsCrossBorder": "Y", "nonMoneyTransferFastFundsDomestic": "Y", "nonMoneyTransferCrossBorder": "Y", "nonMoneyTransferDomestic": "Y", "onlineGamblingFastFundsCrossBorder": "Y", "onlineGamblingFastFundsDomestic": "Y", "onlineGamblingCrossBorder": "Y", "onlineGamblingDomestic": "Y" } } } ``` Response 201 Example: BIN Lookup Service with Fast Funds Eligibility (Brazil) ``` { "id": "6590834057836283403955", "submitTimeUtc": "2022-05-19T03:21:03Z", "status": "COMPLETED", "paymentAccountInformation": { "card": { "type": "001", "brandName": "VISA", "maxLength": "16", "currency": "USD" }, "features": { "accountFundingSource": "PREPAID", "cardPlatform": "CONSUMER", "cardProduct": "Visa Electron", "comboCard": "0" } }, "issuerInformation": { "name": "BANCO DO BRASIL S.A.", "country": "BR", "phoneNumber": "5555555555", "binLength": "6" "accountPrefix": "4111111" }, "payoutInformation": { "pushFunds": { "moneyTransferFastFundsCrossBorder": "N", "moneyTransferFastFundsDomestic": "N", "moneyTransferCrossBorder": "Y", "moneyTransferDomestic": "Y", "nonMoneyTransferFastFundsCrossBorder": "N", "nonMoneyTransferFastFundsDomestic": "N", "nonMoneyTransferCrossBorder": "Y", "nonMoneyTransferDomestic": "Y", "onlineGamblingFastFundsCrossBorder": "N", "onlineGamblingFastFundsDomestic": "N", "onlineGamblingCrossBorder": "Y", "onlineGamblingDomestic": "Y" } } } ```