On this page

Introduction

This document describes the use of the application programming interface of the alfred ecosystem, specifically the Third Party Payments product, so that it can be a reference for developers and technology teams and integrate payment processors and wallets to the alfred ecosystem.

At alfred we understand the importance of smooth and efficient payment transactions. That's why we've built a powerful and flexible API that allows you to integrate payment processors and wallets seamlessly. Whether you're a fintech company looking to expand your horizons or a merchant aiming to provide your customers with a seamless payment experience, the alfred API is here to help you tap into the full potential of our ecosystem. With our API, you can unlock new opportunities for growth and innovation while ensuring the security and convenience of payment transactions.

This documentation is your friendly guide to navigating the exciting world of the Third Party Payments product within the alfred ecosystem. We'll take you step-by-step through the process of initiating payments, retrieving transaction details, handling refunds, and managing customer information, among other essential functionalities. You'll find easy-to-follow instructions, helpful code examples, and best practices that will make integrating payment processors and wallets a breeze. Rest assured that our goal is to empower you to provide a smooth and secure payment experience for both merchants and end-users.

We're here to support you every step of the way on your payment integration journey within the alfred ecosystem. As you dive into this documentation, we'll provide you with a friendly overview of the underlying architecture and technical details of our API. Additionally, you'll find comprehensive API reference documentation that includes detailed descriptions of each endpoint, along with request/response examples and parameter details. By the time you reach the end of this guide, you'll feel confident and equipped with the necessary tools to embark on your payment integration adventure within the alfred ecosystem. Let's get started!

Next
API Keys

Overview

Transaction status

Consult Transactions status

Properties

Field
Type
fileType
string
status
string
user
string
alfred-user
string
initDate
date,time
endDate
date,time
id
string
transactionType
string
paymentMethod
string
name
string
email
string
phone
string
description
string

Request

Request

  1. --request POST
  2. --url ​/third-party-service/download/file?fileType=json&status=completed&initDate
    =2022-07-2&endDate=2022-12-02

Response

{

"id": 67,
"status": "completed",
"transactionType": "BCRD",
"bank": "BHD",
"name": "Roger Pay",
"email": ”roger@alfredpay.io",
"phone": "+134576584935",
“description”: “Withdraw from wallet alfred”,
}

Considerations

An integration can be made from CMS to download a file with the transactions

Generate an invoice

When the webview is finished, the invoice is generated with your data

Header

Field
Type
api-key
string
api-secret
string

Properties

Field
Type
idorigin
string
invoice
string
status_webview
string
start_time
date,time
end_time
date,time
amount
decimal
currency
string
expire_invoice
date
date_payout
date,time
user
string
status_invoice
string
walletpay
string

Request

Request

  1. --request GET
  2. --url https://api-dev-services.alfredpay.app/api/v1/third-party-service/invoice

Response

"idorigin": "xxx",
"invoice":"xxx- xxxxx - xxxx - xxx",
"status_webview": "xxxx",
"start_time": "20220803153045",
"end_time": "20220803153045",
"amount": 500,
"currency": "USDC",
"expire_invoice": true,
"date_payout": "20220803153045",
"user": "rogerpay",
"status_invoice": "pending",
"walletpay": "GCTFBF7F2JBXZQJKAE2L SO46JJBKQZ4RS323UR77E7MSV EYDBU3MHPTC",
"memo": "DBQwTEYV6IGt",
"chain": "stellar",
"method": {{
  "transaction": "xxxx- xxxxx - xxxxx",
  "date": "20220803153045",
  "user": "+58482674927",
  "kyc": "verify",
  "country_whtdraw": "ARG",
  "cashout": "BANK",
  "cash_amount": 5,
  "currency_pay": "ARS",
  "rate": 25,
  "status": "pending",
  "time_estimate_payout": 68000,
  "time_payout": 57000,
  "commission": 3
}
{
  "idorigin": "xxx",
  "invoice": "bbb-bbbbb-bbbb-bbbb",
  "status_webview": "completed",
  "start_time": "20220803153045",
  "end_time": "20220803153045",
  "amount": 500,
  "currency": "USDT",
  "user": "alo",
  "estatus_invoice": "pending",
  "walletpay": "GCTFBF7F2JBXZQJKAE2LSO46JJBK QZ4RS323UR77E7MSVEYDB U3MHPTC",
  "memo": "DBQwTEYV6IGt",
  "chain": "bitcoin",
  "method":{
    "transaction": "xxxx-xxxxx-xxxxx",
    "date": "20220803153045",
    "user": "+58482674927",
    "kyc": "verify",
    "country_whtdraw": "VEN",
    "cashout": "ATM",
    "cash_amount": 350,
    "currency_pay": "VES",
    "rate": 25,
    "status": "pending",
    "time_estimate_payout": 68000,
    "time_payout": 57000,
    "commission": 3
  }
}
}

Considerations

The invoice and payment statuses are updated from the back office according to the commercial agreements with your company and the payment processors.

Once the bill is approve the withdraw will be generated
Next
Authorization
Back
Introduction

Authorization

The API is a REST API that defines a set of functions so that developers can make requests and receive responses via the HTTP protocol (GET and POST).

In this way, they can be used by practically any programming language.It is important to consider the following elements when calling APIs

Sandbox

https://api-dev-services.alfredpay.app/api/v1/third-party-service
Copy
Back
Overview