Previewing bank withdrawal

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

This endpoint allows you to preview a bank withdrawal details before submitting an actual Create Fiat Withdrawal 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	Beneficiary (bank account) ID. Refer to Listing Beneficiaries.
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

HTTP 200

{
  "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": "GUPULT22XXX",
        "bankName": "GURU PAY",
        "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"
  }
}