Txn.pro - API Documentation
Sandbox LoginChangelogStatus Page
  • Getting setup
    • Environments
    • Creating a Sandbox account
    • Back office user roles
    • Creating your API keys
    • Postman collection
  • API Basics
    • API specification
    • API status
    • Supported currencies
    • Date and time format
    • Authenticating the API
    • Webhooks
      • Verifying webhooks
      • Source IP addresses
      • Retrying schedule
    • Rate limits
  • Hosted pages
  • Accounts
    • Accounts concept
    • Listing accounts
    • Reading account
    • Listing account addresses
    • Creating account address
    • Listing account transactions
    • Reading account transaction
  • Exchange
    • Exchange concept
    • Supported currency pairs
    • Reading exchange rates
    • Exchange webhooks
    • Creating quote
    • Confirming quote
  • Invoices
    • Invoices concept
    • Invoice status flow
    • Invoices in cashier
    • Invoice limitations
    • Listing invoice currency pairs
    • Invoice webhooks
    • Creating invoice
    • Reading invoice
    • Listing invoices
    • Invoice refunds
  • Payouts
    • Payouts concept
    • Payout status flow
    • Payout limitations
    • Listing payout currency pairs
    • Validating addresses
    • Payout webhooks
    • Creating payout
    • Reading payout
    • Listing payouts
  • Mass Payouts
  • PAYMENT LINKS
    • Payment links concept
    • Creating payment link
    • Expiring payment link
    • Reading payment link
    • Listing payment links
  • CHANNELS
    • Channels concept
    • Channels deposit flow
    • Listing channel currency pairs
    • Channel webhooks
    • Creating channel
    • Reading channel
    • Updating channel
    • Listing channels
    • Listing channel deposits
    • Reading channel deposit
  • (BETA) Fiat Settlements
    • Important information
    • Bank withdrawal webhooks
    • Bank deposit webhooks
    • Listing bank accounts
    • Reading bank account
    • Previewing bank withdrawal
    • Creating bank withdrawal
    • Listing bank withdrawals
    • Reading bank withdrawal
    • Listing bank deposits
    • Reading bank deposit
Powered by GitBook
On this page
  1. (BETA) Fiat Settlements

Previewing bank withdrawal

PreviousReading bank accountNextCreating bank withdrawal

Last updated 3 months ago

POST /api/public/v1/transactions/bank_withdrawals/build

This endpoint allows you to preview a bank withdrawal details before submitting an actual request.

Headers

Name
Value

Content-Type

application/vnd.api+json

Authorization

Bearer <api_key>

Request Body

{
  "data": {
    "type": "bankWithdrawalTransactions",
    "attributes": {
      "absorb_fees": true,
      "account_id": "acd50522-de49-4aaa-a183-dc046ff27fd5",
      "bank_account_id": "a754cd82-74a0-4c1c-a832-e83445bce2c5",
      "amount": 1,
      "reference": "Fiat payout from Txn to Acme"
    }
  }
}

Name
Type
Required
Description

data.type

string

Yes

Can only be bankWithdrawalTransactions.

data.attributes.reference

string

Yes

The custom reference ID to tie the request to end-user or their account who gets paid. This can be anything you choose.

data.attributes.amount

number

Yes

Withdrawal amount.

data.attributes.account_id

string

Yes

Account ID on the Txn platform, e.g. your Euro account, which Txn will debit funds from.

data.attributes.bank_account_id

string

Yes

absorbFees

boolean

No

If false or omitted, the service fee is deducted from the transaction amount. If true, the service fee is deducted from your account balance.

Response Body

{
  "data": {
    "id": "",
    "type": "transactions",
    "attributes": {
      "createdAt": null,
      "simplifiedState": "pending",
      "transactionType": "BankWithdrawalTransaction",
      "amount": "-1.01",
      "reference": null
    },
    "relationships": {
      "account": {
        "meta": {
          "included": false
        }
      },
      "transactionDetails": {
        "data": {
          "type": "bank_withdrawal_transactions",
          "id": ""
        }
      }
    }
  },
  "included": [
    {
      "id": "",
      "type": "bank_withdrawal_transactions",
      "attributes": {
        "absorbFees": true,
        "createdAt": null,
        "updatedAt": null,
        "state": "unconfirmed",
        "iban": "LT563400023810000822",
        "beneficiaryName": "Acme",
        "reference": "Fiat payout from Txn to Acme",
        "paymentStatus": "created",
        "bankBic": "GXPTLT22XXX",
        "bankName": "BANK NAME",
        "currency": "EUR",
        "amount": "1.01",
        "payAmount": "1.00",
        "fee": "0.01"
      },
      "relationships": {
        "bankAccount": {
          "meta": {
            "included": false
          }
        },
        "account": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

Beneficiary (bank account) ID. Refer to .

Create Fiat Withdrawal
Listing Beneficiaries