GET /customers/:id/payout-approvals

List the currency + rail + country combinations this customer may be paid out to. Its mirror, GET /customers/:id/pay-in-approvals, lists what they may be funded with.

Only rows with status of approved can carry a payment; quoting an unapproved one fails.

The list is narrowed to the currencies and rails your organization is approved for.

Answers are cached for up to an hour.

Response 200

{
  "payout": [
    {
      "currency": "MXN",
      "rail": "spei",
      "country": "MX",
      "status": "approved"
    },
    {
      "currency": "PHP",
      "rail": "instapay",
      "country": "PH",
      "status": "not_started"
    }
  ]
}

country is present when the approval is specific to one destination country, and absent when it applies anywhere the currency settles. rail uses the same rail names as GET /rails.

status and status_detail carry the same meanings as on pay-in approvals.

Errors

401 (missing or invalid API key), 404 (unknown customer, or a customer belonging to a different org), 503 (approvals are unavailable on this environment).

Example

curl "$SEISMIC_ORCHESTRATION_URL/v0/customers/2f10…/payout-approvals" \
  -H "Api-Key: $SEISMIC_ORCHESTRATION_API_KEY"