Skip to content
FFastPay Docs

Crypto

Create a crypto payment

POST/api/v1/crypto/payments

Prices a US dollar or naira amount in a coin and returns the address and exact amount the payer sends. A naira price is converted at the platform's naira rate for the coin, rounded up to the coin's precision and fixed on the payment; the merchant is credited the coin, never naira. fee_bearer customer adds the platform fee to what the payer is asked for; merchant takes it from what the merchant is credited. Needs the business's crypto access.

AuthorizationBearer sk_test_… or sk_live_…

Headers#

  • X-Fastpay-ModestringOptional

    One of test, live.

  • Idempotency-KeystringRequired

    Client-generated key that makes the request safe to retry. Replaying the key with an identical payload returns the original response; replaying it with a different payload is rejected. Up to 255 characters.

Body parameters#

  • amount_minorintegerRequired

    The price in the minor unit of currency: US cents, or kobo. Either way the coin amount is capped at the equivalent of US$2,000. At least 1.

  • assetstringRequired
  • emailstringRequired

    Up to 254 characters.

  • currencystringOptional

    NGN prices the payment at the platform's naira rate for the coin, fixed on the payment when the address is issued. The merchant is credited the coin either way. One of USD, NGN. Defaults to USD.

  • descriptionstringOptional

    Up to 200 characters.

  • fee_bearerstringOptional

    One of merchant, customer.

  • metadataobjectOptional

    Your own key-value pairs; every value is text.

  • referencestringOptional
  • test_casestringOptional

    Test book only. One of success, common, failed, partially_paid.

Responses#

  • 201Created
  • 400The request could not be read.
  • 401The secret key is missing, invalid or revoked.
  • 403The key is not allowed to do this, or the request came from an address that is not on its allowlist.
  • 404Nothing was found for this business and mode.
  • 409The request clashes with the current state, such as a reference reused with different details.