Reloadable Disbursements

Reloadable Integration

  • Personalized –Digital & Physical

    • Step 1: User is enrolled into the Client platform and is designated to receive a disbursement.
      • The client will do an internal check to determine if the User has an active disbursement card.
    • Step 2: Client will initiate pre-funding from their account to the Virtual Funding Account (VFA).​
      • This can be done prior to loads or on a schedule based on the Client’s frequency of payouts.​
    • Step 3: The Client will execute on one of two flows based on step 1:
      • If this is the initial disbursement, the Client will initiate the payout by issuing a card account and designating the load.
        • Alternatively, the Client can issue as an initial step, and load the card at a later time.​
      • If this is a subsequent disbursement, the Client will check the card status using the proxy and order a new card if needed.
    • Step 4: Dash will generate the card account for the User with the Sponsor Bank.
      • Client will store the proxy for each card as the unique identifier.
      • Proxies for bulk card orders will not be immediately available.
    • Step 5: The card is delivered to the User based on the order instructions.
      • Digital orders will be sent via email/sms or returned as a tinyURL in the api response.
      • Physical cards will be delivered to the User’s address based on the delivery method designated.​
    • Step 6: The card account is funded with the appropriate amount per the load instructions.
    • Step 7: Subsequent loads to existing cards will use the proxy as the identifier.
      • Requires the pre-funding from step 2.​

    ​

  • INTEGRATION WALKTHROUGH

    Step 1: Order / Issue Cards

    Description:

    This step will execute the creation of the card account and issue the card to the payee when eligible for a reward.

    Pre-requisites:

    • sessionId – Acquired during the authentication process.
    • customerId – provided during client setup. Can be accessed from the /getCustomerList endpoint.
    • custProgId – provided during program setup. Can be accessed from the /getCustomerProgramList endpoint.

    Endpoint Details:

    • API Endpoint – /orderendpoint/v1
    • Call Type – POST
    • Path – /orderCards

    Considerations:

    • Card Type designation of digital will be used to provide immediate access to the card account.
      • Client configuration options would allow for issuing a digital card with a physical being automatically sent or physical cards can be requested by the cardholder in the digital experience.
      • Physical first personalized cards would designate the card type as ‘physical’.
    • Cards can be loaded separately during the order step.
    • Response will return 2 key identifiers that need to be stored by on the client side:
      • orderId – This is a unique identifier for the order that will be used to physical card tracking.
      • proxyKey – This is an overall unique account identifier that is used for reference or ancillary API calls. This is also used in load/unload calls for specific scenarios.
    • Bulk orders will not immediately return proxyKey; The orderId will be used to access the individual proxies once available.

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"custProgId": 987654,
"customerId": 12345,
"orderProdType": "Personalized Disbursement Order",
"cardType": "Digital",
"orderDetails": [
{
"firstName": "string",
"lastName": "string",
"phone": "string",
"email": "string", …

Step 2: Load Cards

Description:

This step will execute load of funds to the card account for the payee based on client level eligibility and approval requirements.

Pre-requisites:

  • sessionId – Acquired during the authentication process.
  • customerId – provided during client setup. Can be accessed from the /getCustomerList endpoint.
  • custProgId – provided during program setup. Can be accessed from the /getCustomerProgramList endpoint.
  • fundingId – provided during client setup. Can be accessed from the /getAllVirtualAccountsByCustomer.

Endpoint Details:

  • API Endpoint – /orderendpoint/v1
  • Call Type – POST
  • Path – /loadCards

Considerations:

  • Response will return confirmation of the load + the new balance for the card account.

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"customerId": 98709,
"custProgId": 115718,
"fundingId": 54850,
"orderDetails": [
{
"amount": "0.50",
"proxyKey": "0252516355546",…

Step 3: Resend Digital Card Account Links [Digital Only]

Description:

This step will trigger a resend of the email or sms notification to the User to activate and/or access the card feature through the digital experience.

Automated resend of the link can be configured for ‘un-activated’ cards.

Pre-requisites:

  • sessionId – Acquired during the authentication process.
  • proxyKey – Acquired during the original order request.
  • cpId – provided during program setup. Can be accessed from the /getCustomerProgramList endpoint.

Endpoint Details:

  • API Endpoint – /orderendpoint/v1
  • Call Type – GET
  • Path – /sendDigitalCardAlert

Considerations:

  • Response will return a success or failure.
  • Separate calls are needed between email or sms notification triggers.

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"

{

"cpId": 987654,

"proxyKey": 9376873800385,

"resendMethod": "[email] or [sms]",

"alertType": "Initial"

}…

Step 4: Order Details

Description:

This step will recall the complete order information

Pre-requisites:

  • sessionId – Acquired during the authentication process
  • orderId – Acquired during the order step

Endpoint Details:

  • API Endpoint – /orderendpoint/v1
  • Call Type – GET
  • Path – /getOrderDetailsByOrderId

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906",

"proxyKey": "1234567890123",

"customerProgramId": ”987654"

Step 5: Shipping Details [Physical Only]

Description:

This step will recall the shipping information for the physical card delivery and provide tracking if available

Pre-requisites:

  • sessionId – Acquired during the authentication process
  • proxyKey – Acquired during the original order request
  • custProgramId – provided during program setup. Can be accessed from the /getCustomerProgramList endpoint

Endpoint Details:

  • API Endpoint – /orderendpoint/v1
  • Call Type – GET
  • Path – /getShippingInformation

Considerations:

  • For bulk or batch order, the /getOrderTrackingInfo endpoint should be used.

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906",
"proxyKey": "1234567890123",
"customerProgramId": ”987654"