Skip to main content

Step 5: Distributing Funds

numo needs your card transactions in order to match them with offers a customer is eligible for and submit the reward amount to the merchants for approval and funding. Historical transactions have already gone through the rewards lifecycle and settlement process or are no longer eligible for offer rewards. Historical transactions help the targeting engine provide relevant offers to cardholders.

Prefer SFTP / batch for transaction data

The recommended way to exchange transaction data with numo is a managed SFTP / batch feed — numo will work with you to set this up, including dedicated streams for a match on "auth". Posting transactions individually over the API, shown below, is supported mainly for legacy direct integrations.

Prerequisites​

Prior to executing this process, ensure that:

  • You possess an active authentication token.
  • We also recommend that you have a batch file of historical transactions.

Create transactions​

Use this endpoint to create transactions to numo using a batch file: POST partner/transactions

{
  "amount": 12,
  "card_account_external_id": "id-for-entity",
  "card_bin": "444789",
  "card_last_4": "0001",
  "card_program_external_id": "id-for-entity",
  "currency_code": "USD",
  "debit": true,
  "description": "Pittsburgh Zoo",
  "external_id": "string",
  "merchant_category_code": "7998",
  "merchant_address": {
    "city": "PITTSBURGH",
    "complete": "7370 BAKER ST, STE 100\nPITTSBURGH, PA 15206",
    "country_code": "US",
    "country_subdivision_code": "PA",
    "latitude": "40.440624",
    "longitude": "-79.995888",
    "postal_code": "15206",
    "street_address": "7370 BAKER ST, STE 100\n"
  },
  "processor_mid": "9000012345",
  "processor_mid_type": "VISA_VMID",
  "processor_trid": "40012345678",
  "publisher_external_id": "id-for-entity",
  "timestamp": "2021-12-01T01:59:59.000Z",
  "transaction_type": "PURCHASE"
}

Mark Rewards as Distributed​

Use this endpoint to update the rewards status: PATCH partner/rewards/{id}

{
  "status": "DISTRIBUTED_TO_CARDHOLDER",
  "notification": true
}