CreateCollectionDto

What to collect, read according to amount_type. With the default source this is what the customer hands over — local currency for fiat, units of the asset for crypto. With destination it is the USD you want credited.

Your own reference, and the handle you will find this by. Required: we never invent one, because a reference we made up is not one you can reconcile against.

This is not an idempotency key — send Idempotency-Key to make a retry safe. This says which of your records the money belongs to.

Crypto collections. Allow settling to your permanent settlement address when the asset already IS the settlement asset, instead of a temporary quote-bound address.

A permanent address is shared by every payment into your account, so a payment made to one cannot be matched to this collection — no status to track, no webhook. Off by default; turn it on only when you reconcile the payment yourself.

source (default) = amount is what the customer pays. destination = amount is the USD you want credited, and we work backwards through the same rate the collection will use to decide what to charge them.

An invoice is written in the amount you want to be paid, so pricing a quote with destination and then creating the collection meant converting the figure yourself — against a rate that had moved by the time you sent it. Matches POST /v1/payouts.

The asset the customer sends, from GET /v1/collections/assets (crypto).

Corridor country. Required for bank and momo; ignored for crypto, where the asset decides the route.

The customer this collection is for.

The paying customer’s name, if you have it. Never required — a bank collection takes the name from the account the money actually arrives from, which is the only one worth trusting.

How the customer pays. bank/momo collect local currency; crypto accepts a digital asset. Defaults to the corridor’s fiat default.

Mobile-money network (momo).

The customer’s mobile-money phone number (momo).

Where to return the customer’s funds if the collection cannot complete. It should be an address they control, which is not necessarily the one they send from. Funds are returned here if the collection can’t be completed (crypto).