API reference · Getting paid

Collection rails

GET/collection/railsList the collection rails available on this platform

GET List the collection rails available on this platform

GET /collection/rails

Reference data. Filter by currency and country to see only what a collector could actually enable there. Each entry carries the rail's default settlement delay and reserve, which derive from how long the payer can take the money back rather than from a preference.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Query parameters

Name	Default
`currencyCode`	Optional
`countryCode`	Optional

Example

Response: GenericResponseRailCatalogueResponse

curl -X GET "https://api.bridgemoni.com/collection/rails" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "rails": [
      {
        "railCode": "string",
        "displayName": "string",
        "railFamily": "string",
        "pushRail": true,
        "defaultSettlementDelayHours": 0,
        "defaultReservePercentage": "string",
        "escrowReserveDifferential": "string",
        "refundableToOrigin": true,
        "escrowFundingPermitted": true,
        "merchantFeeRegulatedToZero": true,
        "currencyCodes": [
          "string"
        ],
        "countryCodes": [
          "string"
        ]
      }
    ]
  },
  "description": "Collection rails retrieved successfully"
}

Responses

Status	When
`200`	Collection rails retrieved successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors