Wallet

List the holder's accounts (wallet, pockets, savings) #

GET/v1/gateway/wallet/accounts/

• operationId listWalletAccounts
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.accounts.list()

client.accounts.list()

$client->accounts->list()

await client.Accounts.ListAsync()

client.Wallet.Accounts.List(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/accounts/?document=1090123456" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Create a sub-account (pocket / savings / goal) #

POST/v1/gateway/wallet/accounts/

• operationId createWalletAccount
• Authentication X-API-Key · scope wallet:accounts
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema WalletAccountCreateIn — Create a sub-account (pocket / savings / goal) for the wallet holder.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.accounts.create_pocket()

client.accounts.createPocket()

$client->accounts->createPocket()

await client.Wallet.Accounts.CreatePocketAsync()

client.Accounts.CreatePocket(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/accounts/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "kind": "pocket",
    "name": "Ahorro vacaciones"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Transfer between the holder's own accounts #

POST/v1/gateway/wallet/accounts/transfer/

• operationId transferBetweenWalletAccounts
• Authentication X-API-Key · scope wallet:accounts
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema WalletTransferIn — Transfer funds between two of the holder’s own accounts.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.accounts.transfer()

client.accounts.transfer()

$client->accounts->transfer()

await client.Accounts.TransferAsync()

client.Accounts.Transfer(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/accounts/transfer/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "from_account": "acc_main",
    "to_account": "acc_pocket_1",
    "amount": "150000"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Holder's wallet balance #

GET/v1/gateway/wallet/balance/

• operationId getWalletBalance
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.wallet.balance()

client.wallet.balance()

$client->wallet->balance()

await client.Wallet.BalanceAsync()

client.Wallet.Balance(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/balance/?document=1090123456" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Biller catalog #

GET/v1/gateway/wallet/billers/

• operationId listBillers
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.wallet.bills.billers()

client.wallet.bills.billers()

$client->wallet->bills->billers()

await client.Wallet.Bills.BillersAsync()

client.Wallet.Bills.Billers(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/billers/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Look up a bill #

POST/v1/gateway/wallet/bills/inquiry/

• operationId inquireBill
• Authentication X-API-Key · scope wallet:payments
• Idempotency-Key not applicable

Request body

Content type: application/json · required

Schema WalletBillInquiryIn

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.wallet.bills.inquire()

client.wallet.bills.inquire()

$client->wallet->bills->inquire()

await client.Wallet.Bills.InquireAsync()

client.Wallet.Bills.Inquire(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/bills/inquiry/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "biller_code": "EPM",
    "reference": "123456789"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Pay a bill #

POST/v1/gateway/wallet/bills/pay/

• operationId payBill
• Authentication X-API-Key · scope wallet:payments
• Idempotency-Key required

Parameters

Request body

Content type: application/json · required

Schema WalletBillPayIn

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.wallet.bills.pay()

client.wallet.bills.pay()

$client->wallet->bills->pay()

await client.Wallet.Bills.PayAsync()

client.Wallet.Bills.Pay(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/bills/pay/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "biller_code": "EPM",
    "reference": "123456789",
    "amount": "3500000"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Bill payment and top-up history #

GET/v1/gateway/wallet/bills/payments/

• operationId listBillPayments
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.wallet.bills.list_payments()

client.wallet.bills.listPayments()

$client->wallet->bills->listPayments()

await client.Wallet.Bills.ListPaymentsAsync()

client.Wallet.Bills.ListPayments(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/bills/payments/?document=1090123456" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Payment detail #

GET/v1/gateway/wallet/bills/payments/{payment_id}/

• operationId getBillPayment
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.wallet.bills.get_payment()

client.wallet.bills.getPayment()

$client->wallet->bills->getPayment()

await client.Wallet.Bills.GetPaymentAsync()

client.Wallet.Bills.GetPayment(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/bills/payments/8c2d0000-0000-4a1b-9c2d-000000000001/?document=1090123456" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Holder's Bre-B limits #

GET/v1/gateway/wallet/breb/limits/

• operationId getBreBLimits
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.wallet.breb.limits()

client.wallet.breb.limits()

$client->wallet->breb->limits()

await client.Wallet.BreB.LimitsAsync()

client.Wallet.BreB.Limits(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/breb/limits/?document=1090123456" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Resolve a Bre-B key #

POST/v1/gateway/wallet/breb/resolve/

• operationId resolveBreBKey
• Authentication X-API-Key · scope wallet:transfer
• Idempotency-Key not applicable

Request body

Content type: application/json · required

Schema WalletBreBResolveIn

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.wallet.breb.resolve()

client.wallet.breb.resolve()

$client->wallet->breb->resolve()

await client.Wallet.BreB.ResolveAsync()

client.Wallet.BreB.Resolve(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/breb/resolve/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "key_type": "PHONE",
    "value": "3109876543"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Send via Bre-B #

POST/v1/gateway/wallet/breb/transfers/

• operationId createBreBTransfer
• Authentication X-API-Key · scope wallet:transfer
• Idempotency-Key required

Parameters

Request body

Content type: application/json · required

Schema WalletTransferIn2 — P2P or Bre-B send: only with the resolution_token from resolve (never a bare id).

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.wallet.breb.transfer()

client.wallet.breb.transfer()

$client->wallet->breb->transfer()

await client.Wallet.BreB.TransferAsync()

client.Wallet.BreB.Transfer(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/breb/transfers/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "resolution_token": "<resolution_token>",
    "amount": "3500000"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

List issued cards (non-sensitive metadata) #

GET/v1/gateway/wallet/cards/

• operationId listWalletCards
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.cards.list()

client.cards.list()

$client->cards->list()

await client.Cards.ListAsync()

client.Cards.List(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/cards/?document=1090123456" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Issue a card (debit; virtual or physical) #

POST/v1/gateway/wallet/cards/

• operationId issueWalletCard
• Authentication X-API-Key · scope wallet:cards
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema WalletCardIssueIn — Issue a card (debit; virtual or physical) for the wallet holder.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.cards.issue()

client.cards.issue()

$client->cards->issue()

await client.Wallet.Cards.IssueAsync()

client.Cards.Issue(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/cards/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "form_factor": "virtual"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Change card status (freeze / unfreeze / block) #

POST/v1/gateway/wallet/cards/{card_id}/status/

• operationId setWalletCardStatus
• Authentication X-API-Key · scope wallet:cards
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema WalletCardStatusIn — Change a card’s state (freeze / unfreeze / block).

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.cards.set_status()

client.cards.setStatus()

$client->cards->setStatus()

await client.Cards.SetStatusAsync()

client.Cards.SetStatus(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/cards/card-9/status/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "status": "freeze"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Movements on a card #

GET/v1/gateway/wallet/cards/{card_id}/transactions/

• operationId listWalletCardTransactions
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.cards.transactions()

client.cards.transactions()

$client->cards->transactions()

await client.Cards.TransactionsAsync()

client.Cards.Transactions(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/cards/card-9/transactions/?document=1090123456" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Execute a currency conversion #

POST/v1/gateway/wallet/fx/convert/

• operationId executeFxConversion
• Authentication X-API-Key · scope wallet:fx
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema FxConvertIn — Execute a currency conversion (moves money — idempotency-key recommended).

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.fx.convert()

client.fx.convert()

$client->fx->convert()

await client.Fx.ConvertAsync()

client.Wallet.FX.Convert(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/fx/convert/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "quote_id": "fxq_abc123",
    "sell_currency": "COP",
    "buy_currency": "USD",
    "amount": "1000000"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Quote a currency conversion #

POST/v1/gateway/wallet/fx/quote/

• operationId quoteFxConversion
• Authentication X-API-Key · scope wallet:fx
• Idempotency-Key not applicable

Request body

Content type: application/json · required

Schema FxQuoteIn — Request an indicative FX quote (moves no money, not billable).

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.fx.quote()

client.fx.quote()

$client->fx->quote()

await client.Wallet.Fx.QuoteAsync()

client.FX.Quote(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/fx/quote/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "sell_currency": "COP",
    "buy_currency": "USD",
    "amount": "1000000"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Resolve a P2P recipient #

POST/v1/gateway/wallet/p2p/resolve/

• operationId resolveP2PRecipient
• Authentication X-API-Key · scope wallet:transfer
• Idempotency-Key not applicable

Request body

Content type: application/json · required

Schema WalletResolveP2PIn

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.wallet.p2p.resolve()

client.wallet.p2p.resolve()

$client->wallet->p2p->resolve()

await client.Wallet.P2P.ResolveAsync()

client.Wallet.P2P.Resolve(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/p2p/resolve/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "alias": "3001234567"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Transfer to another affiliate #

POST/v1/gateway/wallet/p2p/transfers/

• operationId createP2PTransfer
• Authentication X-API-Key · scope wallet:transfer
• Idempotency-Key required

Parameters

Request body

Content type: application/json · required

Schema WalletTransferIn2 — P2P or Bre-B send: only with the resolution_token from resolve (never a bare id).

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.wallet.p2p.transfer()

client.wallet.p2p.transfer()

$client->wallet->p2p->transfer()

await client.Wallet.P2P.TransferAsync()

client.Wallet.P2P.Transfer(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/p2p/transfers/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "resolution_token": "<resolution_token>",
    "amount": "3500000"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Top up a mobile phone #

POST/v1/gateway/wallet/topups/

• operationId createTopup
• Authentication X-API-Key · scope wallet:topup
• Idempotency-Key required

Parameters

Request body

Content type: application/json · required

Schema WalletTopupIn

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.wallet.topups.create()

client.wallet.topups.create()

$client->wallet->topups->create()

await client.Wallet.Topups.CreateAsync()

client.Wallet.Topups.Create(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/topups/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "phone_number": "3001234567",
    "carrier": "CLARO",
    "amount": "3500000"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Top-up carriers #

GET/v1/gateway/wallet/topups/operators/

• operationId listTopupOperators
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Responses

Example

client.wallet.topups.operators()

client.wallet.topups.operators()

$client->wallet->topups->operators()

await client.Wallet.Topups.OperatorsAsync()

client.Wallet.Topups.Operators(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/topups/operators/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Holder's transactions (paginated, with filters) #

GET/v1/gateway/wallet/transactions/

• operationId listWalletTransactions
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.wallet.transactions.list()

client.wallet.transactions.list()

$client->wallet->transactions->list()

await client.Wallet.Transactions.ListAsync()

client.Wallet.Transactions.List(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/transactions/?document=1090123456" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Transaction detail #

GET/v1/gateway/wallet/transactions/{tx_id}/

• operationId getWalletTransaction
• Authentication X-API-Key · scope wallet:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.wallet.transactions.get()

client.wallet.transactions.get()

$client->wallet->transactions->get()

await client.Wallet.Transactions.GetAsync()

client.Wallet.Transactions.Get(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/wallet/transactions/6b1f8c1e-0000-4a1b-9c2d-000000000001/?document=1090123456" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.