Payment Reference API

How to fetch, and validate a payment reference for one of our products.

Overview

Business Logic for Reference Validation

Reference Processing Steps

1. Product Validation: The sku is used to find the associated product.

2. Regex Validation: The reference is validated against the regex pattern defined for the product.

3. Reference Lookup: Checks if the reference has already been validated.

4. Create or Return Reference: If not previously validated, creates a new validated reference.

Error Handling

• Product Not Found: Raised if the sku does not correspond to any existing product.

• Invalid Reference: Raised if the reference does not pass the regex validation.

Objectives

API Specification

Create a new validated reference

POSThttps://api.bando.cool/v1/references

Body

application/json

referencestring

User-provided reference (e.g., phone number, email)

reference_required_fieldsobject

Required fields for validating the reference

sku*string

SKU related to the reference

Response

201400

Reference created successfully

Body

application/json

referencestring

User-provided reference

reference_required_fieldsobject

Fields required to validate the reference

statusstring

Current status of the reference

reference_typestring

Type of reference (e.g., phone number, email)

Request

JavaScriptCurlPython

const response = await fetch('https://api.bando.cool/v1/references', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sku": "text"
    }),
});
const data = await response.json();

Response

201

{
  "reference": "text",
  "status": "text",
  "reference_type": "text"
}

Retrieve validated references

GEThttps://api.bando.cool/v1/references

Query parameters

Response

200400

Get validated reference

Body

application/json

referencestring

User-provided reference

reference_required_fieldsobject

Fields required to validate the reference

statusstring

Current status of the reference

reference_typestring

Type of reference (e.g., phone number, email)

Request

JavaScriptCurlPython

const response = await fetch('https://api.bando.cool/v1/references', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "reference": "text",
    "status": "text",
    "reference_type": "text"
  }
]