Skip to main content

​
Overview

Link a debit or credit card to enable card-based payouts and withdrawals. This endpoint allows you to connect a customer’s card as a payout destination.

​
Prerequisites

  • An application token (obtained from creating a payout link or account widget)
  • Valid access token

​
Endpoint

  • POST {{LIQUIDITY_URL}}/v1/ext/application-token/:token/linked-accounts/:currency/link/card/:step
  • Auth: Bearer {{accessToken}}

​
Path Parameters

ParameterTypeDescriptionRequired
tokenstringApplication token from payout/account widgetYes
currencystringCurrency code (e.g., USD)Yes
stepstringUsually 1Yes

​
Request

curl -X POST "{{LIQUIDITY_URL}}/v1/ext/application-token/{{token}}/linked-accounts/USD/link/card/1" \
  -H "Authorization: Bearer {{accessToken}}" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Card - Debit Card",
    "data": {
      "firstName": "Timilehin",
      "lastName": "Makinde",
      "name": "Quantum Works LLC",
      "cardNumber": "5525630721424710",
      "expirationDate": "2026-09",
      "recipientAddress": "recipientAddress",
      "recipientCity": "recipientCity",
      "recipientState": "Alabama",
      "recipientPostalCode": "30301-4321",
      "email": "timi@gradientfi.com"
    }
  }'

​
Request Body Fields

FieldTypeDescriptionRequired
labelstringDisplay name for the linked cardYes
data.firstNamestringCardholder first nameYes
data.lastNamestringCardholder last nameYes
data.namestringCard/business nameYes
data.cardNumberstringFull card numberYes
data.expirationDatestringExpiration in YYYY-MM formatYes
data.recipientAddressstringAddress line for cardholderYes
data.recipientCitystringCity for cardholderYes
data.recipientStatestringState for cardholderYes
data.recipientPostalCodestringZIP/postal codeYes
data.emailstringEmail of cardholderYes

​
Response (200)

{
  "data": {
    "type": "completed",
    "message": "Account successfully linked!",
    "data": {
      "id": "119d213c-65a9-4485-b2bc-14c6dc5a3fb1",
      "currency": "USD",
      "optionType": "card",
      "account": {
        "label": "Josh Doe",
        "lastFourDigits": "9676"
      },
      "wallet": {
        "id": "3eb8d02c-30e0-497c-a6ac-e2d203c63198",
        "balance": "99811.95",
        "disabled": false
      },
      "entity": {
        "id": "d5e6f1dd-57bc-4581-98e8-646264a5f2c9",
        "entityType": "BUSINESS"
      }
    }
  }
}

​
Response Fields

FieldTypeDescription
data.data.idstringLinked account ID (use for withdrawals)
data.data.currencystringCurrency of the linked account
data.data.optionTypestringAccount type: card
data.data.account.labelstringDisplay label for the card
data.data.account.lastFourDigitsstringLast 4 digits of card number
data.data.wallet.idstringAssociated wallet ID
data.data.wallet.balancestringCurrent wallet balance
data.data.entity.idstringEntity ID associated with the card
data.data.entity.entityTypestringEntity type: USER or BUSINESS

​
Notes

  • Store the id from the response for use in withdrawal requests
  • Card numbers should be provided in full (typically 16 digits)
  • Expiration date should be in MM/YYYY format
  • The linked card can be used for withdrawals once successfully created
  • Ensure card details are accurate to avoid processing failures