International

International on-ramp and off-ramp operations.

Create BOB Fiat Account

Create a BOB fiat account

post

Authorizations

ApiKeyAuth & BearerAuth

x-api-keystringRequired

Project API key (or CopterPay API key for webhooks).

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

userIdstring · uuidRequiredExample: 550e8400-e29b-41d4-a716-446655440000

isExternalbooleanRequiredExample: true

Responses

200

Fiat account created

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

post

/mint/v1/international/accounts/fiat/bob

HTTPcURLJavaScriptPython

POST /mint/v1/international/accounts/fiat/bob HTTP/1.1
Host: arsx.io
x-api-key: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "isExternal": true,
  "fiatAccountFields": {
    "accountNumber": "1234567890",
    "accountBankCode": "BNB",
    "metadata": {
      "ownerName": "Carlos Mamani",
      "documentNumber": "12345678"
    }
  }
}

{
  "status": 200,
  "message": "Ok",
  "data": {}
}

List International Fiat Accounts

List Alfred fiat accounts

get

Authorizations

ApiKeyAuth & BearerAuth

x-api-keystringRequired

Project API key (or CopterPay API key for webhooks).

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userIdstringOptional

If provided, pagination is not applied.

limitinteger · min: 1 · max: 50Optional

Number of items per page (capped at 50).

Default: 10

pageintegerOptional

Page index starting at 0.

Default: 0

Responses

200

Alfred fiat account list

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

/mint/v1/international/accounts/fiat

HTTPcURLJavaScriptPython

GET /mint/v1/international/accounts/fiat HTTP/1.1
Host: arsx.io
x-api-key: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "message": "Ok",
  "data": [
    {
      "alfred_fiat_account_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "created_at": "2025-01-15T10:00:00Z",
      "account_number": "1234567890",
      "account_type": "BANK",
      "account_name": "Carlos Mamani",
      "user_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

Get ARS to BOB Quote

Get ARS to BOB offramp quotes

post

Authorizations

ApiKeyAuth & BearerAuth

x-api-keystringRequired

Project API key (or CopterPay API key for webhooks).

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

fromAmountstringRequiredExample: 100000.00

paymentMethodTypestring · enumRequiredPossible values:

Responses

200

Quote pair

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/mint/v1/international/offramp/quotes/ars-bob

HTTPcURLJavaScriptPython

POST /mint/v1/international/offramp/quotes/ars-bob HTTP/1.1
Host: arsx.io
x-api-key: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "fromAmount": "100000.00",
  "paymentMethodType": "BANK"
}

{
  "status": 200,
  "message": "Ok",
  "data": {
    "quotes": {
      "arsUsdt": {
        "quoteId": "quote_abc123def456",
        "fromCurrency": "ARS",
        "toCurrency": "USDT",
        "fromAmount": "100000.00",
        "toAmount": "95.50",
        "chain": "BASE",
        "expiration": "2025-01-15T14:35:00Z",
        "fees": [
          {
            "type": "network",
            "amount": "0.50",
            "currency": "USDT"
          }
        ],
        "rate": "1047.12"
      },
      "usdtBob": {
        "quoteId": "quote_abc123def456",
        "fromCurrency": "ARS",
        "toCurrency": "USDT",
        "fromAmount": "100000.00",
        "toAmount": "95.50",
        "chain": "BASE",
        "expiration": "2025-01-15T14:35:00Z",
        "fees": [
          {
            "type": "network",
            "amount": "0.50",
            "currency": "USDT"
          }
        ],
        "rate": "1047.12"
      }
    }
  }
}

Create ARS to BOB Off-ramp

Create ARS to BOB off-ramp

post

Authorizations

ApiKeyAuth & BearerAuth

x-api-keystringRequired

Project API key (or CopterPay API key for webhooks).

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

arsUsdtQuoteIdstringRequiredExample: quote_ars_usdt_123

usdtBobQuoteIdstringRequiredExample: quote_usdt_bob_456

fiatAccountIdstring · uuidRequiredExample: d290f1ee-6c54-4b01-90e6-d701748f0851

userIdstring · uuidRequiredExample: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Off-ramp initiated

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

501

Not implemented

application/json

503

Service unavailable

application/json

post

/mint/v1/international/offramp/ars-bob

HTTPcURLJavaScriptPython

POST /mint/v1/international/offramp/ars-bob HTTP/1.1
Host: arsx.io
x-api-key: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "arsUsdtQuoteId": "quote_ars_usdt_123",
  "usdtBobQuoteId": "quote_usdt_bob_456",
  "fiatAccountId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "userId": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "status": 200,
  "message": "Ok",
  "data": {}
}

List Off-ramps

List Alfred off-ramps

get

Authorizations

ApiKeyAuth & BearerAuth

x-api-keystringRequired

Project API key (or CopterPay API key for webhooks).

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userIdstringOptional

fiatAccountIdstringOptional

limitinteger · min: 1 · max: 50Optional

Number of items per page (capped at 50).

Default: 10

pageintegerOptional

Page index starting at 0.

Default: 0

Responses

200

Alfred off-ramp list

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

/mint/v1/international/offramp

HTTPcURLJavaScriptPython

GET /mint/v1/international/offramp HTTP/1.1
Host: arsx.io
x-api-key: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "message": "Ok",
  "data": [
    {
      "alfred_off_ramp_id": "e4d909c2-9ff4-4b89-a2c3-5ed8f7d2a9b1",
      "started_at": "2025-01-15T14:30:00Z",
      "from_currency": "ARS",
      "to_currency": "BOB",
      "from_amount": "100000.00",
      "to_amount": "680.00",
      "status": "Pending",
      "alfred_fiat_account_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "user_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

List On-ramps

List Alfred on-ramps

get

Authorizations

ApiKeyAuth & BearerAuth

x-api-keystringRequired

Project API key (or CopterPay API key for webhooks).

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userIdstringOptional

limitinteger · min: 1 · max: 50Optional

Number of items per page (capped at 50).

Default: 10

pageintegerOptional

Page index starting at 0.

Default: 0

Responses

200

Alfred on-ramp list

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

/mint/v1/international/onramp

HTTPcURLJavaScriptPython

GET /mint/v1/international/onramp HTTP/1.1
Host: arsx.io
x-api-key: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "message": "Ok",
  "data": [
    {
      "alfred_on_ramp_id": "b5c2d8a1-4e7f-4a9b-8c3d-6e5f4a3b2c1d",
      "started_at": "2025-01-15T10:00:00Z",
      "from_currency": "BOB",
      "to_currency": "ARS",
      "from_amount": "680.00",
      "to_amount": "100000.00",
      "chain": "base",
      "status": "Pending",
      "alfred_transaction_id": "txn_alfred_789xyz",
      "alfred_quote_id": "quote_bob_ars_456",
      "wallet_transaction_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "user_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}