Create a transfer

post

https://api.brinta.com/transfers/

Create a transfer

Body Params

account_holder_company_id

string

Company id of the account holder in Brinta's system. Create a new company in the company section. If not sent, the account holder will be Brinta's client.

account_holder_company_external_id

string

Company id of the account holder in the Client's system.

transaction_external_id

string

Id of the transfer in the Client's system.

status

string

required

Status of the transaction. It can be "pending", "created", "rejected".

type

string

required

The type of the transfer. It can be "transfer", "transfer reversal", "to settle", "settlement", "payment from invoice"

transaction_date

date

Date of the transaction.

amount

float

It appears in RESPONSE. The amount of the transaction excluding taxes.

final_amount

float

It appears in RESPONSE. The amount of the transfer including taxes.

currency

string

required

The currency code of the transfer amount. It can be the local currency or international_currency set for the account holder. Check Country Coverage and currencies

exchange_rate

float

The exchange rate from the currency to the international currency set for the account holder.

payment_method

object

The payment method used for the linked transaction.

additional_info

string

Additional information regarding the transfer.

counterpart

object

required

Information of the counterpart. Only one of company_id, company_external_id, company can be sent.

items

array of objects

required

Array of items of the transfer.

items*

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200