Get a Payment Reference

Learn how to generate and manage payment references using Bando's Fulfiller API. Step-by-step guide for implementing secure crypto payment processing.

Payment Reference Guide

Learn how to handle payment references for transactions. This guide explains how to create and manage payment references securely.

Creating Payment References

What is a Payment Reference?

A payment reference is any identifier needed to complete a transaction, such as:

• Phone numbers for mobile top-ups and eSIMs

• Email addresses for prepaid codes

Each product type has specific reference requirements and validation rules.

Creating a Reference

Endpoint

POST /references

Request Format by Product Type

1. Mobile Top-ups and eSIMs

{
  "reference": "[phone]",
  "transaction_intent": {
    "sku": "ATT_MX_10-I",
    "quantity": 1,
    "amount": 10.0,
    "chain": "pol",
    "token": "USDC",
    "wallet": "0x123.."
  }
}

Reference requirements:

• Must match phone regex: ^(\\+?\\d{1,3}[-.\\s]?)?(\\(?\\d{3}\\)?[-.\\s]?)?\\d{3}[-.\\s]?\\d{4}$

• Include country code

• No special characters

• Some products require extra fields, check the required_fields of the product endpoint

2. Prepaid Codes

{
  "reference": "[email protected]",
  "required_fields": [
    {
      "name": "recipient.firstName",
      "value": "John"
    },
    {
      "name": "recipient.lastName",
      "value": "Doe"
    }
  ],
  "transaction_intent": {
    "sku": "09574598-545b-4fc2-a65a-e00ebe543551",
    "amount": 50.0,
    "chain": "137",
    "token": "USDC"
  }
}

Reference requirements:

• Must match email regex: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$

• Required fields vary by brand

• Some brands require sender information

Response Format

{
  "id": "uuid",
  "validation_id": "string",
  "reference_type": "email",
  "status": "PENDING",
  "reference": "[email protected]",
  "created_at": "2024-02-17T12:00:00Z",
  "updated_at": "2024-02-17T12:00:00Z",
  "transaction_intent": {
    "id": "uuid",
    "sku": "0000000-545b-4fc2-a65a-000000000",
    "amount": 50.0,
    "status": "PENDING"
  }
}

Best Practices

1. Reference Format

   • Validate format client-side before submission

   • Follow the specific format required by each service

   • Include country codes for phone numbers

2. Security

   • Never store references in plain text

3. Transaction Intent

   • Always include complete transaction details

   • Specify the correct blockchain and token

   • Check amounts and SKUs

4. Reference Privacy

   • References are stored securely off-chain

   • Only reference IDs are stored on-chain

   • Use validation IDs for status checks