Step 3: Creating a Transfer

This endpoint is used to facilitate internal transfers. They can be defined by a few scenarios:

The movement of funds between a BVNK user to their customer, their customer to the BVNK user, and from a BVNK user's customer to another customer of the BVNK user.


🚧

BETA Endpoints

Please note that these endpoints are currently in beta, and they may undergo changes as we continue to improve and refine the functionality.


Request:

EnvironmentEndpoint
ProductionPOST https://api.bvnk.com/payment/api/v1/transfers
SandboxPOST https://api.sandbox.bvnk.com/payment/api/v1/transfers
curl --request POST \
     --url 'https://api.sandbox.bvnk.com/payment/api/v1/transfers' \
     --header 'X-Idempotency-Key: f21b904d-8edb-46b0-b049-e611b1994e1d' \
     --header 'Authorization: Hawk id="B9jnE1U8eLblzHtNeJZRxfcq03CQKcmcP9FOrACMzXb1HfrxrePWsTfuP70JNns9", ts="1633010032", nonce="guGXrD", mac="uKeg+w1qXqzaF/8mOQGv8Y9IlRxyxTT+iINLe03EQ60="' \
     --header 'Content-Type: application/json' \
     --data '{
  "walletId": "{{walletId}}",
  "amount": {
    "value": 1000.00,
    "currency": "USD"
  },
  "paymentReference": "{{randomAlphaNumeric}}",
  "instruction": { 
    "type": "WALLET",
    "beneficiaryWalletId": "{{walletId}}"
  } 
}'

Successful response:

{
  "transactionReference": "{transaction_id}",
  "fee": {
    "value": 0.00,
    "currency": "USD"
  }
}

Response Header: LOCATION: https://api.sanbox.bvnk.com/payment/api/v1/transfers/{transaction_id}