System Resource Names

API Input Body Headers and Error Types

System Resource Name (SRN)

System Resource Name is a typed identifier that may reference any object within the alfred ecosystem. Many of our API calls and data schemas leverage SRNs in order to add flexibility and decouple services. All SRNs follow the same URI-like format:

type:identifier

Some common types you are likely to encounter from our API below:

TypeDescription

api-key:

Your API Key for authentication

e.g.:alfredpay.4dqd$jKwSpjnPT!J3U!QsL&7TfAQKPJa

api-secret:

Your API Secret for enhanced security

e.g.:M992ASr4KnQkvI2)LN3qExWnzNuE2F3*

authorization:

Access token obtained from KYC Lite

e.g.:ekutUTDKUJYyukfKUTDkutDKUTdYTD754675345.ityd

type:

Type of transaction

e.g. in / out

balance:

Balance of user's wallet, if type is β€œin” (onramp) then balance is 0, when the type is β€œout” (offramp) you must set the balance crypto currency

e.g. 0

currency:

crypto currency withdraw or Deposit (BTC, USDT, USDC)

e.g. USDC

user:

An alfred user, user's wallet, username, email or phone number

e.g. fulano

chain:

Blockchain can be stellar, ethereum, bitcoin LN, or Network Banking number

e.g. stellar

initial transaction:

Unique Transaction number issues

e.g. c8482ef1-0729-4ed8-83ed-0a57e746ecfe

phonenumber:

A cellphone number

e.g. cellphone:+15555555555

email:

An email address

e.g. email:dev@alfredpayt.io

firstname:

User's first name

e.g.John

lastname:

User's Last name

e.g.Doe

fullname:

User's full name

e.g.John Doe

address:

Address of user

e.g. Calle Buenos Aires

city:

City of residence

e.g. Buenos Aires

country:

Country of residence

e.g. ARG

countrywithdraw:

Country where withdrawal will take place //ISO Format, it also can be to use to deposit.

e.g. ARG

zip:

Zip code of User or Bank

e.g. 1020

birthday:

User's date of birth

e.g. 1987-04-12

id:

ID number of an individual user

e.g. a35468sgrgr84

bankName:

Name of the bank

e.g. Banco Industrial de Argentina

bankNumber:

Number given to specify an individual bank

e.g. 345854122904778

bankAccountOwner:

The owner is obtained by token user, if the value is different, it will take the full name token

e.g. JohnFulanoDoe

countryCode:

Specific code to specify the country

e.g. ARG

amount:

Amount being withdrawn

e.g. 0.5

withdrawalPhone:

A cellphone number

e.g. "+584241256099"

businessInitTx:

Can be found in uid - myinfo

e.g."24d00b1f-3d3d-4139-ad2c-479f3fc00573"

BusinesssTo:

Business ID number

e.g. "10"

exchangeId:

Identification for an exchange

e.g."1b59639d-093b-4b3a-b82c-bb0ea57719ca"

typeProcesor:

Type of Institution processing transaction

e.g."Bank"

status:

Based on the desired action either status can appear

e.g. "approved" "rejected" "cancel"

invoicehash:

Specific Invoice Hash

e.g."Secret_Value_Here"

formdata:

value docType can be either:

e.g.Selfie idCardFront idCardBack

Last updated