v1

latestOpenAPI 3.1.02026-07-132363652.9 MB

CrossBorder

Enable cross-border payments for a merchant with a specific provider

post/api/v1/merchants/{merchantId}/cross-border-enrollments

Path parameters

merchantIdstring uuid required

The unique identifier of the merchant

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the merchant

Request body

providerstring required

The cross-border provider to enroll with.

Example request

{
  "provider": "transfermate"
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
    "provider": "transfermate",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "supported_currencies": [
      {
        "currency": "USD",
        "status": "active"
      },
      {
        "currency": "EUR",
        "status": "active"
      },
      {
        "currency": "GBP",
        "status": "inactive"
      }
    ]
  }
}