Receive a Debit Pull

Receive a debit pull payment from a contact.
Receive a Debit Pull
 last updated: 
February 28, 2022

To stay in PCI compliance, you need to tokenize the card while collecting the contact's full card information including card number, expiry and CVV. We have partnered with VGS to bring this functionality to you.

There are two steps involved in showing the full card information:
Step 1: Create a Debit Card Token
Step 2: Update the Contact (with debit card info) using the Token
Step 3: Receive a Debit Pull Payment

Step 1: Create a Debit Card Token

ENDPOINT

  1. POST /v1/contact/{{contactId}}/debitcard/token

RESPONSE

  1. {
  2.     "id": "con-cf2e03cc-7fd1-4262-a5de-29e12d207f7d",
  3.     "debitCardToken": "contact-debit-card-test-900241cd-b3a0-4614-9811-0cbc90a9811d"
  4. }

Step 2: Update the Contact (with debit card info) using the Token

Do not include the sd-api-key and sd-person-id in the header. Include sd-debitcard-token (it is the token that you receive in Step 1) and sd-vgs-authorization. Token is valid for 5 minutes and can be used only once.
Note: Your Customer Success Manager will provide you with the VGS Authorization in Prod-TEST and Prod-LIVE
See example of the cURL request below:

  1. curl --location --request PATCH 'https://test-api.solidfi.com/v1/contact/:id/debitcard' \
  2. --header 'sd-debitcard-token: <token>’ \
  3. --header 'sd-vgs-authorization: <vgs_authorization> ' \
  4. --header 'Content-Type: application/json' \
  5. --data-raw '{
  6.     "debitCard": {
  7.         "expiryMonth": "10",
  8.         "expiryYear": "2022",
  9.         "cardNumber": "9010111999999992",
  10.         "cvv": "123",
  11.         "address": {
  12.             "addressType": "card",
  13.             "line1": "123  Main  St",
  14.             "line2": "",
  15.             "city": "New York",
  16.             "state": "NY",
  17.             "country": "US",
  18.             "postalCode": "10001"
  19.         }
  20.     }
  21. }'

RESPONSE

  1. {
  2.     "id": "con-cf2e03cc-7fd1-4262-a5de-29e12d207f7d",
  3.     "accountId": "acc-9eb9d71e-1656-4f68-8ed9-06b78ba34566",
  4.     "name": "Bright Light LLC",
  5.     "email": "dwightlight@gmail.com",
  6.     "phone": "+18467051332",
  7.     "status": "active",
  8.     "intrabank": null,
  9.     "ach": {
  10.         "accountNumber": "1098324502",
  11.         "routingNumber": "121042882",
  12.         "accountType": "businessChecking",
  13.         "bankName": "Wells Fargo"
  14.     },
  15.     "createdAt": "2022-03-01T01:50:17Z",
  16.     "modifiedAt": "2022-03-01T01:51:58Z",
  17.     "wire": {
  18.         "domestic": {
  19.             "accountNumber": "1098324502",
  20.             "routingNumber": "121042882",
  21.             "accountType": "businessChecking",
  22.             "bankName": "Wells Fargo",
  23.             "address": {
  24.                 "addressType": "wire",
  25.                 "line1": "123 Main St",
  26.                 "line2": "",
  27.                 "city": "New York",
  28.                 "state": "NY",
  29.                 "country": "US",
  30.                 "postalCode": "10001"
  31.             }
  32.         },
  33.         "international": null
  34.     },
  35.     "check": {
  36.         "address": {
  37.             "addressType": "check",
  38.             "line1": "123 Main St",
  39.             "line2": "",
  40.             "city": "New York",
  41.             "state": "NY",
  42.             "country": "US",
  43.             "postalCode": "10001"
  44.         }
  45.     },
  46.     "card": {
  47.         "address": {
  48.             "addressType": "card",
  49.             "line1": "123 Main St",
  50.             "line2": "",
  51.             "city": "New York",
  52.             "state": "NY",
  53.             "country": "US",
  54.             "postalCode": "10001"
  55.         }
  56.     },
  57.     "type": "others",
  58.     "metadata": null,
  59.     "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  60.     "debitCard": {
  61.         "cardNumber": "9010111999999992",
  62.         "cvv": "123",
  63.         "expiryMonth": "10",
  64.         "expiryYear": "2022",
  65.         "address": {
  66.             "addressType": "card",
  67.             "line1": "123 Main St",
  68.             "line2": "",
  69.             "city": "New York",
  70.             "state": "NY",
  71.             "country": "US",
  72.             "postalCode": "10001"
  73.         },
  74.         "pull": {
  75.             "enabled": true
  76.         },
  77.         "push": {
  78.             "enabled": true
  79.         }
  80.     }
  81. }

Step 3: Receive a Debit Pull payment

ENDPOINT

  1. POST /v1/receive/debitpull

RESPONSE

  1. {
  2.     "id": "tra-f6d57276-7f99-40a2-b67e-138323506c18",
  3.     "accountId": "acc-9eb9d71e-1656-4f68-8ed9-06b78ba34566",
  4.     "contactId": "con-cf2e03cc-7fd1-4262-a5de-29e12d207f7d",
  5.     "name": "Bright Light LLC",
  6.     "accountNumber": "",
  7.     "routingNumber": "",
  8.     "address": {
  9.         "addressType": "",
  10.         "line1": "",
  11.         "line2": "",
  12.         "city": "",
  13.         "state": "",
  14.         "country": "",
  15.         "postalCode": ""
  16.     },
  17.     "amount": "2.00",
  18.     "status": "completed",
  19.     "description": "Receive DebitPull",
  20.     "txnType": "credit",
  21.     "transferType": "debitCard",
  22.     "transferSubType": "originated",
  23.     "createdAt": "2022-03-01T01:58:02Z",
  24.     "modifiedAt": "2022-03-01T01:58:02Z",
  25.     "transferredAt": "2022-03-01T01:58:02Z",
  26.     "accountType": "",
  27.     "iban": "",
  28.     "valid": "",
  29.     "parentTransferId": "",
  30.     "reviewCode": "",
  31.     "reviewMessage": "",
  32.     "type": "",
  33.     "metadata": null,
  34.     "title": ""
  35. }