Skip to main content
POST
/
api
/
partner
/
v2
/
cross-ramp
cURL
curl --request POST \
  --url https://staging-api.capa.fi/api/partner/v2/cross-ramp \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <partner-api-key>' \
  --data '{
  "targetBankAccount": {
    "accountIdentifier": "<string>",
    "routingNumber": "<string>",
    "bic": "<string>",
    "country": "MX",
    "accountType": "SAVINGS",
    "bankName": "<string>",
    "documentIdentifier": "<string>",
    "documentType": "PASSPORT",
    "accountHolder": {
      "type": "INDIVIDUAL",
      "businessName": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "address": {
      "streetLine1": "<string>",
      "streetLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "US"
    }
  },
  "userId": "12a121ad-cbea-4ec4-9e0a-5c861e528bba",
  "sourceAmount": 1000,
  "targetAmount": 50.5,
  "sourceCurrency": "MXN",
  "targetCurrency": "USD",
  "quoteId": "<string>",
  "premiumSpread": 0.01
}'
{
  "success": true,
  "data": {
    "id": "12a121ad-cbea-4ec4-9e0a-5c861e528bba",
    "userId": "12a121ad-cbea-4ec4-9e0a-5c861e528bba",
    "status": "PENDING",
    "sourceCurrency": "MXN",
    "targetCurrency": "DOP",
    "sourceAmount": 1000,
    "targetAmount": 950,
    "exchangeRate": 0.95,
    "sourceBankAccount": {
      "accountHolder": {
        "type": "BUSINESS",
        "name": "Capa.fi"
      },
      "bic": "DEUTDEFF",
      "routingNumber": "021000021",
      "address": {
        "streetLine1": "123 Main St",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "country": "US"
      },
      "message": "RANDOM_MESSAGE",
      "country": "MX",
      "accountIdentifier": "014680260346007120",
      "bankName": "Santander",
      "accountType": "SAVINGS",
      "isVerified": true,
      "documentIdentifier": "123abc",
      "documentType": "RNC",
      "iban": "DE89370400440532013000"
    },
    "targetBankAccount": {
      "accountHolder": {
        "type": "BUSINESS",
        "name": "Capa.fi"
      },
      "bic": "DEUTDEFF",
      "routingNumber": "021000021",
      "address": {
        "streetLine1": "123 Main St",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "country": "US"
      },
      "message": "RANDOM_MESSAGE",
      "country": "MX",
      "accountIdentifier": "014680260346007120",
      "bankName": "Santander",
      "accountType": "SAVINGS",
      "isVerified": true,
      "documentIdentifier": "123abc",
      "documentType": "RNC",
      "iban": "DE89370400440532013000"
    },
    "createdAt": "null",
    "premiumSpread": 0.01,
    "completedAt": "<string>"
  }
}

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Body

application/json
​
userId
string
required

User's identifier

Example:

"12a121ad-cbea-4ec4-9e0a-5c861e528bba"

​
sourceCurrency
enum<string>
required

Source currency symbol

Available options:
MXN,
DOP,
USD,
EUR
Example:

"MXN"

​
targetCurrency
enum<string>
required

Target currency symbol

Available options:
MXN,
DOP,
USD,
EUR
Example:

"USD"

​
targetBankAccount
object

User bank info to be saved

​
sourceAmount
number

Amount of currency from source

Example:

1000

​
targetAmount
number

Amount of currency that will be delivered

Example:

50.5

​
quoteId
string

Identifier for the quote to be used for the transaction.

​
premiumSpread
number

Premium spread percentage

Example:

0.01

Response

201 - application/json
​
success
boolean
Example:

true

​
data
object