Confirm Transfer

POST https://api.sfox.com/v1/enterprise/transfer/confirm

This endpoint allows Partners to confirm a Payment transfer. Your end users will receive an email with payment details and an OTP code. The Partner application will have to handle accepting the OTP code from the end user. Once confirmed, the transfer will be automatically processed.

Body Parameters

Name	Type	Description
transfer_id required	string	Partner generated transfer and idempotency ID
otp required	string	Transfer confirmation code

Responses

201 Created

{
    "data": {
        "transfer_id": "7735757c-863e-4e07-9b84-af186424ebae",
        "transfer_status_code": "COMPLETE",
        "type": "PAYMENT",
        "quantity": 0.1,
        "currency": "eth",
        "user_id": "ClientAccount1",
        "rate": 2000,
        "purpose": "GOOD",
        "description": "Gift card payment",
        "atx_id_charged": 1728524,
        "atx_id_credited": 1728525,
        "atx_status_charged": 1127,
        "atx_status_credited": 1127
    }
}

422 Unprocessable Content

{
    "error": "Code expired. Request a new code for this transfer."
}

{
    "error": "Funds transfer is not pending verification."
}

Response Body

Key	Description
transfer_id	Partner generated transfer and idempotency ID
transfer_status_code	Status of the transfer
type	Transfer type
quantity	Transfer quantity
currency	Transfer currency
user_id	The Connect user ID this transfer will apply to
rate	USD FX Rate of the transfer
purpose	Transfer purpose
description	Partner declared description text
atx_id_charged	ID of the charge account transaction
atx_id_credited	ID of the credit account transaction
atx_status_charged	Status of the charge account transaction
atx_status_credited	Status of the credit account transaction
transfer_date	Transfer Date

Example Requests

Shell

curl -X POST \
  -H 'Content-type: application/json' \
  -H "Authorization: Bearer ${ENTERPRISE_API_KEY}" \
  --data '{ "transfer_id": "7735757c-863e-4e07-9b84-af186424ebae",
          "otp": "123456" }'  \
  'https://api.sfox.com/v1/enterprise/transfer/confirm'

NodeJS

const axios = require('axios');

const config = {
  method: 'post',
  url: 'https://api.sfox.com/v1/enterprise/transfer/confirm',
  headers: {
    "Content-Type": "application/json",
    'Authorization': `Bearer ${process.env.ENTERPRISE_API_KEY}`
  },
  data: {
    transfer_id: '7735757c-863e-4e07-9b84-af186424ebaeE',
    otp: '123456'
  }
}

axios(config)
  .then((response) => {
    console.log(response.status);
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error.response.status);
    console.error(error.response.data);
  });

Python

import requests
import os

data = requests.post(
  "https://api.sfox.com/v1/enterprise/transfer/confirm",
  headers={
    "Authorization": f"Bearer {os.environ['ENTERPRISE_API_KEY']}"
  },
  json={
    "transfer_id": "7735757c-863e-4e07-9b84-af186424ebae",
    "otp": "123456"
  }
)
print(data.status_code)
print(data.json())