Create a funding account
An account the balance is funded through. It is created pending; its payment instructions are available once it is active (event funding_account.active). With amount it is one payment of exactly that amount (collection payment in GET /v1/capabilities): the payer pays the amount and nothing more, and the account closes once it is paid; the pay-in that credits it is payin.completed.
apiKeyAuthorizationBearer <clave>Your secret API key, sent as Authorization: Bearer <key>. A key names its environment: psp_test_… works only against sandbox (https://api-sandbox.caibopay.app), psp_live_… only against live (https://api.caibopay.app). Keys are issued by Caibo when your account is opened; the dashboard (Developers) shows the key in use.
Idempotency-Key*stringA unique key for this request, 8 to 128 characters.
^[A-Za-z0-9._:-]{8,128}$application/json- body
amount?stringOne payment of exactly this amount, in currency: what the payer pays, and nothing more; the provider's commission is the platform's. For a method whose collection is payment. Omit it for an account that receives any deposit. A decimal string in the currency's precision.
^[0-9]+(\.[0-9]+)?$currency*stringThe currency the payer sends.
method*stringHow the account is paid into, e.g. bank_transfer.
payer?With amount: the method's payment_method_fields (GET /v1/capabilities), by name, e.g. payer.name for pix.
settlement_currency?stringThe currency the balance is credited in. Defaults to the first available for the method.
The request was already made: the existing resource is returned.
application/json- response
amount?stringOne payment: what the payer pays, exactly, in currency. instructions.amount says the same once active. A decimal string in the currency's precision.
^[0-9]+(\.[0-9]+)?$created_at*stringWhen it was created.
date-timecurrency*stringThe currency the payer sends.
failure_code?stringWhy it could not be opened.
id*stringThe id of the funding account.
^fa_[0-9a-z]+$instructions?How to pay into the account. Present once active.
method*stringThe method.
settlement_currency*stringThe currency the balance is credited in.
status*stringpending until the account is open. active: it can be paid into. failed: it could not be opened (failure_code). closed: it takes no more deposits.
"pending""active""failed""closed"curl -X POST 'https://api-sandbox.caibopay.app/v1/funding-accounts' \ -H 'Idempotency-Key: string' \ -H 'Content-Type: application/json' \ -d '{ "currency": "string", "method": "string"}'{ "amount": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "failure_code": "string", "id": "string", "instructions": { "property1": "string", "property2": "string" }, "method": "string", "settlement_currency": "string", "status": "pending"}