HomeGuidesRecipesAPI ReferenceChangelog
Treasury Portal Login
Guides

Making a Collection

A comprehensive guide for building an effortless user experience to enable you to receive local fiat from your customers.


Collection Steps & API Overview

A user journey guide for collecting fiat from your customers, including the API reference at each step.


User journey step

What to show on the UX

What to ask the user for

API reference

What's returned from the API

  1. Payment screen

A place for the user to view the amount to pay

n/a

  • Get Channels to retrieve all supported payment methods
  • Get Rates to retrieve rates for the supported countries
  • Limits for a given payment channel
  • Rate of local fiat/ USD
  1. Chooses a preferred payment channel

List of payment channels available to them eg: Bank Transfer, Mobile Money, P2P transfer

Their preference of payment method

Get Channels

A list of available payment options for the given country

  1. a. IF they chose Mobile Money: Provide Mobile Money Details screen

Input fields for customer to enter beneficiary details:

  • First name
  • Last name
  • mobile number (country code + string)
  • Select provider (mobile network)

Please add mobile money details:

Mobile provider = Get Networks

A list of available networks

  1. Enter reason for sending

Ask the user the reason for their transaction

To choose from a list of reasons

Reason for sending = Payment Reasons

Pre-defined list of reasons to select.

  1. Review payment details

Transaction details including:

  • Payment Option
  • Payment channel
  • Payment Network
  • Account number/ Mobile number
  • Total amount
  • Rate (if req)

To confirm the payment.

Submit Collection Request

A quote to make the collection

  1. Initiate payment

Confirmation the transaction is being processed

n/a

Accept Collection request

Deny Collection Request

Confirmation or rejection of the transaction

  1. Payment successful

Confirmation that payment was successful.

n/a

n/a
Webhooks to determine status of transaction

n/a

  1. Retrieve information about a specific payment

View of transaction details

View transaction details

Lookup Collection

Information about a specific payment

To get started, open the recipe below:



What’s Next